%iKnow.Semantics.ProximityWSAPI

class %iKnow.Semantics.ProximityWSAPI extends %iKnow.Queries.AbstractWSAPI

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

See the classdocs for %iKnow.Semantics.ProximityAPI for more information.

This class was generated by %iKnow.Semantics.ProximityAPI.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 4

Summary

Properties
AddressingIn AddressingOut Attachments Base64LineBreaks
BodyId BodyXmlId ContentId ContentLocation
FaultAddressing FaultHeaders HeadersIn HeadersOut
ImportHandler IsMTOM Location MTOMRequired
MsgClass OutputTypeAttribute Password RMSession
ReferencesInline RequestMessageStart ResponseAttachments ResponseContentId
ResponseContentLocation SAXFlags SecurityContextToken SecurityIn
SecurityNamespace SecurityOut SessionCookie SoapFault
SoapVersion Timeout Transport Username
WriteSOAPBodyMethod
Methods
%AddEnvelopeNamespace %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OnCreateRMSession
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject ConvertParameter Decrypt
Encrypt EscapeHTML EscapeURL FileWSDL
GetBodyId GetProfile GetProfileById GetProfileBySource
GetProfileBySourceId HyperEventCall 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 ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
WSAddSignatureConfirmation

Parameters

parameter NAMESPACE = "http://www.intersystems.com/iKnow/Semantics/ProximityWSAPI";
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.Semantics.ProximityWSAPI";
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 GetProfile(pDomainId As %Integer, pEntity As %String, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pBlacklistIDs As %ListOfDataTypes = "", pUseStems As %Boolean = 0) as %XML.DataSet [ WebMethod ]

Returns the proximity profile for the entity or list of entities supplied through pEntity. This profile is calculated based on the aggregated distance to pEntity entries in all paths in the domain (when pFilter=""), optionally constrained to all paths in a specific set of sources (when pFilter!="").

When setting pUseStems to 1, for a domain that has stemming enabled, the scope of the profile will be expanded to include all actual forms of the supplied pEntity (which has to be provided as a base form (stem)!), and their combined proximity profiles will be grouped to the stem level again.

classmethod GetProfileById(pDomainId As %Integer, pEntUniId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pBlacklistIDs As %ListOfDataTypes = "", pUseStems As %Boolean = 0) as %XML.DataSet [ WebMethod ]
Returns the proximity profile for the entity represented by pEntUniId. See also GetProfile When setting pUseStems to 1, the value of pEntUniId will be interpreted as a stem ID.
classmethod GetProfileBySource(pDomainId As %Integer, pEntity As %String, pExternalId As %String, pPage As %Integer = 1, pPageSize As %Integer = 10) as %XML.DataSet [ WebMethod ]
Returns the proximity profile for a given entity pEntity in source pExtId. See also GetProfile for a broader set of options.
classmethod GetProfileBySourceId(pDomainId As %Integer, pEntUniId As %Integer, pSrcId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10) as %XML.DataSet [ WebMethod ]
Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId. See also GetProfile for a broader set of options.
Copyright © 1997-2020 InterSystems Corporation, Cambridge, MA