Class %iKnow.Queries.CcWSAPI

class %iKnow.Queries.CcWSAPI extends %SOAP.WebService, %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		6

Summary

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

Methods
%%OIDGet	%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	ConvertParameter	Decrypt	Encrypt
EscapeHTML	EscapeURL	FileWSDL	GetBodyId
GetByEntities	GetByEntityIds	GetCountByEntities	GetCountByEntityIds
GetCountBySource	GetInverse	HyperEventBody	HyperEventCall
HyperEventFrame	HyperEventHead	Include	Initialize
InsertHiddenField	InsertHiddenFields	IsPrivate	Link
MakeFault	MakeFault12	MakeSecurityFault	MakeStatusFault
NormalizeName	OnCancelSecureConversation	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPostWebMethod	OnPreHyperEvent	OnPreWebMethod
OnRequestMessage	OnSOAPRequest	OnStartSecureConversation	Page
Process	ProcessBinary	ProcessBody	ProcessBodyNode
QuoteJS	Reset	ReturnFault	ReturnOneWay
RewriteURL	SecurityOutGet	SecurityOutSet	ShowError
StartTimer	StopTimer	ThrowError	TimeoutSet
UnescapeHTML	UnescapeURL	WSAddSignatureConfirmation

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 = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT) 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).

• classmethod GetByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT) 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 = "", positionstomatch As %Integer = $$$USEPOSMS) 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 = "", positionstomatch As %Integer = $$$USEPOSMS) 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 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.


[BASEXML] > [%iKnow] > [Queries] > [CcWSAPI]		Private Storage