Class Reference
%iKnow.Queries.CcQAPI
Server:irisdocs1
Instance:IRISLATEST
User:UnknownUser
 
-
  [%SYS] >  [%iKnow] >  [Queries] >  [CcQAPI]
Private  Storage

class %iKnow.Queries.CcQAPI extends %iKnow.Queries.AbstractQAPI

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

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

This class was generated by %iKnow.Queries.CcAPI.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
14 2


Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
GetCountByEntities GetCountByEntityIds GetCountBySource GetFrequency
GetId GetInverse GetSpread GetValue


Methods

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", positionstomatch As %Integer = $$$USEPOSMS, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

This method returns the number of CC pairs based on a list of entities.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", positionstomatch As %Integer = $$$USEPOSMS, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

This method returns the number of CC pairs based on a list of entity ids.

See also GetByEntities for a description of the parameters.

• classmethod GetCountBySource(domainid As %Integer, sourceidlist As %String(MAXLEN=32767), setop As %Integer = $$$UNION, Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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

To get the unique CCs 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, ccUniId As %Integer, vSrcId As %Integer = 0, filter As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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

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

• classmethod GetId(pDomainId As %Integer, pMaster As %String(MAXLEN=32767), pSlave As %String(MAXLEN=32767), vSrcId As %Integer = 0, Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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

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

• classmethod GetInverse(domainId As %Integer, ccUniId As %Integer, Output scText As %String = "") as %Library.Integer [ SQLProc = ]
Returns the "inverse" of a CC pair, which means the CC composed of the same master and slave entity, but at inverted positions.
• classmethod GetSpread(domainId As %Integer, ccUniId As %Integer, filter As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Returns the spread of the CC corresponding to the supplied ccUniId.

• classmethod GetValue(pDomainId As %Integer, pCcId As %Integer, vSrcId As %Integer = 0, Output scText As %String = "") as %String [ SQLProc = ]

Returns the entity values this CC is composed of.

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


Queries

• query GetByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, pActualFormOnly As %Boolean = 0)
Selects mEntUniId As %Integer, mEntity As %String(MAXLEN=32767), sEntUniId As %Integer, sEntity As %String(MAXLEN=32767), frequency As %Integer, spread As %Integer, ccUniId As %Integer

This method will return all CC pairs in which any (if setop = $$$UNION) or all (if setop = $$$INTERSECT) 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 CCs 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 CCs in which the supplied entities are on the Master (with positionstomatch = $$$USEPOSM) or Slave (with positionstomatch = $$$USEPOSS) side rather than either of the two (with positionstomatch = $$$USEPOSMS, default setting).

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

• query GetByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, pActualFormOnly As %Boolean = 0)
Selects mEntUniId As %Integer, mEntity As %String(MAXLEN=32767), sEntUniId As %Integer, sEntity As %String(MAXLEN=32767), frequency As %Integer, spread As %Integer, ccUniId As %Integer

This method looks up CCs based on a list of Entity IDs.

See also GetByEntities for a description of the parameters.



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