Term object

Description

The Term object contains information relating to a single term including a Term Identifier and text in various lengths - Term30, Term60 and Term198. The term text is also accessible using the more flexible Text method. This returns the longest available term up to a specified maximum length. A term object is created using the Reference object mthods NewTerm, FindTerm, NextTerm and FoundTerm methods or the Concept object methods FirstTerm and NextTerm.

Each term is associated with one (or occasionally more than one) Concept(s). These can be found using the FirstConcept and NextConcept methods.


Term object - Properties


TermId

Data Type: RCODE – Read-only

The TermId the current Term.

The TermId property is Read-only – The NewTerm method is used to select a Term object for a different TermId.


ConceptStatus

Data Type: RSTAT – Read-only

The status of the Term record for the specified TermId.

See data type RSTAT for details of representation.


Term30

Data Type: STRING – Read-only

The 30 character term text for the specified Term Id.


Term60

Data Type: STRING – Read-only

The 60 character term text for the specified Term Id.


Term198

Data Type: STRING – Read-only

The 198 character term text for the specified Term Id.


ConceptCount

Data type: INT32 – Read-only

A count of the total number of concepts associated with this term. If this number is unknown, or is only an estimate, the CountAccuracy property is set accordingly.


CountAccuracy

Data type: INTEGER – Read-only

0 = COUNT_EXACT
1 = COUNT_ESTIMATED
2 = COUNT_UNKNOWN

Name

Data Type: STRING

The string "Term". The Name property has been added to all CLUE API objects to simplify debugging of client code. It can also be used to check the object type when a general object handle is used.


ObjErr

Data Type: INTEGER

An integer containing the error or status code generated by the last method applied to this object.


Term object - Methods


FirstConcept

  • Term.FirstConcept()
  • Returns an object handle to a new instance of the Concept object with the properties appropriate to the first record in the concepts table that is associated with the object Term. If more than one Concept is associated with the same Term, additional Terms are returned using the NextConcept method.


    NextConcept

  • Term.NextConcept()
  • Returns an object handle to a new instance of the Concept object with the properties appropriate to the next record in the concepts table that is associated with Term.

    If this method is applied to an object without applying the FirstConcept method to the same object, its effect is identical to the FirstConcept method.

    If there is no further matching Concept a null handle is returned and ObjErr is set to ERR_NO_MATCH.


    Text

  • Term.Text(Length)
  • Returns the longest text property of the object Term that is less than or equal to the specified length. Length is specified as an integer. This is an alternative to reading the specific properties Term30, Term60 and Term198.