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

Class Category

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.Category

public class Category
extends InformationAsset

POJO for the category asset type in IGC, displayed as 'Category' 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 ItemList<Category>	categoryPath
protected String	glossaryType Valid values are: PUBLISHED (displayed in the UI as 'PUBLISHED') DRAFT (displayed in the UI as 'DRAFT')
protected String	language
protected Category	parentCategory
protected ItemList<Category>	subcategories
protected ItemList<Term>	terms
protected ItemList<Category>	translations
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
Category()

Method Summary

Modifier and Type	Method and Description
ItemList<Category>	getCategoryPath() Retrieve the category_path property (displayed as 'Category Path') of the object.
String	getGlossaryType() Retrieve the glossary_type property (displayed as 'Glossary Type') 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.
ItemList<Category>	getSubcategories() Retrieve the subcategories property (displayed as 'Subcategories') of the object.
ItemList<Term>	getTerms() Retrieve the terms property (displayed as 'Terms') of the object.
ItemList<Category>	getTranslations() Retrieve the translations property (displayed as 'Translations') 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	setCategoryPath(ItemList<Category> categoryPath) Set the category_path property (displayed as Category Path) of the object.
void	setGlossaryType(String glossaryType) Set the glossary_type property (displayed as Glossary Type) 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	setSubcategories(ItemList<Category> subcategories) Set the subcategories property (displayed as Subcategories) of the object.
void	setTerms(ItemList<Term> terms) Set the terms property (displayed as Terms) of the object.
void	setTranslations(ItemList<Category> translations) Set the translations property (displayed as Translations) 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

categoryPath

protected ItemList<Category> categoryPath

glossaryType

protected String glossaryType

Valid values are:

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

language

protected String language

parentCategory

protected Category parentCategory

subcategories

protected ItemList<Category> subcategories

terms

protected ItemList<Term> terms

translations

protected ItemList<Category> translations

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

Category

public Category()

Method Detail

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

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

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

getSubcategories

public ItemList<Category> getSubcategories()

Retrieve the subcategories property (displayed as 'Subcategories') of the object.

Returns:

ItemList<Category>

setSubcategories

public void setSubcategories(ItemList<Category> subcategories)

Set the subcategories property (displayed as Subcategories) of the object.

Parameters:

subcategories - the value to set

getTerms

public ItemList<Term> getTerms()

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

Returns:

ItemList<Term>

setTerms

public void setTerms(ItemList<Term> terms)

Set the terms property (displayed as Terms) of the object.

Parameters:

terms - the value to set

getTranslations

public ItemList<Category> getTranslations()

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

Returns:

ItemList<Category>

setTranslations

public void setTranslations(ItemList<Category> translations)

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

Parameters:

translations - 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