Class %iKnow.Utils.MaintenanceWSAPI

deprecatedclass %iKnow.Utils.MaintenanceWSAPI extends %iKnow.Queries.AbstractWSAPI

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

See the classdocs for %iKnow.Utils.MaintenanceAPI for more information.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3		20

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	AddEntityToSkipList	AddStringToSkipList
AddUserDictionaryEntry	ClearSkipList	ConvertParameter	CreateSkipList
CreateUserDictionary	Decrypt	DropSkipList	DropUserDictionary
Encrypt	EscapeHTML	EscapeURL	FileWSDL
GetBodyId	GetSkipListElements	GetSkipListId	GetSkipLists
GetUserDictionaries	GetUserDictionaryEntries	GetUserDictionaryId	HasSkipLists
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	RemoveEntityFromSkipList	RemoveStringFromSkipList	RemoveUserDictionaryEntry
Reset	ReturnFault	ReturnOneWay	RewriteURL
SOAPLogContains	ShowError	SkipListContainsElement	SkipListContainsString
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	WSAddSignatureConfirmation

Parameters

• parameter NAMESPACE = "http://www.intersystems.com/iKnow/Utils/MaintenanceWSAPI";

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.Utils.MaintenanceWSAPI";

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 AddEntityToSkipList(domainId As %Integer, skipListId As %Integer, entUniId As %Integer) as %Boolean [ WebMethod ]

Adds an existing entity (by ID) to a SkipList. For cross-domain SkipLists, use AddStringToSkipList

• classmethod AddStringToSkipList(domainId As %Integer, skipListId As %Integer, string As %String) as %Boolean [ WebMethod ]

Adds a string to a SkipList, adding it as an entity if it didn't exist in the domain before.

• classmethod AddUserDictionaryEntry(userDictId As %Integer, rewriteFrom As %String, rewriteTo As %String, position As %Integer = 0) as %Boolean [ WebMethod ]

Adds a single entry to a User Dictionary at position. If position <= 0 (default), it is added at the bottom of the list, otherwise at the requested position, shifting existing entries down if it was already taken.

Deprecated: please use AddEntry() in %iKnow.UserDictionary

• classmethod ClearSkipList(pDomainId As %Integer, pSkipListId As %Integer) as %Boolean [ WebMethod ]

Clears the contents of a single SkipList.

• classmethod CreateSkipList(domainId As %Integer, name As %String, description As %String = "") as %Library.Integer [ WebMethod ]

Create a new SkipList with the given name and description

• classmethod CreateUserDictionary(name As %String, description As %String = "") as %Library.Integer [ WebMethod ]

This method creates a User Dictionary with a given name and optional description and returns the created user dictionary ID afterwards. This method will return -1 if an error occurred, which is passed by reference as sc.

Deprecated: please use %New() in %iKnow.UserDictionary

• classmethod DropSkipList(domainId As %Integer, skipListId As %Integer) as %Boolean [ WebMethod ]

Drops a SkipList (entities part of the list will not be deleted from the domain)

• classmethod DropUserDictionary(userDictId As %Integer) as %Boolean [ WebMethod ]

This method drops the User Dictionary identified by the supplied userDictId, including all its entries.
Deprecated: please use %DeleteId() in %iKnow.UserDictionary

• classmethod GetSkipListElements(domainId As %Integer, skipListId As %Integer) as %XML.DataSet [ WebMethod ]

Retrieves a list of all the strings in the specified SkipList

• classmethod GetSkipListId(domainId As %Integer, name As %String) as %Library.Integer [ WebMethod ]

Finds the SkipList ID corresponding to the supplied name.

• classmethod GetSkipLists(domainId As %Integer, pIncludeCrossDomain As %Boolean = 0) as %XML.DataSet [ WebMethod ]

Retrieves a list of all the SkipLists registered in this domain.

• classmethod GetUserDictionaries() as %XML.DataSet [ WebMethod ]

Returns a list of all the User Dictionaries in this namespace.
Deprecated: please use %iKnow.UserDictionary

• classmethod GetUserDictionaryEntries(userDictId As %Integer) as %XML.DataSet [ WebMethod ]

Returns the contents of a User Dictionary.

Deprecated: please use GetEntries() in %iKnow.UserDictionary

• classmethod GetUserDictionaryId(name As %String) as %Library.Integer [ WebMethod ]

Returns the ID corresponding to the supplied User Dictionary name.
Deprecated: please use NameIndexOpen() %iKnow.UserDictionary

• classmethod HasSkipLists(pDomainId As %Integer) as %Library.Boolean [ WebMethod ]

Returns whether or not there are any SkipLists in the domain

• classmethod RemoveEntityFromSkipList(domainId As %Integer, skipListId As %Integer, entUniId As %Integer) as %Boolean [ WebMethod ]

Removes an entity (by ID) from a SkipList (but not from the domain) For cross-domain SkipLists, use RemoveStringFromSkipList

• classmethod RemoveStringFromSkipList(domainId As %Integer, skipListId As %Integer, string As %String) as %Boolean [ WebMethod ]

Removes a string from a SkipList (but not from the domain)

• classmethod RemoveUserDictionaryEntry(userDictId As %Integer, position As %Integer) as %Boolean [ WebMethod ]

Removes the User Dictionary entry registered at position. This method will not impact the order or position of any remaning entries.

Deprecated: please use RemoveEntry() in %iKnow.UserDictionary

• classmethod SkipListContainsElement(domainId As %Integer, skipListId As %Integer, entUniId As %Integer) as %Library.Boolean [ WebMethod ]

Returns whether or not the SkipList identified by skipListId contains the supplied entity.

• classmethod SkipListContainsString(domainId As %Integer, skipListId As %Integer, entity As %String) as %Library.Boolean [ WebMethod ]

Returns whether or not the SkipList identified by skipListId contains the supplied entity.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search