DataRule (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.v11502sp3.DataRule

```
public class DataRule
extends Reference
```
POJO for the data_rule asset type in IGC, displayed as 'Data Rule' 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 ArrayList<String>`	`benchmark` The `benchmark` property, displayed as 'Benchmark' 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_policies` The `data_policies` property, displayed as 'Data Policies' in the IGC UI.
`protected Reference`	`data_rule_definitions` The `data_rule_definitions` property, displayed as 'Data Rule Definitions' in the IGC UI.
`protected ReferenceList`	`execution_history` The `execution_history` property, displayed as 'Execution History' in the IGC UI.
`protected ArrayList<String>`	`expression` The `expression` property, displayed as 'Expression' 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`	`implemented_bindings` The `implemented_bindings` property, displayed as 'Implemented Bindings' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' 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 String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected ReferenceList`	`metrics` The `metrics` property, displayed as 'Metrics' 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 ArrayList<String>`	`project` The `project` property, displayed as 'Project' 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.
`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

DataRule()

Constructors
Constructor and Description
`DataRule()`

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()`
`ArrayList<String>`	`getBenchmark()`
`ReferenceList`	`getContact()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getDataPolicies()`
`Reference`	`getDataRuleDefinitions()`
`ReferenceList`	`getExecutionHistory()`
`ArrayList<String>`	`getExpression()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementedBindings()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`String`	`getLongDescription()`
`ReferenceList`	`getMetrics()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`ArrayList<String>`	`getProject()`
`String`	`getShortDescription()`
`String`	`getStatus()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isDataRule(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setBenchmark(ArrayList<String> benchmark)`
`void`	`setContact(ReferenceList contact)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataPolicies(ReferenceList data_policies)`
`void`	`setDataRuleDefinitions(Reference data_rule_definitions)`
`void`	`setExecutionHistory(ReferenceList execution_history)`
`void`	`setExpression(ArrayList<String> expression)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementedBindings(ReferenceList implemented_bindings)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLongDescription(String long_description)`
`void`	`setMetrics(ReferenceList metrics)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setProject(ArrayList<String> project)`
`void`	`setShortDescription(String short_description)`
`void`	`setStatus(String status)`
`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.
  - implemented_bindings
```
protected ReferenceList implemented_bindings
```
    The implemented_bindings property, displayed as 'Implemented Bindings' in the IGC UI.
    
    Will be a ReferenceList of DataItem objects.
  - data_rule_definitions
```
protected Reference data_rule_definitions
```
    The data_rule_definitions property, displayed as 'Data Rule Definitions' in the IGC UI.
    
    Will be a single Reference to a NonPublishedDataRuleDefinition object.
  - project
```
protected ArrayList<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')
  - expression
```
protected ArrayList<String> expression
```
    The expression property, displayed as 'Expression' in the IGC UI.
  - contact
```
protected ReferenceList contact
```
    The contact property, displayed as 'Contact' in the IGC UI.
    
    Will be a ReferenceList of Steward objects.
  - metrics
```
protected ReferenceList metrics
```
    The metrics property, displayed as 'Metrics' in the IGC UI.
    
    Will be a ReferenceList of Metric objects.
  - benchmark
```
protected ArrayList<String> benchmark
```
    The benchmark property, displayed as 'Benchmark' in the IGC UI.
  - execution_history
```
protected ReferenceList execution_history
```
    The execution_history property, displayed as 'Execution History' in the IGC UI.
    
    Will be a ReferenceList of DataRuleResults objects.
  - data_policies
```
protected ReferenceList data_policies
```
    The data_policies property, displayed as 'Data Policies' in the IGC UI.
    
    Will be a ReferenceList of DataPolicy objects.
  - 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
  - DataRule
```
public DataRule()
```
- 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
  - getImplementedBindings
```
public ReferenceList getImplementedBindings()
```
    See Also:
    
    implemented_bindings
  - setImplementedBindings
```
public void setImplementedBindings(ReferenceList implemented_bindings)
```
    See Also:
    
    implemented_bindings
  - getDataRuleDefinitions
```
public Reference getDataRuleDefinitions()
```
    See Also:
    
    data_rule_definitions
  - setDataRuleDefinitions
```
public void setDataRuleDefinitions(Reference data_rule_definitions)
```
    See Also:
    
    data_rule_definitions
  - getProject
```
public ArrayList<String> getProject()
```
    See Also:
    
    project
  - setProject
```
public void setProject(ArrayList<String> project)
```
    See Also:
    
    project
  - getStatus
```
public String getStatus()
```
    See Also:
    
    status
  - setStatus
```
public void setStatus(String status)
```
    See Also:
    
    status
  - getExpression
```
public ArrayList<String> getExpression()
```
    See Also:
    
    expression
  - setExpression
```
public void setExpression(ArrayList<String> expression)
```
    See Also:
    
    expression
  - getContact
```
public ReferenceList getContact()
```
    See Also:
    
    contact
  - setContact
```
public void setContact(ReferenceList contact)
```
    See Also:
    
    contact
  - getMetrics
```
public ReferenceList getMetrics()
```
    See Also:
    
    metrics
  - setMetrics
```
public void setMetrics(ReferenceList metrics)
```
    See Also:
    
    metrics
  - getBenchmark
```
public ArrayList<String> getBenchmark()
```
    See Also:
    
    benchmark
  - setBenchmark
```
public void setBenchmark(ArrayList<String> benchmark)
```
    See Also:
    
    benchmark
  - getExecutionHistory
```
public ReferenceList getExecutionHistory()
```
    See Also:
    
    execution_history
  - setExecutionHistory
```
public void setExecutionHistory(ReferenceList execution_history)
```
    See Also:
    
    execution_history
  - getDataPolicies
```
public ReferenceList getDataPolicies()
```
    See Also:
    
    data_policies
  - setDataPolicies
```
public void setDataPolicies(ReferenceList data_policies)
```
    See Also:
    
    data_policies
  - 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()
```
  - isDataRule
```
public static Boolean isDataRule(Object obj)
```

Class DataRule

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

implemented_bindings

data_rule_definitions

project

status

expression

contact

metrics

benchmark

execution_history

data_policies

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

DataRule

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getImplementedBindings

setImplementedBindings

getDataRuleDefinitions

setDataRuleDefinitions

getProject

setProject

getStatus

setStatus

getExpression

setExpression

getContact

setContact

getMetrics

setMetrics

getBenchmark

setBenchmark

getExecutionHistory

setExecutionHistory

getDataPolicies

setDataPolicies

getInCollections

setInCollections

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy