Class %iKnow.Queries.PathWSAPI

class %iKnow.Queries.PathWSAPI extends %SOAP.WebService, %iKnow.Queries.AbstractWSAPI

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

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

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

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3		13

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	GetBySource	GetCountByDomain
GetCountByEntities	GetCountByEntityIds	GetCountBySource	GetEntities
GetId	GetSentenceId	GetSourceId	GetValue
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/PathWSAPI";

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.PathWSAPI";

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 = "", setop As %Integer = $$$UNION) as %XML.DataSet [ WebMethod ]

This method will return a list of all Paths containing any (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the entities in the supplied entitylist.

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 Paths occurring in any source satisfying the filter criteria.

Results are sorted by decreasing path ID.

• classmethod GetByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String = "", setop As %Integer = $$$UNION) as %XML.DataSet [ WebMethod ]

Retrieves paths based on entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetBySource(domainid As %Integer, sourceidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10) as %XML.DataSet [ WebMethod ]

Retrieves the paths appearing in any of the sources supplied through sourceidlist.

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

• classmethod GetCountByDomain(domainid As %Integer, filter As %String = "") as %Library.Integer [ WebMethod ]

Returns the number of paths in a domain, optionally restricted to those appearing in a source satisfying the %iKnow.Filters.Filter object supplied through filter.

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, filter As %String = "", setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the number of paths containing the specified entities.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, filter As %String = "", setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the number of paths containing the specified entity IDs.

See also GetByEntities for a description of the parameters.

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

Returns the total number of paths in the sources specified through sourceidlist. Use negative source IDs to refer to virtual sources.

• classmethod GetEntities(domainId As %Integer, pathId As %Integer, vSrcId As %Integer = 0) as %XML.DataSet [ WebMethod ]

• classmethod GetId(domainid As %Integer, entityList As %ListOfDataTypes, vSrcId As %Integer = 0) as %Library.Integer [ WebMethod ]

This method will try to find a path corresponding to the supplied list of entities in the specified order. If no path is found, "" is returned.

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

• classmethod GetSentenceId(domainId As %Integer, pathId As %Integer) as %Library.Integer [ WebMethod ]

Returns the sentence ID in which the supplied path ID occurs

• classmethod GetSourceId(domainId As %Integer, pathId As %Integer) as %Library.Integer [ WebMethod ]

Returns the source ID in which the supplied path ID occurs

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

Returns the sequence of entity values corresponding to the specified path as a %List.

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


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