SubjectArea (IBM Information Governance Catalog REST API Client Library 1.0 API)

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.generated.v11501.SubjectArea

```
public class SubjectArea
extends Reference
```
POJO for the subject_area asset type in IGC, displayed as 'Subject Area' in the IGC UI.

(this code has been generated 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 ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' in the IGC UI.
`protected String`	`author` The `author` property, displayed as 'Author' in the IGC UI.
`protected ArrayList<String>`	`comments` The `comments` property, displayed as 'Comments' 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 String`	`imported_from` The `imported_from` property, displayed as 'Imported From' in the IGC UI.
`protected ReferenceList`	`in_collections` The `in_collections` property, displayed as 'In Collections' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected Reference`	`logical_data_model` The `logical_data_model` property, displayed as 'Logical Data Model' in the IGC UI.
`protected ReferenceList`	`logical_entities` The `logical_entities` property, displayed as 'Logical Entities' 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

SubjectArea()

Constructors
Constructor and Description
`SubjectArea()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getAuthor()`
`ArrayList<String>`	`getComments()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`String`	`getImportedFrom()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`Reference`	`getLogicalDataModel()`
`ReferenceList`	`getLogicalEntities()`
`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`	`isSubjectArea(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setAuthor(String author)`
`void`	`setComments(ArrayList<String> comments)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setImportedFrom(String imported_from)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLogicalDataModel(Reference logical_data_model)`
`void`	`setLogicalEntities(ReferenceList logical_entities)`
`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.
  - 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.
  - logical_data_model
```
protected Reference logical_data_model
```
    The logical_data_model property, displayed as 'Logical Data Model' in the IGC UI.
    
    Will be a single Reference to a LogicalDataModel object.
  - 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 AsclSteward 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.
  - logical_entities
```
protected ReferenceList logical_entities
```
    The logical_entities property, displayed as 'Logical Entities' in the IGC UI.
    
    Will be a ReferenceList of LogicalEntity objects.
  - author
```
protected String author
```
    The author property, displayed as 'Author' in the IGC UI.
  - comments
```
protected ArrayList<String> comments
```
    The comments property, displayed as 'Comments' in the IGC UI.
  - imported_from
```
protected String imported_from
```
    The imported_from property, displayed as 'Imported From' in the IGC UI.
  - in_collections
```
protected ReferenceList in_collections
```
    The in_collections property, displayed as 'In Collections' in the IGC UI.
    
    Will be a ReferenceList of Collection objects.
  - created_by
```
protected String created_by
```
    The created_by property, displayed as 'Created By' in the IGC UI.
  - created_on
```
protected Date created_on
```
    The created_on property, displayed as 'Created On' in the IGC UI.
  - modified_by
```
protected String modified_by
```
    The modified_by property, displayed as 'Modified By' in the IGC UI.
  - modified_on
```
protected Date modified_on
```
    The modified_on property, displayed as 'Modified On' in the IGC UI.
- Constructor Detail
  - SubjectArea
```
public SubjectArea()
```
- 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
  - getLogicalDataModel
```
public Reference getLogicalDataModel()
```
    See Also:
    
    logical_data_model
  - setLogicalDataModel
```
public void setLogicalDataModel(Reference logical_data_model)
```
    See Also:
    
    logical_data_model
  - 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
  - getLogicalEntities
```
public ReferenceList getLogicalEntities()
```
    See Also:
    
    logical_entities
  - setLogicalEntities
```
public void setLogicalEntities(ReferenceList logical_entities)
```
    See Also:
    
    logical_entities
  - getAuthor
```
public String getAuthor()
```
    See Also:
    
    author
  - setAuthor
```
public void setAuthor(String author)
```
    See Also:
    
    author
  - getComments
```
public ArrayList<String> getComments()
```
    See Also:
    
    comments
  - setComments
```
public void setComments(ArrayList<String> comments)
```
    See Also:
    
    comments
  - getImportedFrom
```
public String getImportedFrom()
```
    See Also:
    
    imported_from
  - setImportedFrom
```
public void setImportedFrom(String imported_from)
```
    See Also:
    
    imported_from
  - getInCollections
```
public ReferenceList getInCollections()
```
    See Also:
    
    in_collections
  - setInCollections
```
public void setInCollections(ReferenceList in_collections)
```
    See Also:
    
    in_collections
  - 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()
```
  - isSubjectArea
```
public static Boolean isSubjectArea(Object obj)
```

Class SubjectArea

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

name

short_description

long_description

logical_data_model

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

logical_entities

author

comments

imported_from

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

SubjectArea

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLogicalDataModel

setLogicalDataModel

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getLogicalEntities

setLogicalEntities

getAuthor

setAuthor

getComments

setComments

getImportedFrom

setImportedFrom

getInCollections

setInCollections

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties

isSubjectArea