Home > Class Reference > ENSLIB namespace > %iKnow.Queries.SourceWSAPI

%iKnow.Queries.SourceWSAPI

class %iKnow.Queries.SourceWSAPI extends %iKnow.Queries.AbstractWSAPI

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

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

This class was generated by : %iKnow.Queries.SourceAPI.cls

Method Inventory (Including Private)

Parameters

parameter NAMESPACE = http://www.intersystems.com/iKnow/Queries/SourceWSAPI;
Inherited description: 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.SourceWSAPI;
Inherited description: SERVICENAME - Should be the name of the service for which this is a proxy. Override this parameter in the subclass.
parameter USECLASSNAMESPACES = 1;
Inherited description: 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 (Including Private)

classmethod GetAttributes(pDomainId As %Integer, pSrcId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pTypes As %ListOfDataTypes = "", pLevel As %Integer = $$$IKATTLVLANY) as %XML.DataSet [ WebMethod ]

Returns all the attributes of the Entity Occurrences, Paths and Sentences enclosed in the specified source, optionally filtered by level through pLevel and/or pType.

Please note the startPos and span result columns refer to positions within the path for path-level attributes (level=$$$IKATTLVLPATH) and sentence positions for the other attributes (level=$$$IKATTLVLSENT).

classmethod GetByCrcIds(domainid As %Integer, crcidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, sortByField As %String = "") as %XML.DataSet [ WebMethod ]

Retrieves all sources containing the given CRC ids.

See also GetByEntities() for a description of the parameters.

classmethod GetByCrcMask(domainid As %Integer, master As %String = $$$WILDCARD, relation As %String = $$$WILDCARD, slave As %String = $$$WILDCARD, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", sortByField As %String = "", pActualFormOnly As %Boolean = 0) as %XML.DataSet [ WebMethod ]

Retrieves all sources containing a CRC satisfying the given CRC Mask.

See also GetByEntities() for a description of the parameters.

classmethod GetByCrcs(domainid As %Integer, crclist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, sortByField As %String = "") as %XML.DataSet [ WebMethod ]

Retrieves all sources containing the given CRCs.

See also GetByEntities() for a description of the parameters.

classmethod GetByDomain(domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", sortByField As %String = "") as %XML.DataSet [ WebMethod ]

Returns all sources within a domain, optionally filtered through a %iKnow.Filters.Filter object passed in as filter.

classmethod GetByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, attributeFilter As %ListOfDataTypes = "", sortByField As %String = "", pActualFormOnly As %Boolean = 0) as %XML.DataSet [ WebMethod ]

This method will retrieve all sources containing any (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the entities supplied through 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 sources satisfying the filter criteria.

By default, results are ordered by decreasing source id. You can override this by setting sortByField to the name of a metadata field (optionally appended with " ASC" or " DESC" for this domain to order by that field's value.

The attributeFilter argument can be used to filter the results to only those where the requested entities (entitylist) appear in the context of a particular (set of) attribute(s). By using the negative attribute ID, you can select only those occurrences NOT appearing in the context of that attribute. For example, passing in $lb($$$IKATTNEGATION) will restrict the result to only those entities in a negative context and $lb(-$$$IKATTNEGATION) the ones in an affirmative context. Note that the use of this argument may have a significant performance impact.

If stemming is enabled for this domain through $$$IKPSTEMMING, sources containing any actual form of the entities in entityList will be returned. Use pActualFormOnly=1 to retrieve only those sources containing the actual forms in entitylist. This argument is ignored if stemming is not enabled.

classmethod GetByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, attributeFilter As %ListOfDataTypes = "", sortByField As %String = "", pActualFormOnly As %Boolean = 0) as %XML.DataSet [ WebMethod ]

Retrieves all sources containing the given entity ids.

See also GetByEntities() for a description of the parameters.

classmethod GetByPathIds(domainid As %Integer, pathidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", sortByField As %String = "") as %XML.DataSet [ WebMethod ]

Retrieves all sources containing the given path ids.

See also GetByEntities() for a description of the parameters.

classmethod GetCountByCrcIds(domainid As %Integer, crcidlist As %ListOfDataTypes, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION) as %Library.Integer [ WebMethod ]

Retrieves the number of sources containing the given CRC ids.

See also GetByEntities() for a description of the parameters.