org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base

Class Term

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.Term

public class Term
extends InformationAsset

POJO for the term asset type in IGC, displayed as 'Term' in the IGC UI.

(this code has been created based on out-of-the-box IGC metadata types. If modifications are needed, eg. to handle custom attributes, extending from this class in your own custom class is the best approach.)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	abbreviation
protected String	additionalAbbreviation
protected ItemList<InformationAsset>	assignedAssets
protected ItemList<Term>	assignedTerms
protected ItemList<MainObject>	automationRules
protected ItemList<Category>	categoryPath
protected String	example
protected String	glossaryType Valid values are: PUBLISHED (displayed in the UI as 'PUBLISHED') DRAFT (displayed in the UI as 'DRAFT')
protected Term	hasA
protected ItemList<Term>	hasATerm
protected ItemList<Term>	hasTypes
protected ItemList<Term>	isATypeOf
protected Boolean	isModifier
protected ItemList<Term>	isOf
protected String	language
protected Category	parentCategory
protected Term	preferredSynonym
protected ItemList<Category>	referencingCategories
protected ItemList<Term>	relatedTerms
protected Term	replacedBy
protected ItemList<Term>	replaces
protected String	status Valid values are: CANDIDATE (displayed in the UI as 'Candidate') ACCEPTED (displayed in the UI as 'Accepted') STANDARD (displayed in the UI as 'Standard') DEPRECATED (displayed in the UI as 'Deprecated')
protected ItemList<Term>	synonyms
protected ItemList<Term>	translations
protected String	type Valid values are: NONE (displayed in the UI as 'None') PRIME (displayed in the UI as 'Primary') CLASS (displayed in the UI as 'Secondary')
protected String	usage
protected List<String>	workflowCurrentState Valid values are: DRAFT (displayed in the UI as 'DRAFT') WAITING_APPROVAL (displayed in the UI as 'WAITING_APPROVAL') APPROVED (displayed in the UI as 'APPROVED')
protected List<String>	workflowStoredState Valid values are: DRAFT (displayed in the UI as 'DRAFT') WAITING_APPROVAL (displayed in the UI as 'WAITING_APPROVAL') APPROVED (displayed in the UI as 'APPROVED')

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

blueprintElements, impactedBy, impactsOn, inCollections, nativeId, readByDesign, readByOperational, readByStatic, readByUserDefined, writtenByDesign, writtenByOperational, writtenByStatic, writtenByUserDefined

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

assignedToTerms, governedByRules, implementsRules, labels, longDescription, name, shortDescription, stewards

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

_context, _id, _name, _type, _url, createdBy, createdOn, modifiedBy, modifiedOn, notes

Constructor Summary

Constructors

Constructor and Description
Term()

Method Summary

Modifier and Type	Method and Description
String	getAbbreviation() Retrieve the abbreviation property (displayed as 'Abbreviation') of the object.
String	getAdditionalAbbreviation() Retrieve the additional_abbreviation property (displayed as 'Additional Abbreviation') of the object.
ItemList<InformationAsset>	getAssignedAssets() Retrieve the assigned_assets property (displayed as 'Assigned Assets') of the object.
ItemList<Term>	getAssignedTerms() Retrieve the assigned_terms property (displayed as 'Assigned Terms') of the object.
ItemList<MainObject>	getAutomationRules() Retrieve the Automation_Rules property (displayed as 'Automation Rules') of the object.
ItemList<Category>	getCategoryPath() Retrieve the category_path property (displayed as 'Category Path') of the object.
String	getExample() Retrieve the example property (displayed as 'Example') of the object.
String	getGlossaryType() Retrieve the glossary_type property (displayed as 'Glossary Type') of the object.
Term	getHasA() Retrieve the has_a property (displayed as 'Has A') of the object.
ItemList<Term>	getHasATerm() Retrieve the has_a_term property (displayed as 'Has A') of the object.
ItemList<Term>	getHasTypes() Retrieve the has_types property (displayed as 'Has Types') of the object.
ItemList<Term>	getIsATypeOf() Retrieve the is_a_type_of property (displayed as 'Is a Type Of') of the object.
Boolean	getIsModifier() Retrieve the is_modifier property (displayed as 'Is Modifier') of the object.
ItemList<Term>	getIsOf() Retrieve the is_of property (displayed as 'Is Of') of the object.
String	getLanguage() Retrieve the language property (displayed as 'Language') of the object.
Category	getParentCategory() Retrieve the parent_category property (displayed as 'Parent Category') of the object.
Term	getPreferredSynonym() Retrieve the preferred_synonym property (displayed as 'Preferred Synonym') of the object.
ItemList<Category>	getReferencingCategories() Retrieve the referencing_categories property (displayed as 'Referencing Categories') of the object.
ItemList<Term>	getRelatedTerms() Retrieve the related_terms property (displayed as 'Related Terms') of the object.
Term	getReplacedBy() Retrieve the replaced_by property (displayed as 'Replaced By') of the object.
ItemList<Term>	getReplaces() Retrieve the replaces property (displayed as 'Replaces') of the object.
String	getStatus() Retrieve the status property (displayed as 'Status') of the object.
ItemList<Term>	getSynonyms() Retrieve the synonyms property (displayed as 'Synonyms') of the object.
String	getTheType() Retrieve the type property (displayed as 'Type') of the object.
ItemList<Term>	getTranslations() Retrieve the translations property (displayed as 'Translations') of the object.
String	getUsage() Retrieve the usage property (displayed as 'Usage') of the object.
List<String>	getWorkflowCurrentState() Retrieve the workflow_current_state property (displayed as 'Workflow Current State') of the object.
List<String>	getWorkflowStoredState() Retrieve the workflow_stored_state property (displayed as 'Workflow Stored State') of the object.
void	setAbbreviation(String abbreviation) Set the abbreviation property (displayed as Abbreviation) of the object.
void	setAdditionalAbbreviation(String additionalAbbreviation) Set the additional_abbreviation property (displayed as Additional Abbreviation) of the object.
void	setAssignedAssets(ItemList<InformationAsset> assignedAssets) Set the assigned_assets property (displayed as Assigned Assets) of the object.
void	setAssignedTerms(ItemList<Term> assignedTerms) Set the assigned_terms property (displayed as Assigned Terms) of the object.
void	setAutomationRules(ItemList<MainObject> automationRules) Set the Automation_Rules property (displayed as Automation Rules) of the object.
void	setCategoryPath(ItemList<Category> categoryPath) Set the category_path property (displayed as Category Path) of the object.
void	setExample(String example) Set the example property (displayed as Example) of the object.
void	setGlossaryType(String glossaryType) Set the glossary_type property (displayed as Glossary Type) of the object.
void	setHasA(Term hasA) Set the has_a property (displayed as Has A) of the object.
void	setHasATerm(ItemList<Term> hasATerm) Set the has_a_term property (displayed as Has A) of the object.
void	setHasTypes(ItemList<Term> hasTypes) Set the has_types property (displayed as Has Types) of the object.
void	setIsATypeOf(ItemList<Term> isATypeOf) Set the is_a_type_of property (displayed as Is a Type Of) of the object.
void	setIsModifier(Boolean isModifier) Set the is_modifier property (displayed as Is Modifier) of the object.
void	setIsOf(ItemList<Term> isOf) Set the is_of property (displayed as Is Of) of the object.
void	setLanguage(String language) Set the language property (displayed as Language) of the object.
void	setParentCategory(Category parentCategory) Set the parent_category property (displayed as Parent Category) of the object.
void	setPreferredSynonym(Term preferredSynonym) Set the preferred_synonym property (displayed as Preferred Synonym) of the object.
void	setReferencingCategories(ItemList<Category> referencingCategories) Set the referencing_categories property (displayed as Referencing Categories) of the object.
void	setRelatedTerms(ItemList<Term> relatedTerms) Set the related_terms property (displayed as Related Terms) of the object.
void	setReplacedBy(Term replacedBy) Set the replaced_by property (displayed as Replaced By) of the object.
void	setReplaces(ItemList<Term> replaces) Set the replaces property (displayed as Replaces) of the object.
void	setStatus(String status) Set the status property (displayed as Status) of the object.
void	setSynonyms(ItemList<Term> synonyms) Set the synonyms property (displayed as Synonyms) of the object.
void	setTheType(String type) Set the type property (displayed as Type) of the object.
void	setTranslations(ItemList<Term> translations) Set the translations property (displayed as Translations) of the object.
void	setUsage(String usage) Set the usage property (displayed as Usage) of the object.
void	setWorkflowCurrentState(List<String> workflowCurrentState) Set the workflow_current_state property (displayed as Workflow Current State) of the object.
void	setWorkflowStoredState(List<String> workflowStoredState) Set the workflow_stored_state property (displayed as Workflow Stored State) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

getBlueprintElements, getImpactedBy, getImpactsOn, getInCollections, getNativeId, getReadByDesign, getReadByOperational, getReadByStatic, getReadByUserDefined, getWrittenByDesign, getWrittenByOperational, getWrittenByStatic, getWrittenByUserDefined, setBlueprintElements, setImpactedBy, setImpactsOn, setInCollections, setNativeId, setReadByDesign, setReadByOperational, setReadByStatic, setReadByUserDefined, setWrittenByDesign, setWrittenByOperational, setWrittenByStatic, setWrittenByUserDefined

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

getAssignedToTerms, getGovernedByRules, getImplementsRules, getLabels, getLongDescription, getShortDescription, getStewards, getTheName, setAssignedToTerms, setGovernedByRules, setImplementsRules, setLabels, setLongDescription, setShortDescription, setStewards, setTheName

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

areModificationDetailsPopulated, getContext, getCreatedBy, getCreatedOn, getId, getIdentity, getModifiedBy, getModifiedOn, getName, getNotes, getType, getUrl, isEmbeddedAsset, isFullyRetrieved, isIdentityPopulated, isSimpleType, isVirtualAsset, setContext, setCreatedBy, setCreatedOn, setFullyRetrieved, setId, setModifiedBy, setModifiedOn, setName, setNotes, setType, setUrl

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

automationRules

protected ItemList<MainObject> automationRules

abbreviation

protected String abbreviation

additionalAbbreviation

protected String additionalAbbreviation

assignedAssets

protected ItemList<InformationAsset> assignedAssets

assignedTerms

protected ItemList<Term> assignedTerms

categoryPath

protected ItemList<Category> categoryPath

example

protected String example

glossaryType

protected String glossaryType

Valid values are:

• PUBLISHED (displayed in the UI as 'PUBLISHED')
• DRAFT (displayed in the UI as 'DRAFT')

hasA

protected Term hasA

hasATerm

protected ItemList<Term> hasATerm

hasTypes

protected ItemList<Term> hasTypes

isATypeOf

protected ItemList<Term> isATypeOf

isModifier

protected Boolean isModifier

isOf

protected ItemList<Term> isOf

language

protected String language

parentCategory

protected Category parentCategory

preferredSynonym

protected Term preferredSynonym

referencingCategories

protected ItemList<Category> referencingCategories

relatedTerms

protected ItemList<Term> relatedTerms

replacedBy

protected Term replacedBy

replaces

protected ItemList<Term> replaces

status

protected String status

Valid values are:

• CANDIDATE (displayed in the UI as 'Candidate')
• ACCEPTED (displayed in the UI as 'Accepted')
• STANDARD (displayed in the UI as 'Standard')
• DEPRECATED (displayed in the UI as 'Deprecated')

synonyms

protected ItemList<Term> synonyms

translations

protected ItemList<Term> translations

type

protected String type

Valid values are:

• NONE (displayed in the UI as 'None')
• PRIME (displayed in the UI as 'Primary')
• CLASS (displayed in the UI as 'Secondary')

usage

protected String usage

workflowCurrentState

protected List<String> workflowCurrentState

Valid values are:

• DRAFT (displayed in the UI as 'DRAFT')
• WAITING_APPROVAL (displayed in the UI as 'WAITING_APPROVAL')
• APPROVED (displayed in the UI as 'APPROVED')

workflowStoredState

protected List<String> workflowStoredState

Valid values are:

• DRAFT (displayed in the UI as 'DRAFT')
• WAITING_APPROVAL (displayed in the UI as 'WAITING_APPROVAL')
• APPROVED (displayed in the UI as 'APPROVED')

Constructor Detail

Term

public Term()

Method Detail

getAutomationRules

public ItemList<MainObject> getAutomationRules()

Retrieve the Automation_Rules property (displayed as 'Automation Rules') of the object.

Returns:

ItemList<MainObject>

setAutomationRules

public void setAutomationRules(ItemList<MainObject> automationRules)

Set the Automation_Rules property (displayed as Automation Rules) of the object.

Parameters:

automationRules - the value to set

getAbbreviation

public String getAbbreviation()

Retrieve the abbreviation property (displayed as 'Abbreviation') of the object.

Returns:

String

setAbbreviation

public void setAbbreviation(String abbreviation)

Set the abbreviation property (displayed as Abbreviation) of the object.

Parameters:

abbreviation - the value to set

getAdditionalAbbreviation

public String getAdditionalAbbreviation()

Retrieve the additional_abbreviation property (displayed as 'Additional Abbreviation') of the object.

Returns:

String

setAdditionalAbbreviation

public void setAdditionalAbbreviation(String additionalAbbreviation)

Set the additional_abbreviation property (displayed as Additional Abbreviation) of the object.

Parameters:

additionalAbbreviation - the value to set

getAssignedAssets

public ItemList<InformationAsset> getAssignedAssets()

Retrieve the assigned_assets property (displayed as 'Assigned Assets') of the object.

Returns:

ItemList<InformationAsset>

setAssignedAssets

public void setAssignedAssets(ItemList<InformationAsset> assignedAssets)

Set the assigned_assets property (displayed as Assigned Assets) of the object.

Parameters:

assignedAssets - the value to set

getAssignedTerms

public ItemList<Term> getAssignedTerms()

Retrieve the assigned_terms property (displayed as 'Assigned Terms') of the object.

Returns:

ItemList<Term>

setAssignedTerms

public void setAssignedTerms(ItemList<Term> assignedTerms)

Set the assigned_terms property (displayed as Assigned Terms) of the object.

Parameters:

assignedTerms - the value to set

getCategoryPath

public ItemList<Category> getCategoryPath()

Retrieve the category_path property (displayed as 'Category Path') of the object.

Returns:

ItemList<Category>

setCategoryPath

public void setCategoryPath(ItemList<Category> categoryPath)

Set the category_path property (displayed as Category Path) of the object.

Parameters:

categoryPath - the value to set

getExample

public String getExample()

Retrieve the example property (displayed as 'Example') of the object.

Returns:

String

setExample

public void setExample(String example)

Set the example property (displayed as Example) of the object.

Parameters:

example - the value to set

getGlossaryType

public String getGlossaryType()

Retrieve the glossary_type property (displayed as 'Glossary Type') of the object.

Returns:

String

setGlossaryType

public void setGlossaryType(String glossaryType)

Set the glossary_type property (displayed as Glossary Type) of the object.

Parameters:

glossaryType - the value to set

getHasA

public Term getHasA()

Retrieve the has_a property (displayed as 'Has A') of the object.

Returns:

Term

setHasA

public void setHasA(Term hasA)

Set the has_a property (displayed as Has A) of the object.

Parameters:

hasA - the value to set

getHasATerm

public ItemList<Term> getHasATerm()

Retrieve the has_a_term property (displayed as 'Has A') of the object.

Returns:

ItemList<Term>

setHasATerm

public void setHasATerm(ItemList<Term> hasATerm)

Set the has_a_term property (displayed as Has A) of the object.

Parameters:

hasATerm - the value to set

getHasTypes

public ItemList<Term> getHasTypes()

Retrieve the has_types property (displayed as 'Has Types') of the object.

Returns:

ItemList<Term>

setHasTypes

public void setHasTypes(ItemList<Term> hasTypes)

Set the has_types property (displayed as Has Types) of the object.

Parameters:

hasTypes - the value to set

getIsATypeOf

public ItemList<Term> getIsATypeOf()

Retrieve the is_a_type_of property (displayed as 'Is a Type Of') of the object.

Returns:

ItemList<Term>

setIsATypeOf

public void setIsATypeOf(ItemList<Term> isATypeOf)

Set the is_a_type_of property (displayed as Is a Type Of) of the object.

Parameters:

isATypeOf - the value to set

getIsModifier

public Boolean getIsModifier()

Retrieve the is_modifier property (displayed as 'Is Modifier') of the object.

Returns:

Boolean

setIsModifier

public void setIsModifier(Boolean isModifier)

Set the is_modifier property (displayed as Is Modifier) of the object.

Parameters:

isModifier - the value to set

getIsOf

public ItemList<Term> getIsOf()

Retrieve the is_of property (displayed as 'Is Of') of the object.

Returns:

ItemList<Term>

setIsOf

public void setIsOf(ItemList<Term> isOf)

Set the is_of property (displayed as Is Of) of the object.

Parameters:

isOf - the value to set

getLanguage

public String getLanguage()

Retrieve the language property (displayed as 'Language') of the object.

Returns:

String

setLanguage

public void setLanguage(String language)

Set the language property (displayed as Language) of the object.

Parameters:

language - the value to set

getParentCategory

public Category getParentCategory()

Retrieve the parent_category property (displayed as 'Parent Category') of the object.

Returns:

Category

setParentCategory

public void setParentCategory(Category parentCategory)

Set the parent_category property (displayed as Parent Category) of the object.

Parameters:

parentCategory - the value to set

getPreferredSynonym

public Term getPreferredSynonym()

Retrieve the preferred_synonym property (displayed as 'Preferred Synonym') of the object.

Returns:

Term

setPreferredSynonym

public void setPreferredSynonym(Term preferredSynonym)

Set the preferred_synonym property (displayed as Preferred Synonym) of the object.

Parameters:

preferredSynonym - the value to set

getReferencingCategories

public ItemList<Category> getReferencingCategories()

Retrieve the referencing_categories property (displayed as 'Referencing Categories') of the object.

Returns:

ItemList<Category>

setReferencingCategories

public void setReferencingCategories(ItemList<Category> referencingCategories)

Set the referencing_categories property (displayed as Referencing Categories) of the object.

Parameters:

referencingCategories - the value to set

getRelatedTerms

public ItemList<Term> getRelatedTerms()

Retrieve the related_terms property (displayed as 'Related Terms') of the object.

Returns:

ItemList<Term>

setRelatedTerms

public void setRelatedTerms(ItemList<Term> relatedTerms)

Set the related_terms property (displayed as Related Terms) of the object.

Parameters:

relatedTerms - the value to set

getReplacedBy

public Term getReplacedBy()

Retrieve the replaced_by property (displayed as 'Replaced By') of the object.

Returns:

Term

setReplacedBy

public void setReplacedBy(Term replacedBy)

Set the replaced_by property (displayed as Replaced By) of the object.

Parameters:

replacedBy - the value to set

getReplaces

public ItemList<Term> getReplaces()

Retrieve the replaces property (displayed as 'Replaces') of the object.

Returns:

ItemList<Term>

setReplaces

public void setReplaces(ItemList<Term> replaces)

Set the replaces property (displayed as Replaces) of the object.

Parameters:

replaces - the value to set

getStatus

public String getStatus()

Retrieve the status property (displayed as 'Status') of the object.

Returns:

String

setStatus

public void setStatus(String status)

Set the status property (displayed as Status) of the object.

Parameters:

status - the value to set

getSynonyms

public ItemList<Term> getSynonyms()

Retrieve the synonyms property (displayed as 'Synonyms') of the object.

Returns:

ItemList<Term>

setSynonyms

public void setSynonyms(ItemList<Term> synonyms)

Set the synonyms property (displayed as Synonyms) of the object.

Parameters:

synonyms - the value to set

getTranslations

public ItemList<Term> getTranslations()

Retrieve the translations property (displayed as 'Translations') of the object.

Returns:

ItemList<Term>

setTranslations

public void setTranslations(ItemList<Term> translations)

Set the translations property (displayed as Translations) of the object.

Parameters:

translations - the value to set

getTheType

public String getTheType()

Retrieve the type property (displayed as 'Type') of the object.

Returns:

String

setTheType

public void setTheType(String type)

Set the type property (displayed as Type) of the object.

Parameters:

type - the value to set

getUsage

public String getUsage()

Retrieve the usage property (displayed as 'Usage') of the object.

Returns:

String

setUsage

public void setUsage(String usage)

Set the usage property (displayed as Usage) of the object.

Parameters:

usage - the value to set

getWorkflowCurrentState

public List<String> getWorkflowCurrentState()

Retrieve the workflow_current_state property (displayed as 'Workflow Current State') of the object.

Returns:

List<String>

setWorkflowCurrentState

public void setWorkflowCurrentState(List<String> workflowCurrentState)

Set the workflow_current_state property (displayed as Workflow Current State) of the object.

Parameters:

workflowCurrentState - the value to set

getWorkflowStoredState

public List<String> getWorkflowStoredState()

Retrieve the workflow_stored_state property (displayed as 'Workflow Stored State') of the object.

Returns:

List<String>

setWorkflowStoredState

public void setWorkflowStoredState(List<String> workflowStoredState)

Set the workflow_stored_state property (displayed as Workflow Stored State) of the object.

Parameters:

workflowStoredState - the value to set