CrcQAPI Class Reference

Inheritance diagram for CrcQAPI:

Collaboration diagram for CrcQAPI:

Static Public Member Functions
_.Library.Integer	GetCountByDomain (_.Library.Integer domainid, _.Library.String filter, _.Library.String scText, _.Library.Boolean includeZeroFrequency)
_.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 crcUniId, _.Library.Integer vSrcId, _.Library.String filter, _.Library.String scText)
_.Library.Integer	GetId (_.Library.Integer domainid, _.Library.String head, _.Library.String relation, _.Library.String tail, _.Library.Integer vSrcId)
_.Library.Integer	GetOccurrenceCountBySource (_.Library.Integer domainid, _.Library.String sourceidlist, _.Library.String scText)
_.Library.Integer	GetSpread (_.Library.Integer domainId, _.Library.Integer crcUniId, _.Library.String filter, _.Library.String scText)

Detailed Description

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

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

Member Function Documentation

GetCountByDomain()

_.Library.Integer GetCountByDomain ( _.Library.Integer  domainid, _.Library.String  filter, _.Library.String  scText, _.Library.Boolean  includeZeroFrequency  )

static

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

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

Returns the total number of unique CRCs in a domain, optionally limited through supplying a

<class>iKnow.Filters.Filter</class> object as the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria.

GetCountByEntities()

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

static

Returns the number of CRCs in this domain, 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

Returns the number of CRCs in this domain, 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 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).

GetFrequency()

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

static

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.

GetId()

_.Library.Integer GetId ( _.Library.Integer  domainid, _.Library.String  head, _.Library.String  relation, _.Library.String  tail, _.Library.Integer  vSrcId  )

static

Returns, if any, the CRC ID for the combination of Head, Relation and Tail specified.

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

GetOccurrenceCountBySource()

_.Library.Integer GetOccurrenceCountBySource ( _.Library.Integer  domainid, _.Library.String  sourceidlist, _.Library.String  scText  )

static

Returns the total number of CRC occurrences in the specified sources.

Use negative source IDs to refer to virtual sources

GetSpread()

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

static

Returns the spread of the CRC corresponding to the supplied crcUniId.