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

```
public class LogicalVariable
extends Reference
```
POJO for the logical_variable asset type in IGC, displayed as 'Logical Variable' 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`	`binding` The `binding` property, displayed as 'Binding' 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 String`	`data_type` The `data_type` property, displayed as 'Data Type' 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___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.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected String`	`type` The `type` property, displayed as 'Example' 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

LogicalVariable()

Constructors
Constructor and Description
`LogicalVariable()`

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`	`getBinding()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`String`	`getDataType()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getShortDescription()`
`String`	`getShortLongDescription()`
`String`	`getStatus()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`String`	`getTheType()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isLogicalVariable(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setBinding(ReferenceList binding)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataType(String data_type)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setShortDescription(String short_description)`
`void`	`setShortLongDescription(String short___long_description)`
`void`	`setStatus(String status)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setTheType(String type)`

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.
  - 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')
  - 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.
  - binding
```
protected ReferenceList binding
```
    The binding property, displayed as 'Binding' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - data_type
```
protected String data_type
```
    The data_type property, displayed as 'Data Type' in the IGC UI.
    
    Can be one of the following values:
    - INTEGER (displayed in the UI as 'INTEGER')
    - FLOAT (displayed in the UI as 'FLOAT')
    - NUMBER (displayed in the UI as 'NUMBER')
    - FIXED_STRING (displayed in the UI as 'FIXED_STRING')
    - VARIABLE_STRING (displayed in the UI as 'VARIABLE_STRING')
    - STRING (displayed in the UI as 'STRING')
    - DATE (displayed in the UI as 'DATE')
    - TIME (displayed in the UI as 'TIME')
    - DATETIME (displayed in the UI as 'DATETIME')
    - ANY (displayed in the UI as 'ANY')
  - type
```
protected String type
```
    The type property, displayed as 'Example' 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
  - LogicalVariable
```
public LogicalVariable()
```
- 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
  - getStatus
```
public String getStatus()
```
    See Also:
    
    status
  - setStatus
```
public void setStatus(String status)
```
    See Also:
    
    status
  - 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
  - getBinding
```
public ReferenceList getBinding()
```
    See Also:
    
    binding
  - setBinding
```
public void setBinding(ReferenceList binding)
```
    See Also:
    
    binding
  - getDataType
```
public String getDataType()
```
    See Also:
    
    data_type
  - setDataType
```
public void setDataType(String data_type)
```
    See Also:
    
    data_type
  - getTheType
```
public String getTheType()
```
    See Also:
    
    type
  - setTheType
```
public void setTheType(String type)
```
    See Also:
    
    type
  - 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()
```
  - isLogicalVariable
```
public static Boolean isLogicalVariable(Object obj)
```

Class LogicalVariable

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

status

stewards

assigned_to_terms

binding

data_type

type

created_by

created_on

modified_by

modified_on

Constructor Detail

LogicalVariable

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortLongDescription

setShortLongDescription

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getStatus

setStatus

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getBinding

setBinding

getDataType

setDataType

getTheType

setTheType

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties

isLogicalVariable