Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%iKnow.Queries.MetadataWSAPI.UpdateField

class %iKnow.Queries.MetadataWSAPI.UpdateField extends %SOAP.MsgDescriptor

This class is generated by the %iKnow.Queries.MetadataWSAPI Web Service class. This class should not be edited or modified in any way.

This class was generated by : %iKnow.Queries.MetadataWSAPI.cls

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter NAMESPACE = http://www.intersystems.com/iKnow/Queries/MetadataWSAPI;
Inherited description: NAMESPACE - specifies the XML namespace to be used for the XMLExport of the SOAP body's request and response messages. This parameter directly controls namespace usage by XMLExport.
parameter SOAPBINDINGSTYLE = document;
Inherited description: SOAPBINDINGSTYLE - specifies SoapBindingStyle keyword for this web method.
parameter SOAPBODYUSE = literal;
Inherited description: SOAPBODYUSE - specifies SoapBodyUse keyword for this web method.
parameter SUPPRESSDOCUMENTATION = 1;
parameter TYPENAMESPACE = http://www.intersystems.com/iKnow/Queries/MetadataWSAPI;
Inherited description: TYPENAMESPACE specifies the XML namespace for the types used for the method arguments and return types in this web client or web service when importing a SOAP message.
parameter XMLDEFAULTREFERENCE = complete;
Inherited description: XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter that specifies how to project references to XML. XMLREFERENCE may be specified for each property to override this default value. Possible values of XMLDEFAULTREFERENCE are SUMMARY, COMPLETE, ID, OID, GUID.
SUMMARY indicates that only the summary properties of the referenced class are used to represent the reference. SUMMARY is the default. Note that by default all properties of the referenced class are in the summary.
COMPLETE indicates that all properties of the referenced class are used to represent the reference.
ID indicates that the id of a persistent or serial class is used to represent the reference.
OID indicates that the oid of a persistent or serial class is used to represent the reference. The form of the oid will be classname,id.
GUID indicates the GUID of a persistent class is used to represent the reference.
parameter XMLIMPORTNAMESPACE = http://www.intersystems.com/iKnow/Queries/MetadataWSAPI;
Inherited description: XMLIMPORTNAMESPACE specifies the XML namespace for the method definition in the WSDL for the web service when importing a SOAP message.
parameter XMLRESULTNAME = %Result;
Inherited description: Name of result property

Properties

property %Result as %Library.Boolean (XMLIO = "OUT", XMLNAME = "UpdateFieldResult") [ Required ];
Property methods: %ResultDisplayToLogical(), %ResultGet(), %ResultIsValid(), %ResultLogicalToDisplay(), %ResultLogicalToXSD(), %ResultNormalize(), %ResultSet(), %ResultXSDToLogical()
property domainId as %Library.Integer (XMLIO = "IN");
Property methods: domainIdDisplayToLogical(), domainIdGet(), domainIdIsValid(), domainIdLogicalToDisplay(), domainIdNormalize(), domainIdSet(), domainIdXSDToLogical()
property fieldName as %Library.String);
Property methods: fieldNameDisplayToLogical(), fieldNameGet(), fieldNameIsValid(), fieldNameLogicalToDisplay(), fieldNameLogicalToOdbc(), fieldNameNormalize(), fieldNameSet()
property hidden as %Library.Integer (XMLIO = "IN");
Property methods: hiddenDisplayToLogical(), hiddenGet(), hiddenIsValid(), hiddenLogicalToDisplay(), hiddenNormalize(), hiddenSet(), hiddenXSDToLogical()
property lovId as %Library.Integer (XMLIO = "IN");
Property methods: lovIdDisplayToLogical(), lovIdGet(), lovIdIsValid(), lovIdLogicalToDisplay(), lovIdNormalize(), lovIdSet(), lovIdXSDToLogical()
property storage as %Library.Integer (XMLIO = "IN");
Property methods: storageDisplayToLogical(), storageGet(), storageIsValid(), storageLogicalToDisplay(), storageNormalize(), storageSet(), storageXSDToLogical()
property supportedOperators as %Library.ListOfDataTypes (XMLIO = "IN");
Property methods: supportedOperatorsGet(), supportedOperatorsGetObject(), supportedOperatorsGetObjectId(), supportedOperatorsGetSwizzled(), supportedOperatorsIsEmpty(), supportedOperatorsIsValid(), supportedOperatorsNewObject(), supportedOperatorsSet(), supportedOperatorsSetObject(), supportedOperatorsSetObjectId(), supportedOperatorsUnSwizzle()
property validateLov as %Library.Integer (XMLIO = "IN");
Property methods: validateLovDisplayToLogical(), validateLovGet(), validateLovIsValid(), validateLovLogicalToDisplay(), validateLovNormalize(), validateLovSet(), validateLovXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab