%XML.Adaptor
abstract class %XML.Adaptor
For details on using this class, see Projecting Objects to XML.
Subclasses of %XML.Adaptor are said to be "XML enabled" and may be projected as either pure XML or as the return value or arguments of a SOAP method.
The methods that are generated for XML enabled classes are specified here. The class parameters that control the generation of these methods are defined here.
The property parameters that control the generation of code for each property of an XML enabled class are defined in %XML.PropertyParameters.
Method Inventory
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Parameters
NOTE: Direct use of XMLExport method does not support the ATTRIBUTEQUALIFIED The export must be done using %XML.Writer or SOAP support.
NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
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.
If XMLFORMAT="Literal", then only support for literal format import and export is generated.
If XMLFORMAT="Encoded", then only support for SOAP encoded format import and export is generated.
The default is to generate support for both literal and encoded format.
If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).
If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.
If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
The default of XMLNILNOOBJECT = 0 will always create an object for an element with xsi:nil="true".
If XMLNILNOOBJECT = 1, then elements with xsi:nil="true" and no attributes specified will be skipped, i.e. the value of the property will remain "".
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Methods
top is the optional tag to be used for the top-level tag.
format is the parameter formatting type. DTDs may only be generated for the default "literal" format.
input=true means that the DTD for the input XML will be generated, otherwise the DTD for the output XML will be generated. The default is input=false. Normally, this argument is not relevant since the all properties of a class participate in input and output.
The dtdlist argument is used internally to track DTD generation for referenced objects.
IMPORTANT: The XMLExport method does not directly support many of the XML parameters. If you want control of the format of the export, do not use this method. Instead create an instance of %XML.Writer and use its OutputToDevice() method.
The supported arguments for XMLExport are:
top is the optional tag to be used for the top-level tag.
format is the parameter formatting type ("literal", "encoded" or "encoded12") to be used for this object. The default value for format is "" which currently is the same as the "literal" formatting, but may be a unique encoding in the future.
**********
**********
All the following arguments are for internal use only and may change
**********
**********
namespaces is the %XML.Namespaces class instance for this XML document.
Instead of namespaces typesPrefix is still supported for compatability and
is the optional namespace prefix to be used for all element tags and ObjectScript types.
attrs is a multidimensional array of extra attributes for the top node:
attrs is number of attributes
attrs(i) is name of ith attribute
attrs(i,0) is value of the ith attribute
If the createId is not "", then an id field with this id value is created.
If the typeAttr is not "", then add a type attribute to the top element if the this class's name is not typeAttr.
The idlist and oreflist arguments are used internally to track deferred object export and should normally not be specified.
initialIndent is the initial indentation for use when the format is indent.
local specifies if the element is treated as a local element. A global element is specified by a false value of local which can be either 0 to represent a global element in the namespace specified by the namespace argument or a string which is the namespace to which the global element belongs. The default for local is 0.
If the class is to be exported as an XOP package for use by SOAP MTOM, mimeAttachments is the MIME part which contains the list of MIME parts for all the attachments in the XOP package.
IMPORTANT: The XMLExportToStream method does not directly support many of the XML parameters. If you want control of the format of the export, do not use this method. Instead create an instance of %XML.Writer and use its OutputToStream() method.
The supported arguments for XMLExportToStream are:
export is the exported stream. If export is the oref of a stream, the XML document will be written to this existing stream at the current position. If export is "", then a new %FileCharacterStream will be created to contain the XML document and its oref returned. In this case, export must be passed by reference.
top is the optional tag to be used for the top-level tag.
format is the parameter formatting type ("literal", "encoded" or "encoded12") to be used for this object. The default value for format is "" which currently is the same as the "literal" formatting, but may be a unique encoding in the future.
**********
**********
All the following arguments are for internal use only and may change
**********
**********
namespaces is the %XML.Namespaces class instance for this XML document.
Instead of namespaces typesPrefix is still supported for compatability and
is the optional namespace prefix to be used for all element tags and ObjectScript types.
attrs is a multidimensional array of extra attributes for the top node:
attrs is number of attributes
attrs(i) is name of ith attribute
attrs(i,0) is value of the ith attribute
If the createId is not "", then an id field with this id value is created.
If the typeAttr is not "", then add a type attribute to the top element if the this class's name is not typeAttr.
The idlist and oreflist arguments are used internally to track deferred object export and should normally not be specified.
initialIndent is the initial indentation for use when the format is indent.
IMPORTANT: The XMLExportToString method does not directly support many of the XML parameters. If you want control of the format of the export, do not use this method. Instead create an instance of %XML.Writer and use its OutputToString() method.
The supported arguments for XMLExportToString are:
top is the optional tag to be used for the top-level tag.
format is the parameter formatting type ("literal", "encoded" or "encoded12") to be used for this object. The default value for format is "" which currently is the same as the "literal" formatting, but may be a unique encoding in the future.
**********
**********
All the following arguments are for internal use only and may change
**********
**********
namespaces is the %XML.Namespaces class instance for this XML document.
Instead of namespaces typesPrefix is still supported for compatability and
is the optional namespace prefix to be used for all element tags and ObjectScript types.
attrs is a multidimensional array of extra attributes for the top node:
attrs is number of attributes
attrs(i) is name of ith attribute
attrs(i,0) is value of the ith attribute
If the createId is not "", then an id field with this id value is created.
If the typeAttr is not "", then add a type attribute to the top element if the this class's name is not typeAttr.
The idlist and oreflist arguments are used internally to track deferred object export and should normally not be specified.
initialIndent is the initial indentation for use when the format is indent.
local specifies if the element is treated as a local element. Default is 0 (false).
You may override this method to do custom processing (such as initializing the object instance) before returning an instance of this class. However, this method should not be called directly from user code.
Arguments:
document is the document with %XML.Node or macros in %xmlDOM.inc.
nodeId is a node id of the node which defines this object. An %XML.Node object may be obtained for this node using document.GetNode(nodeId)containerOref is the containing object instance when called from XMLImport and is "" when called from %XML.Reader for Correlate'd objects.
top is the optional tag to be used for the top-level tag.
format is the parameter formatting type ("literal", "encoded" or "encoded12") to be used for this object. In addition, the value "element" is the same as "literal" formatting with an element at the top level. The default value for format is "" which currently is the same as the "literal" formatting, but may be a unique encoding in the future.
namespacePrefix is the optional namespace prefix to be used for the namespace in which this schema is generated.
input=true means that the schema for the input XML will be generated, otherwise the schema for the output XML will be generated. The default is input=false. Normally, this argument is not relevant since the all properties of a class participate in input and output.
refOnly=true means that only the portions of the schema for referenced types are generated. The schema for this class is not generated. Default is refOnly=false that generates the entire schema.
The schema argument is used internally to track schema generation for referenced objects.
schemaInstance is the %XML.Schema class instance that is used to build the schema.
node is the %XML.Node class instance for the schema that includes this class.
top is the optional override of the type name.
format is the parameter formatting type ("literal", "encoded" or "encoded12") to be used for this object. In addition, the value "element" is the same as "literal" formatting with an element at the top level. The default value for format is "" which currently is the same as the "literal" formatting, but may be a unique encoding in the future.
summary=true if summary type is to be created.
input=true means that the schema for the input XML will be generated, otherwise the schema for the output XML will be generated. The default is input=false. Normally, this argument is not relevant since the all properties of a class participate in input and output.
refOnly=true means that only the portions of the schema for referenced types are generated. The schema for this class is not generated. Default is refOnly=false that generates the entire schema.
Subclasses
- %CSP.Mgr.GatewayInformation
- %CSP.Mgr.GatewaySystemStatus
- %CSP.Mgr.Helper.AlternativeServer
- %CSP.Mgr.Helper.ApplicationPath
- %CSP.Mgr.Helper.CacheServer
- %CSP.Mgr.Helper.CachedForms
- %CSP.Mgr.Helper.Connection
- %CSP.Mgr.Helper.Form
- %CSP.Monitor.Matrix
- %CSP.Util.Action
- %CSP.Util.Condition
- %CSP.Util.FieldDefinition
- %CSP.Util.FormButton
- %CSP.Util.HTMLMeter
- %CSP.Util.Link
- %CSP.Util.Menu
- %CSP.Util.MenuItem
- %CSP.Util.PageInstance
- %CSP.Util.Pane
- %DeepSee.Connector.abstractNode
- %DeepSee.CubeManager.RegistryMap
- %DeepSee.CubeManager.RegistryMapCube
- %DeepSee.CubeManager.RegistryMapGroup
- %DeepSee.CubeManager.RegistryMapSubjectArea
- %DeepSee.Dashboard.CalculatedMember
- %DeepSee.Dashboard.ChartDataSeries
- %DeepSee.Dashboard.Control
- %DeepSee.Dashboard.DataProperty
- %DeepSee.Dashboard.PivotCondition
- %DeepSee.Dashboard.PivotLevel
- %DeepSee.Dashboard.Widget
- %DeepSee.Diagnostic.MDXUtils
- %DeepSee.ListingGroupDefinition
- %DeepSee.Model.SubjectArea.abstractNode
- %DeepSee.Model.abstractNode
- %DeepSee.PMML.Definition.abstractNode
- %DeepSee.QualityMeasure.QualityMeasure
- %DeepSee.Query.node
- %DeepSee.SubjectArea
- %DeepSee.TestSpec
- %DeepSee.UserLibrary.Folder
- %DeepSee.UserLibrary.FolderItem
- %DeepSee.UserLibrary.UserData
- %DeepSee.UserLibrary.WorksheetAxis
- %DeepSee.UserLibrary.WorksheetCell
- %DeepSee.UserPortal.Data.Alert
- %DeepSee.UserPortal.Data.User
- %DeepSee.XMLA.DataSourcesRestrictions
- %DeepSee.XMLA.EnumerationsRestrictions
- %DeepSee.XMLA.ExecuteCommand
- %DeepSee.XMLA.KeywordsRestrictions
- %DeepSee.XMLA.KeywordsRowset
- %DeepSee.XMLA.LiteralsRestrictions
- %DeepSee.XMLA.Properties
- %DeepSee.XMLA.PropertiesRestrictions
- %DeepSee.XMLA.PropertiesRowset
- %DeepSee.XMLA.PropertyList
- %DeepSee.XMLA.SchemasRestrictions
- %DeepSee.XMLA.SchemasRowset
- %DeepSee.extensions.modelling.conf.Attributes
- %DeepSee.extensions.modelling.conf.Model
- %DeepSee.extensions.modelling.conf.Operation
- %DeepSee.extensions.modelling.conf.Operator
- %DeepSee.extensions.modelling.conf.Sort
- %Installer.Component
- %JSON.Mapping
- %JSON.MappingProperty
- %Library.SQLConnection
- %MFT.FolderContents
- %MFT.ItemInfo
- %MFT.UserInfo
- %MFT.UserList
- %Monitor.Manager
- %Net.MIMESerialPart
- %Net.OpenAM.tns.AccessDenied
- %Net.OpenAM.tns.DuplicateObject
- %Net.OpenAM.tns.GeneralFailure
- %Net.OpenAM.tns.InvalidCredentials
- %Net.OpenAM.tns.InvalidPassword
- %Net.OpenAM.tns.InvalidToken
- %Net.OpenAM.tns.NeedMoreCredentials
- %Net.OpenAM.tns.ObjectNotFound
- %Net.OpenAM.tns.TokenExpired
- %Net.OpenAM.tns.UserNotFound
- %Net.OpenAM.tns.attribute
- %Net.OpenAM.tns.identityDetails
- %Net.OpenAM.tns.token
- %Net.OpenAM.tns.userDetails
- %SAML.Action
- %SAML.AssertionReference
- %SAML.Attribute
- %SAML.AttributeValue
- %SAML.AttributeValueAbstract
- %SAML.AttributeValueElement
- %SAML.AuthnContext
- %SAML.AuthnContextDecl
- %SAML.AuthnContextDeclRef
- %SAML.BaseID
- %SAML.Condition
- %SAML.Conditions
- %SAML.EncryptedElement
- %SAML.Evidence
- %SAML.Statement
- %SAML.Subject
- %SAML.SubjectConfirmation
- %SAML.SubjectConfirmationData
- %SAML.SubjectLocality
- %SOAP.Descriptor
- %SOAP.Fault
- %SOAP.Fault12
- %SOAP.Fault12.Code
- %SOAP.Fault12.Text
- %SOAP.Header
- %SOAP.PolicyReference
- %SOAP.RM.Accept
- %SOAP.RM.AcknowledgementRange
- %SOAP.RM.CloseSequenceResponse
- %SOAP.RM.CreateSequenceResponse
- %SOAP.RM.Offer
- %SOAP.RM.TerminateSequenceResponse
- %SOAP.RequestMessage
- %SOAP.Security.Created
- %SOAP.Security.Element
- %SOAP.Security.IssuerSerial
- %SOAP.Security.KeyIdentifier
- %SOAP.Security.Password
- %SOAP.Security.Reference
- %SOAP.Security.TransformationParameters
- %SOAP.WSSC.Properties
- %SOAP.WST.AbstractToken
- %SOAP.WST.Claims
- %SOAP.WST.Entropy
- %SOAP.WST.Lifetime
- %SOAP.WST.Participants
- %SOAP.WST.Renewing
- %SOAP.WST.RequestSecurityTokenResponse
- %SOAP.WST.RequestSecurityTokenResponseCollection
- %SOAP.WST.RequestedProofToken
- %SOAP.WST.RequestedSecurityToken
- %SOAP.WST.Status
- %SOAP.WST.Target
- %SQL.Manager.QButtons.Base
- %SQL.Util.TuneTableStats
- %SQL.Util.TuneTableStatsFields
- %SQL.Util.TuneTableStatsMaps
- %SYS.Audit
- %SYS.OpenAM.IdentityServices
- %SYS.PhoneProviders
- %SYS.Portal.Resources
- %SYS.Portal.Users
- %SYS.Task.DiagnosticReport
- %SYS.X509Credentials
- %Studio.BreakPoint
- %Studio.Extension.Menu
- %Studio.Extension.MenuBase
- %Studio.Extension.MenuItem
- %Studio.Project
- %Studio.ProjectItem
- %Studio.SourceControl.ItemSet
- %Studio.Template.HTMLAttribute
- %Studio.Template.HTMLElement
- %Studio.WatchPoint
- %Studio.WatchVariable
- %UnitTest.Result.TestAssert
- %UnitTest.Result.TestCase
- %UnitTest.Result.TestInstance
- %UnitTest.Result.TestMethod
- %UnitTest.Result.TestSuite
- %WebStress.Calls
- %WebStress.Control
- %WebStress.Control.AppServers
- %WebStress.Control.GeneratorStatus
- %WebStress.Control.Processes
- %WebStress.Control.Progress
- %WebStress.Control.ValidData.Request
- %WebStress.Control.ValidData.Request.Parameters
- %WebStress.Control.ValidData.Response
- %WebStress.Control.ValidData.Response.Generators
- %WebStress.Control.ValidData.Response.Generators.Data
- %WebStress.Errors
- %WebStress.Iterations
- %WebStress.Machines.ApplicationServers
- %WebStress.Machines.Generators
- %WebStress.Machines.WebServers
- %WebStress.Playback
- %WebStress.Playback.Session
- %WebStress.Playback.Status
- %WebStress.Results.AppServerStats
- %WebStress.Results.Calls
- %WebStress.Results.General
- %WebStress.Results.Iterations
- %WebStress.Results.PageSummary
- %WebStress.Results.Summary
- %WebStress.Run
- %WebStress.Scripts
- %WebStress.Scripts.URLS
- %WebStress.Scripts.URLS.Parameters
- %WebStress.Tables.NoDelay
- %WebStress.Tables.NoResults
- %WebStress.Tests
- %WebStress.Tests.Parameters
- %XML.Catalog
- %XML.DataSet
- %XML.ElementExtension
- %XML.Exchange.Adaptor
- %XML.Exchange.Metadata
- %XML.Security.Algorithm
- %XML.Security.CipherData
- %XML.Security.CipherDataStream
- %XML.Security.CipherReference
- %XML.Security.DSAKeyValue
- %XML.Security.DataReference
- %XML.Security.EncryptionMethod
- %XML.Security.EncryptionProperties
- %XML.Security.EncryptionProperty
- %XML.Security.InclusiveNamespaces
- %XML.Security.KeyInfo
- %XML.Security.KeyInfoClause
- %XML.Security.KeyReference
- %XML.Security.Object
- %XML.Security.RSAKeyValue
- %XML.Security.Reference
- %XML.Security.RetrievalMethod
- %XML.Security.SignedInfo
- %XML.Security.Transform
- %XML.Security.X509DataElement
- %ZEN.Component.object
- %ZEN.Report.Display.common
- %ZEN.Report.Display.node
- %ZEN.Report.Models.Group.Document
- %ZEN.Report.Models.Group.Group
- %ZEN.Report.Models.Group.Report
- %ZEN.Report.parameter
- %ZEN.Report.reportNode
- %ZEN.SVGComponent.abstractSVGGroup
- %ZHSLIB.Audit.Log
- %ZHSLIB.Audit.LogParticipant
- %ZHSLIB.Component
- %ZHSLIB.Services.NVPair
- %iKnow.Classification.Definition.node
- Config.CommonMethods
- Config.NLS.Locales
- Config.NLS.SubTables
- Config.NLS.Tables
- INFORMATION.SCHEMA.CURRENTSTATEMENTS
- INFORMATION.SCHEMA.STATEMENTCHILDREN
- INFORMATION.SCHEMA.STATEMENTDAILYSTATS
- INFORMATION.SCHEMA.STATEMENTHOURLYSTATS
- INFORMATION.SCHEMA.STATEMENTLOCATIONS
- INFORMATION.SCHEMA.STATEMENTPARAMETERSTATS
- INFORMATION.SCHEMA.STATEMENTPRIVACTIONS
- INFORMATION.SCHEMA.STATEMENTPRIVOBJECTS
- INFORMATION.SCHEMA.STATEMENTRELATIONS
- INFORMATION.SCHEMA.STATEMENTS
- PKI.CSR
- PKI.Certificate
- SYS.History.Daily
- SYS.History.Hourly
- SYS.History.PerfData
- SYS.History.SharedMemoryData
- SYS.History.SysData
- SYS.Monitor.Health.Chart
- SYS.Monitor.Health.Period
- SYS.Monitor.Health.SensorObject
- SYS.Stats.Manager
- SYS.WSMon.wsEvent
- SYS.WSMon.wsResource
- Security.Applications
- Security.DocDBs
- Security.Domains
- Security.Events
- Security.KMIPServer
- Security.LDAPConfigs
- Security.Resource
- Security.Resources
- Security.Roles
- Security.SQL
- Security.SQLAdminPrivilegeSet
- Security.SQLPrivileges
- Security.SQLRoleGrantOption
- Security.SSLConfigs
- Security.Servers
- Security.Services
- Security.System
- Security.Users
- Security.X509Users