Class %iKnow.Queries.CcQAPI

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
		10	2

Summary

Methods
%%OIDGet	%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	GetByEntitiesClose	GetByEntitiesExecute	GetByEntitiesFetch
GetByEntityIdsClose	GetByEntityIdsExecute	GetByEntityIdsFetch	GetCountByEntities
GetCountByEntityIds	GetCountBySource	GetInverse

Methods

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %String, filter As %String = "", positionstomatch As %Integer = $$$USEPOSMS, Output scText As %String = "") 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, filter As %String = "", positionstomatch As %Integer = $$$USEPOSMS, Output scText As %String = "") 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, 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 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.

Queries

• query GetByEntities(domainid As %Integer, entitylist As %String, page As %Integer = 1, pagesize As %Integer = 10, filter As %String = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT)

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

• query GetByEntityIds(domainid As %Integer, entityidlist As %String, page As %Integer = 1, pagesize As %Integer = 10, filter As %String = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT)

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.


[BASEXML] > [%iKnow] > [Queries] > [CcQAPI]		Private Storage