Class Reference
%iKnow.Filters.FilterWSAPI
Server:irisdocs2
Instance:IRISLATEST
User:UnknownUser
 
-
  [%SYS] >  [%iKnow] >  [Filters] >  [FilterWSAPI]
Private  Storage

class %iKnow.Filters.FilterWSAPI extends %SOAP.WebService

This class offers a Web Service access point to iKnow filters. Use the CreateAsString and CreateGroupAsString Web Services to generate the string representations of %iKnow.Filters.Filter objects that can then be passed on to the iKnow Query Web Service APIs.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 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 ClearCachedFilter ClearCachedFilters
ConvertParameter CreateAsString CreateGroupAsString Decrypt
Encrypt EscapeHTML EscapeURL FileWSDL
GetBodyId 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/Filters/FilterWSAPI";
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 SECURITYRESOURCE = "%Development";
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on all of the specified resources in order to view this page.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE. You can also specify or grouping using the '|' character, so 'R1,R2|R3,R3|R4' means you must have resource R1 and one of R2 or R3 and one of R3 or R4. So if you have R1,R3 it will pass, if you have R1,R4 it will not as it does not meet the R2|R3 condition. So the '|' or condition takes precedence over the ',' and condition.
• parameter SERVICENAME = "iKnow.Filters.FilterWSAPI";
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 ClearCachedFilter(domainId As %Integer, filterId As %Status) as %Status [ WebMethod ]

Clears a specific filter from the persistent filter cache, if it exists.

• classmethod ClearCachedFilters(domainId As %Integer) as %Boolean [ WebMethod ]

Clears all filters from the persistent filter cache.

• classmethod CreateAsString(filterName As %String, filterParams As %ListOfDataTypes) as %String [ WebMethod ]

This WebMethod is an access point to generate the string representation (as specified in ToString) for %iKnow.Filters.Filter classes, accessible from Web Service scenarios.

When calling this method, you should supply the Filter Parameters as if calling the %New method of this particular Filter implementation.

• classmethod CreateGroupAsString(domainId As %Integer, groupLogic As %Integer = $$$GROUPFILTERAND, negated As %Boolean = 0, filters As %ListOfDataTypes) as %String [ WebMethod ]

This class enables Web Service users to create the string representation of a %iKnow.Filters.GroupFilter composed of multiple subfilters passed in using their respective string representations as the filters... parameter.



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