%iKnow.Queries.CcQAPI
Class %iKnow.Queries.CcQAPI Extends %iKnow.Queries.AbstractQAPI [ Deprecated, System = 4 ]
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.
Methods
GetByEntitiesExecute
ClassMethod GetByEntitiesExecute(ByRef qHandle As %Binary, 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 = {$$$USEPOSHT}, sorttype As %Integer = {$$$SORTBYDOMAINDEFAULT}, pActualFormOnly As %Boolean = 0) As %Status [ Internal ]
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 Head (with positionstomatch = $$$USEPOSH) or Tail (with positionstomatch = $$$USEPOST) side rather than either of the two (with positionstomatch = $$$USEPOSHT, 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.
GetByEntitiesFetch
ClassMethod GetByEntitiesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetByEntitiesExecute ]
GetByEntitiesClose
ClassMethod GetByEntitiesClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetByEntitiesExecute ]
GetByEntityIdsExecute
ClassMethod GetByEntityIdsExecute(ByRef qHandle As %Binary, 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 = {$$$USEPOSHT}, sorttype As %Integer = {$$$SORTBYDOMAINDEFAULT}, pActualFormOnly As %Boolean = 0) As %Status [ Internal ]
This method looks up CCs based on a list of Entity IDs.
See also GetByEntities for a description of the parameters.
GetByEntityIdsFetch
ClassMethod GetByEntityIdsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetByEntityIdsExecute ]
GetByEntityIdsClose
ClassMethod GetByEntityIdsClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetByEntityIdsExecute ]
GetCountByEntities
ClassMethod GetCountByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767) = "", positionstomatch As %Integer = {$$$USEPOSHT}, 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.
GetCountByEntityIds
ClassMethod GetCountByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767) = "", positionstomatch As %Integer = {$$$USEPOSHT}, 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.
GetCountBySource
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).
GetFrequency
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.
GetId
ClassMethod GetId(pDomainId As %Integer, pHead As %String(MAXLEN=32767), pTail 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 head and tail specified.
When specifying a Virtual Source ID, it will treat the heads and tails as virtual entities, in the context of that vSrcId.
GetInverse
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 head and tail entity, but at inverted positions.
GetSpread
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.
GetValue
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.