Skip to main content

%iKnow.Queries.CrcWSAPI

Class %iKnow.Queries.CrcWSAPI Extends %iKnow.Queries.AbstractWSAPI [ Deprecated, System = 4 ]

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

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

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/iKnow/Queries/CrcWSAPI";

SERVICENAME​

Parameter SERVICENAME = "iKnow.Queries.CrcWSAPI";

USECLASSNAMESPACES​

Parameter USECLASSNAMESPACES = 1;

Methods​

GetByEntities​

ClassMethod GetByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767) = "", filtermode As %Integer = {$$$FILTERONLY}, positionstomatch As %Integer = {$$$USEPOSALL}, pActualFormOnly As %Boolean = 0) As %XML.DataSet [ WebMethod ]

This method will return all CRC triples in which any of the entities supplied in the entitylist participate, within the boundaries of the supplied domain.

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 CRCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

Specifying a value for positionstomatch will limit the result to those CRCs in which the supplied entities are in the Head (with positionstomatch = $$$USEPOSH), Relation (with positionstomatch = $$$USEPOSR) or Tail (with positionstomatch = $$$USEPOST) role of the CRC, or in any combination of these (with positionstomatch = $$$USEPOSHT, $$$USEPOSHR, $$$USEPOSRT, $$$USEPOSALL (the default)).

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

GetByEntityIds​

ClassMethod GetByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767) = "", filtermode As %Integer = {$$$FILTERONLY}, positionstomatch As %Integer = {$$$USEPOSALL}, pActualFormOnly As %Boolean = 0) As %XML.DataSet [ WebMethod ]

Returns the CRCs in this domain containing any or all of a list of entity IDs.

See also GetByEntities for a description of the parameters.

GetByFilter​

ClassMethod GetByFilter(domainid As %Integer, filter As %String(MAXLEN=32767) = "", filtermode As %Integer = {$$$FILTERONLY}) As %XML.DataSet [ WebMethod ]

Returns all CRCs appearing in any source satisfying the supplied filter objects criteria, with their frequencies and spread recalculated to comply with the filter depending on the value of filtermode, but the result is NOT re-sorted, regardless of the value for filtermode (use GetTop if you want sorted results).

GetBySource​

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

Returns the unique CRCs appearring in the specified sources.

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

GetCountByDomain​

ClassMethod GetCountByDomain(domainid As %Integer, filter As %String(MAXLEN=32767) = "", includeZeroFrequency As %Boolean = 0) As %Library.Integer [ WebMethod ]

Returns the total number of unique CRCs in a domain, optionally limited through supplying a %iKnow.Filters.Filter object as the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria.

GetCountByEntities​

ClassMethod GetCountByEntities(domainid As %Integer, entitylist As %ListOfDataTypes, filter As %String(MAXLEN=32767) = "", positionstomatch As %Integer = {$$$USEPOSALL}, pActualFormOnly As %Boolean = 0) As %Library.Integer [ WebMethod ]

Returns the number of CRCs in this domain, based on a list of entities.

See also GetByEntities for a description of the parameters.

GetCountByEntityIds​

ClassMethod GetCountByEntityIds(domainid As %Integer, entityidlist As %ListOfDataTypes, filter As %String(MAXLEN=32767) = "", positionstomatch As %Integer = {$$$USEPOSALL}, pActualFormOnly As %Boolean = 0) As %Library.Integer [ WebMethod ]

Returns the number of CRCs in this domain, based on a list of entity IDs.

See also GetByEntities for a description of the parameters.

GetCountBySource​

ClassMethod GetCountBySource(domainid As %Integer, sourceidlist As %ListOfDataTypes, setop As %Integer = {$$$UNION}) As %Library.Integer [ WebMethod ]

Returns the total number of unique CRCs appearing in either (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the sources specified by ID in sourceidlist.

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

GetFrequency​

ClassMethod GetFrequency(domainId As %Integer, crcUniId As %Integer, vSrcId As %Integer = 0, filter As %String(MAXLEN=32767) = "") As %Library.Integer [ WebMethod ]

Returns the frequency of the CRC corresponding to the supplied crcUniId.

When specifying a Virtual Source ID, the frequency within the virtual source will be returned.

GetId​

ClassMethod GetId(domainid As %Integer, head As %String, relation As %String, tail As %String, vSrcId As %Integer = 0) As %Library.Integer [ WebMethod ]

Returns, if any, the CRC ID for the combination of Head, Relation and Tail specified.

When specifying a Virtual Source ID, it will treat the head, relation and tails as virtual entities, in the context of that vSrcId.

GetOccurrenceCountBySource​

ClassMethod GetOccurrenceCountBySource(domainid As %Integer, sourceidlist As %ListOfDataTypes) As %Library.Integer [ WebMethod ]

Returns the total number of CRC occurrences in the specified sources.

Use negative source IDs to refer to virtual sources

GetOccurrencesBySource​

ClassMethod GetOccurrencesBySource(domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10) As %XML.DataSet [ WebMethod ]

Returns the CRC occurrences for a given source, in the order in which they appear.

GetSpread​

ClassMethod GetSpread(domainId As %Integer, crcUniId As %Integer, filter As %String(MAXLEN=32767) = "") As %Library.Integer [ WebMethod ]

Returns the spread of the CRC corresponding to the supplied crcUniId.

GetTop​

ClassMethod GetTop(domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767) = "", filtermode As %Integer = {$$$FILTERONLY}, sorttype As %Integer = {$$$SORTBYDOMAINDEFAULT}, vSrcId As %Integer = 0) As %XML.DataSet [ WebMethod ]

Returns the most frequently occurring CRCs for this domain, sorted by descending frequency (with sorttype $$$SORTBYFREQUENCY), spread (with sorttype $$$SORTBYSPREAD) or the domain default (with sorttype $$$SORTBYDOMAINDEFAULT).

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 CRCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

If a Virtual Source ID is provided, only the entities in that virtual source will be considered, filters are ignored and the sort type will always be $$$SORTBYFREQUENCY.

GetValue​

ClassMethod GetValue(domainid As %Integer, crcid As %Integer, vSrcId As %Integer = 0) As %XML.DataSet [ WebMethod ]

Returns the entity values this CRC is composed of.

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