Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

This version of the product is no longer supported, and this documentation is no longer updated regularly. See the latest version of this content.Opens in a new tab

%iKnow.Queries.CrcWSAPI

class %iKnow.Queries.CrcWSAPI extends %iKnow.Queries.AbstractWSAPI

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.

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

Method Inventory

Parameters

parameter NAMESPACE = http://www.intersystems.com/iKnow/Queries/CrcWSAPI;
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.CrcWSAPI;
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

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 Master (with positionstomatch = $$$USEPOSM), Relation (with positionstomatch = $$$USEPOSR) or Slave (with positionstomatch = $$$USEPOSS) role of the CRC, or in any combination of these (with positionstomatch = $$$USEPOSMS, $$$USEPOSMR, $$$USEPOSRS, $$$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.

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.

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).

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).

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.

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.

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.

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).

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.

classmethod GetId(domainid As %Integer, master As %String, relation As %String, slave As %String, vSrcId As %Integer = 0) as %Library.Integer [ WebMethod ]

Returns, if any, the CRC ID for the combination of master, relation and slave specified.

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

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

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.

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.

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.

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.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab