/
Type definitions - IBulkCheckService - Terminology-related types

Type definitions - IBulkCheckService - Terminology-related types

Feb. 08, 2024

Concept class

Class definition 
public class Concept
{
    public int ConceptId { get; set; }
    public PropertyBase[] Properties { get; set; }
    public Definition[] Definitions { get; set; }
    public Synonym[] Synonyms { get; set; }
}

Represents definition of a concept.

PropertyMeaning
ConceptIdIdentifier
PropertiesArray of concept properties
DefinitionsArray of concept definitions
SynonymsArray of concept synonyms

PropertyBase class 

Class definition 
public abstract class PropertyBase
{
    public string Name { get; set; }
}

Base class for concept properties.

PropertyMeaning
NameName of the property

TextProperty class

Class definition 
public class TextProperty : PropertyBase
{
    public string[] Values { get; set; }
}

Represents a text property.

PropertyMeaning
ValuesCollection of values of the property

PicklistProperty class

Class definition 
public class PicklistProperty : PropertyBase
{
    public PicklistPropertyValue[] Values { get; set; }
}

Represents a picklist property.

PropertyMeaning
ValuesCollection of values of the property

PicklistPropertyValue class 

Class definition 
public class PicklistPropertyValue
{
    public string Value { get; set; }
    public TermUsage Usage { get; set; }
}

Represents a picklist value.

PropertyMeaning
ValueValue
UsageIntended term usage

TermUsage enumeration

Enum definition 
public enum TermUsage
{
    DoNotUse = 0,
    Normal = 1,
    Recommended = 2,
    Undefined = 4
}

Represents term usage.

ValueMeaning
DoNotUse
Normal
Recommended
Undefined

Definition class

Class definition 
public class Definition
{
    public int Lcid { get; set; }
    public string Text { get; set; }
    public string Note { get; set; }
}

Represents a definition entry.

PropertyMeaning
LcidLanguage code
TextDefinition text
NoteDefinition note

TermBase class

Class definition 
public abstract class TermBase
{
    public int Id { get; set; }
    public string Term { get; set; }
    public PropertyBase[] Properties { get; set; }
}

Base class for terms.

PropertyMeaning
IdIdentifier
TermTerm text
PropertiesArray of associated properties

Synonym class

Class definition 
public class Synonym : TermBase
{ 
}

Represents a synonym.

Term class

Class definition 
public class Term : TermBase
{
    public Concept Concept { get; set; }
}

Represents a term.

PropertyMeaning
Concept

Concept the term belongs to

TermInfo class

Class definition 
public class TermInfo
{
	public Term Term { get; set; }
}

Contains a found term.

PropertyMeaning
TermA term