SystemRole (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.SystemRole

```
public class SystemRole
extends Reference
```
POJO for the system_role asset type in IGC, displayed as 'System Role' 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 ReferenceList`	`defines_role_assignment` The `defines_role_assignment` property, displayed as 'Defines Role Assignment' 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`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected ReferenceList`	`of_acl_entry` The `of_acl_entry` property, displayed as 'Of Acl Entry' in the IGC UI.
`protected ReferenceList`	`of_principal` The `of_principal` property, displayed as 'Of Principal' in the IGC UI.
`protected String`	`product` The `product` property, displayed as 'Product' in the IGC UI.
`protected String`	`role_id` The `role_id` property, displayed as 'Role Id' in the IGC UI.
`protected String`	`role_type` The `role_type` property, displayed as 'Role Type' 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

SystemRole()

Constructors
Constructor and Description
`SystemRole()`

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()`
`ReferenceList`	`getDefinesRoleAssignment()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getLabels()`
`String`	`getLongDescription()`
`static List<String>`	`getNonRelationshipProperties()`
`ReferenceList`	`getOfAclEntry()`
`ReferenceList`	`getOfPrincipal()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getProduct()`
`String`	`getRoleId()`
`String`	`getRoleType()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isSystemRole(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setDefinesRoleAssignment(ReferenceList defines_role_assignment)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLongDescription(String long_description)`
`void`	`setOfAclEntry(ReferenceList of_acl_entry)`
`void`	`setOfPrincipal(ReferenceList of_principal)`
`void`	`setProduct(String product)`
`void`	`setRoleId(String role_id)`
`void`	`setRoleType(String role_type)`
`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.
  - 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.
  - product
```
protected String product
```
    The product property, displayed as 'Product' in the IGC UI.
    
    Can be one of the following values:
    - ASB (displayed in the UI as 'ASB')
    - DATASTAGE (displayed in the UI as 'DATASTAGE')
    - SORCERER (displayed in the UI as 'SORCERER')
    - SOA (displayed in the UI as 'SOA')
    - ENTERPRISE_MANAGER (displayed in the UI as 'ENTERPRISE_MANAGER')
    - OTHER (displayed in the UI as 'OTHER')
    - GLOSSARY (displayed in the UI as 'GLOSSARY')
    - OMD (displayed in the UI as 'OMD')
    - WISD (displayed in the UI as 'WISD')
  - of_principal
```
protected ReferenceList of_principal
```
    The of_principal property, displayed as 'Of Principal' in the IGC UI.
    
    Will be a ReferenceList of Steward objects.
  - of_acl_entry
```
protected ReferenceList of_acl_entry
```
    The of_acl_entry property, displayed as 'Of Acl Entry' in the IGC UI.
    
    Will be a ReferenceList of Aclentry objects.
  - role_type
```
protected String role_type
```
    The role_type property, displayed as 'Role Type' in the IGC UI.
    
    Can be one of the following values:
    - SUITE (displayed in the UI as 'SUITE')
    - PRODUCT (displayed in the UI as 'PRODUCT')
    - PROJECT (displayed in the UI as 'PROJECT')
  - role_id
```
protected String role_id
```
    The role_id property, displayed as 'Role Id' in the IGC UI.
  - defines_role_assignment
```
protected ReferenceList defines_role_assignment
```
    The defines_role_assignment property, displayed as 'Defines Role Assignment' in the IGC UI.
    
    Will be a ReferenceList of RoleAssignment objects.
- Constructor Detail
  - SystemRole
```
public SystemRole()
```
- 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
  - getProduct
```
public String getProduct()
```
    See Also:
    
    product
  - setProduct
```
public void setProduct(String product)
```
    See Also:
    
    product
  - getOfPrincipal
```
public ReferenceList getOfPrincipal()
```
    See Also:
    
    of_principal
  - setOfPrincipal
```
public void setOfPrincipal(ReferenceList of_principal)
```
    See Also:
    
    of_principal
  - getOfAclEntry
```
public ReferenceList getOfAclEntry()
```
    See Also:
    
    of_acl_entry
  - setOfAclEntry
```
public void setOfAclEntry(ReferenceList of_acl_entry)
```
    See Also:
    
    of_acl_entry
  - getRoleType
```
public String getRoleType()
```
    See Also:
    
    role_type
  - setRoleType
```
public void setRoleType(String role_type)
```
    See Also:
    
    role_type
  - getRoleId
```
public String getRoleId()
```
    See Also:
    
    role_id
  - setRoleId
```
public void setRoleId(String role_id)
```
    See Also:
    
    role_id
  - getDefinesRoleAssignment
```
public ReferenceList getDefinesRoleAssignment()
```
    See Also:
    
    defines_role_assignment
  - setDefinesRoleAssignment
```
public void setDefinesRoleAssignment(ReferenceList defines_role_assignment)
```
    See Also:
    
    defines_role_assignment
  - 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()
```
  - isSystemRole
```
public static Boolean isSystemRole(Object obj)
```

Class SystemRole

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

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

product

of_principal

of_acl_entry

role_type

role_id

defines_role_assignment

Constructor Detail

SystemRole

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getProduct

setProduct

getOfPrincipal

setOfPrincipal

getOfAclEntry

setOfAclEntry

getRoleType

setRoleType

getRoleId

setRoleId

getDefinesRoleAssignment

setDefinesRoleAssignment

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties

isSystemRole