org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common

Class MainObject

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.MainObject

Direct Known Subclasses:

InformationAsset

public class MainObject
extends Reference

The supertype of many IGC objects -- in particular, any OpenIGC objects.

Simply define a new POJO as extending this base class to inherit the attributes that are found on virtually all IGC asset types.

Field Summary

Fields

Modifier and Type	Field and Description
protected ReferenceList	assigned_to_terms The 'assigned_to_terms' property, displayed as 'Assigned to Terms' in the IGC UI.
protected String	created_by The 'created_by' property, displayed as 'Created By' in the IGC UI.
protected Date	created_on The 'created_on' property, displayed as 'Created On' in the IGC UI.
protected ReferenceList	governed_by_rules The 'governed_by_rules' property, displayed as 'Governed by Rules' in the IGC UI.
protected ReferenceList	implements_rules The 'implements_rules' property, displayed as 'Implements Rules' in the IGC UI.
protected ReferenceList	labels The 'labels' property, displayed as 'Labels' in the IGC UI.
protected String	long_description The 'long_description' property, displayed as 'Long Description' in the IGC UI.
protected String	modified_by The 'modified_by' property, displayed as 'Modified By' in the IGC UI.
protected Date	modified_on The 'modified_on' property, displayed as 'Modified On' in the IGC UI.
protected String	name The 'name' property, displayed as 'Name' in the IGC UI.
protected String	short_description The 'short_description' property, displayed as 'Short Description' in the IGC UI.
protected ReferenceList	stewards The 'stewards' property, displayed as 'Stewards' in the IGC UI.

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

_context, _id, _name, _type, _url

Constructor Summary

Constructors

Constructor and Description
MainObject()

Method Summary

Modifier and Type	Method and Description
static Boolean	canBeCreated()
static List<String>	getAllProperties()
ReferenceList	getAssignedToTerms()
String	getCreatedBy()
Date	getCreatedOn()
ReferenceList	getGovernedByRules()
static String	getIgcTypeDisplayName()
static String	getIgcTypeId()
ReferenceList	getImplementsRules()
ReferenceList	getLabels()
String	getLongDescription()
String	getModifiedBy()
Date	getModifiedOn()
static List<String>	getNonRelationshipProperties()
static List<String>	getPagedRelationshipProperties()
String	getShortDescription()
ReferenceList	getStewards()
static List<String>	getStringProperties()
String	getTheName()
static Boolean	includesModificationDetails()
static Boolean	isMainObject(Object obj)
void	setAssignedToTerms(ReferenceList assigned_to_terms)
void	setCreatedBy(String created_by)
void	setCreatedOn(Date created_on)
void	setGovernedByRules(ReferenceList governed_by_rules)
void	setImplementsRules(ReferenceList implements_rules)
void	setLabels(ReferenceList labels)
void	setLongDescription(String long_description)
void	setModifiedBy(String modified_by)
void	setModifiedOn(Date modified_on)
void	setShortDescription(String short_description)
void	setStewards(ReferenceList stewards)
void	setTheName(String name)

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

canAssetBeCreatedFromPOJO, getAllPropertiesFromPOJO, getAssetDetails, getAssetTypeForSearch, getAssetTypeFromPOJO, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getContext, getDisplayNameFromPOJO, getFieldByName, getFullAssetDetails, getId, getIdentity, getName, getNonRelationshipPropertiesFromPOJO, getPagedRelationalPropertiesFromPOJO, getPropertyByName, getStringPropertiesFromPOJO, getType, getUrl, hasModificationDetails, hasModificationDetails, hasProperty, isCreatableFromPOJO, isFullyRetrieved, isReference, isReference, isReferenceList, isReferenceList, isSimpleType, isSimpleType, populateContext, populateModificationDetails, setContext, setFullyRetrieved, setId, setName, setPropertyByName, setType, setUrl

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

getAllFields, toString

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

The 'name' property, displayed as 'Name' in the IGC UI.

Equivalent to the '_name' property of a Reference, but only populated when an asset has been retrieved rather than just its reference.

short_description

protected String short_description

The 'short_description' property, displayed as 'Short Description' in the IGC UI.

long_description

protected String long_description

The 'long_description' property, displayed as 'Long Description' in the IGC UI.

labels

protected ReferenceList labels

The 'labels' property, displayed as 'Labels' in the IGC UI.

Will be a ReferenceList of Label objects.

stewards

protected ReferenceList stewards

The 'stewards' property, displayed as 'Stewards' in the IGC UI.

Will be a ReferenceList of Steward objects.

assigned_to_terms

protected ReferenceList assigned_to_terms

The 'assigned_to_terms' property, displayed as 'Assigned to Terms' in the IGC UI.

Will be a ReferenceList of Term objects.

implements_rules

protected ReferenceList implements_rules

The 'implements_rules' property, displayed as 'Implements Rules' in the IGC UI.

Will be a ReferenceList of InformationGovernanceRule objects.

governed_by_rules

protected ReferenceList governed_by_rules

The 'governed_by_rules' property, displayed as 'Governed by Rules' in the IGC UI.

Will be a ReferenceList of InformationGovernanceRule objects.

created_by

protected String created_by

The 'created_by' property, displayed as 'Created By' in the IGC UI.

Provides the name of the user who created this asset.

created_on

protected Date created_on

The 'created_on' property, displayed as 'Created On' in the IGC UI.

Provides the date and time on which this asset was created.

modified_by

protected String modified_by

The 'modified_by' property, displayed as 'Modified By' in the IGC UI.

Provides the name of the user who last modified this asset.

modified_on

protected Date modified_on

The 'modified_on' property, displayed as 'Modified On' in the IGC UI.

Provides the date and time on which this asset was last modified.

Constructor Detail

MainObject

public MainObject()

Method Detail

getIgcTypeId

public static String getIgcTypeId()

getIgcTypeDisplayName

public static String getIgcTypeDisplayName()

getTheName

public String getTheName()

See Also:

name

setTheName

public void setTheName(String name)

See Also:

name

getShortDescription

public String getShortDescription()

See Also:

short_description

setShortDescription

public void setShortDescription(String short_description)

See Also:

short_description

getLongDescription

public String getLongDescription()

See Also:

long_description

setLongDescription

public void setLongDescription(String long_description)

See Also:

long_description

getLabels

public ReferenceList getLabels()

See Also:

labels

setLabels

public void setLabels(ReferenceList labels)

See Also:

labels

getStewards

public ReferenceList getStewards()

See Also:

stewards

setStewards

public void setStewards(ReferenceList stewards)

See Also:

stewards

getAssignedToTerms

public ReferenceList getAssignedToTerms()

See Also:

assigned_to_terms

setAssignedToTerms

public void setAssignedToTerms(ReferenceList assigned_to_terms)

See Also:

assigned_to_terms

getImplementsRules

public ReferenceList getImplementsRules()

See Also:

implements_rules

setImplementsRules

public void setImplementsRules(ReferenceList implements_rules)

See Also:

implements_rules

getGovernedByRules

public ReferenceList getGovernedByRules()

See Also:

governed_by_rules

setGovernedByRules

public void setGovernedByRules(ReferenceList governed_by_rules)

See Also:

governed_by_rules

getCreatedBy

public String getCreatedBy()

See Also:

created_by

setCreatedBy

public void setCreatedBy(String created_by)

See Also:

created_by

getCreatedOn

public Date getCreatedOn()

See Also:

created_on

setCreatedOn

public void setCreatedOn(Date created_on)

See Also:

created_on

getModifiedBy

public String getModifiedBy()

See Also:

modified_by

setModifiedBy

public void setModifiedBy(String modified_by)

See Also:

modified_by

getModifiedOn

public Date getModifiedOn()

See Also:

modified_on

setModifiedOn

public void setModifiedOn(Date modified_on)

See Also:

modified_on

canBeCreated

public static Boolean canBeCreated()

includesModificationDetails

public static Boolean includesModificationDetails()

getNonRelationshipProperties

public static List<String> getNonRelationshipProperties()

getStringProperties

public static List<String> getStringProperties()

getPagedRelationshipProperties

public static List<String> getPagedRelationshipProperties()

getAllProperties

public static List<String> getAllProperties()

isMainObject

public static final Boolean isMainObject(Object obj)