CcQAPI Class Reference

Inheritance diagram for CcQAPI:

Collaboration diagram for CcQAPI:

Static Public Member Functions
_.Library.Integer	GetCountByEntities (_.Library.Integer domainid, _.Library.String entitylist, _.Library.String filter, _.Library.Integer positionstomatch, _.Library.String scText, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByEntityIds (_.Library.Integer domainid, _.Library.String entityidlist, _.Library.String filter, _.Library.Integer positionstomatch, _.Library.String scText, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.String sourceidlist, _.Library.Integer setop, _.Library.String scText)
_.Library.Integer	GetFrequency (_.Library.Integer domainId, _.Library.Integer ccUniId, _.Library.Integer vSrcId, _.Library.String filter, _.Library.String scText)
_.Library.Integer	GetId (_.Library.Integer pDomainId, _.Library.String pHead, _.Library.String pTail, _.Library.Integer vSrcId, _.Library.String scText)
_.Library.Integer	GetInverse (_.Library.Integer domainId, _.Library.Integer ccUniId, _.Library.String scText)
	Returns the "inverse" of a CC pair, which means the CC composed of the same. More...
_.Library.Integer	GetSpread (_.Library.Integer domainId, _.Library.Integer ccUniId, _.Library.String filter, _.Library.String scText)
_.Library.String	GetValue (_.Library.Integer pDomainId, _.Library.Integer pCcId, _.Library.Integer vSrcId, _.Library.String scText)

Detailed Description

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

See the classdocs for <class>iKnow.Queries.CcAPI</class> for more information.

Member Function Documentation

GetCountByEntities()

_.Library.Integer GetCountByEntities ( _.Library.Integer  domainid, _.Library.String  entitylist, _.Library.String  filter, _.Library.Integer  positionstomatch, _.Library.String  scText, _.Library.Boolean  pActualFormOnly  )

static

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

See the classdocs for <class>iKnow.Queries.CcAPI</class> for more information.

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

See also <method>GetByEntities</method> for a description of the parameters.

GetCountByEntityIds()

_.Library.Integer GetCountByEntityIds ( _.Library.Integer  domainid, _.Library.String  entityidlist, _.Library.String  filter, _.Library.Integer  positionstomatch, _.Library.String  scText, _.Library.Boolean  pActualFormOnly  )

static

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

See also <method>GetByEntities</method> for a description of the parameters.

GetCountBySource()

_.Library.Integer GetCountBySource ( _.Library.Integer  domainid, _.Library.String  sourceidlist, _.Library.Integer  setop, _.Library.String  scText  )

static

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

_.Library.Integer GetFrequency ( _.Library.Integer  domainId, _.Library.Integer  ccUniId, _.Library.Integer  vSrcId, _.Library.String  filter, _.Library.String  scText  )

static

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

_.Library.Integer GetId ( _.Library.Integer  pDomainId, _.Library.String  pHead, _.Library.String  pTail, _.Library.Integer  vSrcId, _.Library.String  scText  )

static

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

_.Library.Integer GetInverse ( _.Library.Integer  domainId, _.Library.Integer  ccUniId, _.Library.String  scText  )

static

Returns the "inverse" of a CC pair, which means the CC composed of the same.

head and tail entity, but at inverted positions.

GetSpread()

_.Library.Integer GetSpread ( _.Library.Integer  domainId, _.Library.Integer  ccUniId, _.Library.String  filter, _.Library.String  scText  )

static

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

GetValue()

_.Library.String GetValue ( _.Library.Integer  pDomainId, _.Library.Integer  pCcId, _.Library.Integer  vSrcId, _.Library.String  scText  )

static

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.