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

```
public class InvDataRuleSetDefinition
extends Reference
```
POJO for the inv_data_rule_set_definition asset type in IGC, displayed as 'Data Rule Set Definition' 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`	`contact` The `contact` property, displayed as 'Contact' 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`	`data_rule_definitions` The `data_rule_definitions` property, displayed as 'Data Rule Definitions' in the IGC UI.
`protected ReferenceList`	`data_rule_sets` The `data_rule_sets` property, displayed as 'Data Rule Sets' 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`	`project` The `project` property, displayed as 'Project' in the IGC UI.
`protected Boolean`	`published` The `published` property, displayed as 'Published' in the IGC UI.
`protected String`	`short___long_description` The `short_&_long_description` property, displayed as 'Short & Long Description' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected String`	`status` The `status` property, displayed as 'Status' 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

InvDataRuleSetDefinition()

Constructors
Constructor and Description
`InvDataRuleSetDefinition()`

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`	`getContact()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getDataRuleDefinitions()`
`ReferenceList`	`getDataRuleSets()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getProject()`
`Boolean`	`getPublished()`
`String`	`getShortDescription()`
`String`	`getShortLongDescription()`
`String`	`getStatus()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isInvDataRuleSetDefinition(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setContact(ReferenceList contact)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataRuleDefinitions(ReferenceList data_rule_definitions)`
`void`	`setDataRuleSets(ReferenceList data_rule_sets)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setProject(String project)`
`void`	`setPublished(Boolean published)`
`void`	`setShortDescription(String short_description)`
`void`	`setShortLongDescription(String short___long_description)`
`void`	`setStatus(String status)`
`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___long_description
```
protected String short___long_description
```
    The short_&_long_description property, displayed as 'Short & Long Description' 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.
  - project
```
protected String project
```
    The project property, displayed as 'Project' in the IGC UI.
  - status
```
protected String status
```
    The status property, displayed as 'Status' in the IGC UI.
    
    Can be one of the following values:
    - 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')
    - DRAFT (displayed in the UI as 'DRAFT')
    - IN_PROCESS (displayed in the UI as 'IN_PROCESS')
    - REJECTED (displayed in the UI as 'REJECTED')
    - ERROR (displayed in the UI as 'ERROR')
  - contact
```
protected ReferenceList contact
```
    The contact property, displayed as 'Contact' 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.
  - data_rule_definitions
```
protected ReferenceList data_rule_definitions
```
    The data_rule_definitions property, displayed as 'Data Rule Definitions' in the IGC UI.
    
    Will be a ReferenceList of MainObject objects.
  - data_rule_sets
```
protected ReferenceList data_rule_sets
```
    The data_rule_sets property, displayed as 'Data Rule Sets' in the IGC UI.
    
    Will be a ReferenceList of MainObject objects.
  - published
```
protected Boolean published
```
    The published property, displayed as 'Published' in the IGC UI.
  - 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
  - InvDataRuleSetDefinition
```
public InvDataRuleSetDefinition()
```
- 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
  - getShortLongDescription
```
public String getShortLongDescription()
```
    See Also:
    
    short___long_description
  - setShortLongDescription
```
public void setShortLongDescription(String short___long_description)
```
    See Also:
    
    short___long_description
  - 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
  - getProject
```
public String getProject()
```
    See Also:
    
    project
  - setProject
```
public void setProject(String project)
```
    See Also:
    
    project
  - getStatus
```
public String getStatus()
```
    See Also:
    
    status
  - setStatus
```
public void setStatus(String status)
```
    See Also:
    
    status
  - getContact
```
public ReferenceList getContact()
```
    See Also:
    
    contact
  - setContact
```
public void setContact(ReferenceList contact)
```
    See Also:
    
    contact
  - getAssignedToTerms
```
public ReferenceList getAssignedToTerms()
```
    See Also:
    
    assigned_to_terms
  - setAssignedToTerms
```
public void setAssignedToTerms(ReferenceList assigned_to_terms)
```
    See Also:
    
    assigned_to_terms
  - getDataRuleDefinitions
```
public ReferenceList getDataRuleDefinitions()
```
    See Also:
    
    data_rule_definitions
  - setDataRuleDefinitions
```
public void setDataRuleDefinitions(ReferenceList data_rule_definitions)
```
    See Also:
    
    data_rule_definitions
  - getDataRuleSets
```
public ReferenceList getDataRuleSets()
```
    See Also:
    
    data_rule_sets
  - setDataRuleSets
```
public void setDataRuleSets(ReferenceList data_rule_sets)
```
    See Also:
    
    data_rule_sets
  - getPublished
```
public Boolean getPublished()
```
    See Also:
    
    published
  - setPublished
```
public void setPublished(Boolean published)
```
    See Also:
    
    published
  - 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()
```
  - isInvDataRuleSetDefinition
```
public static Boolean isInvDataRuleSetDefinition(Object obj)
```

Class InvDataRuleSetDefinition

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___long_description

short_description

long_description

project

status

contact

assigned_to_terms

data_rule_definitions

data_rule_sets

published

created_by

created_on

modified_by

modified_on

Constructor Detail

InvDataRuleSetDefinition

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortLongDescription

setShortLongDescription

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getProject

setProject

getStatus

setStatus

getContact

setContact

getAssignedToTerms

setAssignedToTerms

getDataRuleDefinitions

setDataRuleDefinitions

getDataRuleSets

setDataRuleSets

getPublished

setPublished

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties

isInvDataRuleSetDefinition