Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [Queries] >  [CcWSAPI]
Private  Storage   

class %iKnow.Queries.CcWSAPI extends %iKnow.Queries.AbstractWSAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Queries.CcAPI, exposed as WebMethod methods.

See the classdocs for %iKnow.Queries.CcAPI for more information.

This class was generated by %iKnow.Queries.CcAPI.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 10


Summary

Properties
Action AddressingIn AddressingOut Attachments
Base64LineBreaks BodyId BodyXmlId ContentId
ContentLocation FaultAddressing FaultHeaders HeadersIn
HeadersOut ImportHandler IsMTOM Location
MTOMRequired MethodName MsgClass NamespacesOut
OneWay OutputTypeAttribute Password RMSession
ReferencesInline RequestMessageStart ResponseAttachments ResponseContentId
ResponseContentLocation SAXFlags SecurityContextToken SecurityIn
SecurityNamespace SecurityOut SessionCookie SoapFault
SoapVersion Timeout Transport Username
WriteSOAPBodyMethod policyAlternative

Methods
%%OIDGet %AddEnvelopeNamespace %AddToSaveSet %BindExport
%BuildObjectGraph %ClassIsLatestVersion %ClassName %Close
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetElementFromBody %GetParameter %IncrementCount
%IsA %IsModified %New %NormalizeObject
%ObjectModified %OnCreateRMSession %OriginalNamespace %PackageName
%RemoveFromSaveSet %RestoreTCPDevice %SaveTCPDevice %SerializeObject
%SetModified %ValidateObject BeginSOAPEnvelope CheckSOAPEnvelope
ConvertParameter Decrypt Encrypt EncryptBroker
EndSOAPEnvelope EscapeHTML EscapeURL Fault
FileWSDL GetBinaryWriter GetBodyId GetByEntities
GetByEntityIds GetCountByEntities GetCountByEntityIds GetCountBySource
GetFrequency GetId GetInverse GetMsgClass
GetSecurityOut GetSpread GetValue HandleException
HyperEventBody HyperEventCall HyperEventFrame HyperEventHead
Include Initialize InitializeSecurity InsertHiddenField
InsertHiddenFields InvokeMsgClass IsPrivate Link
LogGlobal LogInput LogInputHTTPHeaders LogOutput
LogOutputHTTPHeaders LogText MakeFault MakeFault12
MakeFault12Code MakeFault12Text MakeSecurityFault MakeStatusFault
Namespace NormalizeName OnCancelSecureConversation OnCompile
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPostSOAP OnPostWebMethod OnPreHTTP
OnPreHyperEvent OnPreSOAP OnPreWebMethod OnRequestMessage
OnSOAPRequest OnStartSecureConversation Page Process
ProcessBinary ProcessBody ProcessBodyNode ProcessHTTP
ProcessSOAPEnvelope QuoteJS ReadBinaryMessage Reset
ResetSecurity ReturnFault ReturnInternalStatusFault ReturnOneWay
RewriteURL SecurityOutGet SecurityOutSet SessionCookieSet
SessionCookieSetInternal ShowError StartTimer StopTimer
ThrowError TimeoutSet UnescapeHTML UnescapeURL
WSAddSignatureConfirmation WebMethod WriteFaultHeaders WriteHTTPContent
WriteSOAPHeaders WriteSOAPMessage WriteStartAttachments


Parameters

• parameter NAMESPACE = "http://www.intersystems.com/iKnow/Queries/CcWSAPI";
NAMESPACE - Should be an unique URI Override this parameter in the subclass with the unique namespace URI of your organization. Override this parameter in the subclass.
• parameter SERVICENAME = "iKnow.Queries.CcWSAPI";
SERVICENAME - Should be the name of the service for which this is a proxy. Override this parameter in the subclass.
• parameter USECLASSNAMESPACES = 1;
When USECLASSNAMESPACES = 1, then the WSDL of the Web service reflects the namespaces defined for the referenced classes by the NAMESPACE parameters of those classes. The default, for compatibility with previous versions, is that the NAMESPACE parameters of the referenced classes are ignored when creating the WSDL. If USECLASSNAMESPACES has no value, then the default value from ^ISCSOAP("USECLASSNAMESPACES") is used.

Methods

• classmethod GetByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, pActualFormOnly As %Boolean = 0) as %XML.DataSet [ WebMethod ]

This method will return all CC pairs in which any (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the entities supplied in the entitylist participate, within the boundaries of the supplied domain.

The scope of this query can be limited through supplying a %iKnow.Filters.Filter object for the filter parameter to restrict the result to those CCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

Specifying a value for positionstomatch will limit the result to those CCs in which the supplied entities are on the Master (with positionstomatch = $$$USEPOSM) or Slave (with positionstomatch = $$$USEPOSS) side rather than either of the two (with positionstomatch = $$$USEPOSMS, default setting).

If stemming is enabled for this domain through $$$IKPSTEMMING, CCs containing any actual form of the entities in entityList will be returned. Use pActualFormOnly=1 to retrieve only those CCs containing the actual forms in entitylist. This argument is ignored if stemming is not enabled.

• classmethod GetByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, pActualFormOnly As %Boolean = 0) as %XML.DataSet [ WebMethod ]

This method looks up CCs based on a list of Entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, filter As %String(MAXLEN=32767)="", positionstomatch As %Integer = $$$USEPOSMS, pActualFormOnly As %Boolean = 0) as %Library.Integer [ WebMethod ]

This method returns the number of CC pairs based on a list of entities.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, filter As %String(MAXLEN=32767)="", positionstomatch As %Integer = $$$USEPOSMS, pActualFormOnly As %Boolean = 0) as %Library.Integer [ WebMethod ]

This method returns the number of CC pairs based on a list of entity ids.

See also GetByEntities for a description of the parameters.

• classmethod GetCountBySource(domainid As %Integer, sourceidlist As %ListOfDataTypes, setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Returns the total number of unique CCs appearing in either (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the sources specified by ID in sourceidlist.

To get the unique CCs of a virtual source, only a single virtual source can be supplied using its negative ID value (otherwise, -1 is returned).

• classmethod GetFrequency(domainId As %Integer, ccUniId As %Integer, vSrcId As %Integer = 0, filter As %String(MAXLEN=32767)="") as %Library.Integer [ WebMethod ]

Returns the frequency of the CC corresponding to the supplied crcUniId.

When specifying a Virtual Source ID, the frequency within the virtual source will be returned.

• classmethod GetId(pDomainId As %Integer, pMaster As %String, pSlave As %String, vSrcId As %Integer = 0) as %Library.Integer [ WebMethod ]

Returns, if any, the CC ID for the combination of master and slave specified.

When specifying a Virtual Source ID, it will treat the master and slaves as virtual entities, in the context of that vSrcId.

• classmethod GetInverse(domainId As %Integer, ccUniId As %Integer) as %Library.Integer [ WebMethod ]
Returns the "inverse" of a CC pair, which means the CC composed of the same master and slave entity, but at inverted positions.
• classmethod GetSpread(domainId As %Integer, ccUniId As %Integer, filter As %String(MAXLEN=32767)="") as %Library.Integer [ WebMethod ]

Returns the spread of the CC corresponding to the supplied ccUniId.

• classmethod GetValue(pDomainId As %Integer, pCcId As %Integer, vSrcId As %Integer = 0) as %Library.List [ WebMethod ]

Returns the entity values this CC is composed of.

When specifying a Virtual Source ID, it will treat the ccid as a virtual one, in the context of that vSrcId.



Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.