Infoset (IBM Information Governance Catalog REST API Client Library 2.11 API)

java.lang.Object
- org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter
- - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference
  - - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject
    - - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset
      - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.Infoset

```
public class Infoset
extends InformationAsset
```
POJO for the infoset asset type in IGC, displayed as 'InfoSet' in the IGC UI.

(this code has been created 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 String`	`aliasBusinessName`
`protected ItemList<ClassificationContribution>`	`appliedDataClasses`
`protected String`	`composition` Valid values are: MixedLevel (displayed in the UI as 'MixedLevel') TopLevel (displayed in the UI as 'TopLevel')
`protected ItemList<InfosetOperation>`	`contributingOperations`
`protected ItemList<VolumeContribution>`	`contributingVolumes`
`protected Date`	`created`
`protected InfosetOperation`	`createdWith`
`protected String`	`creator`
`protected Instance`	`instance`
`protected Number`	`objectCount`
`protected Number`	`size`
`protected String`	`syncState`
`protected String`	`syncType` Valid values are: Regular (displayed in the UI as 'Regular') InferredPartial (displayed in the UI as 'Inferred Partial') InferredFull (displayed in the UI as 'Inferred Full')
`protected String`	`toolId`
`protected String`	`type` Valid values are: User (displayed in the UI as 'User') System (displayed in the UI as 'System')
`protected String`	`url`

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset
blueprintElements, impactedBy, impactsOn, inCollections, nativeId, readByDesign, readByOperational, readByStatic, readByUserDefined, writtenByDesign, writtenByOperational, writtenByStatic, writtenByUserDefined

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject
assignedToTerms, governedByRules, implementsRules, labels, longDescription, name, shortDescription, stewards

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference
_context, _id, _name, _type, _url, createdBy, createdOn, modifiedBy, modifiedOn, notes

Constructor Summary

Constructors
Constructor and Description

Infoset()

Constructors
Constructor and Description
`Infoset()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAliasBusinessName()` Retrieve the `alias_(business_name)` property (displayed as 'Alias (Business Name)') of the object.
`ItemList<ClassificationContribution>`	`getAppliedDataClasses()` Retrieve the `applied_data_classes` property (displayed as 'Data Classifications') of the object.
`String`	`getComposition()` Retrieve the `composition` property (displayed as 'Composition') of the object.
`ItemList<InfosetOperation>`	`getContributingOperations()` Retrieve the `contributing_operations` property (displayed as 'Applied Operations') of the object.
`ItemList<VolumeContribution>`	`getContributingVolumes()` Retrieve the `contributing_volumes` property (displayed as 'Volumes') of the object.
`Date`	`getCreated()` Retrieve the `created` property (displayed as 'Created') of the object.
`InfosetOperation`	`getCreatedWith()` Retrieve the `created_with` property (displayed as 'Originating Operation') of the object.
`String`	`getCreator()` Retrieve the `creator` property (displayed as 'Creator') of the object.
`Instance`	`getInstance()` Retrieve the `instance` property (displayed as 'Instance') of the object.
`Number`	`getObjectCount()` Retrieve the `object_count` property (displayed as 'Number of Objects') of the object.
`Number`	`getSize()` Retrieve the `size` property (displayed as 'Size (Bytes)') of the object.
`String`	`getSyncState()` Retrieve the `sync_state` property (displayed as 'State') of the object.
`String`	`getSyncType()` Retrieve the `sync_type` property (displayed as 'Include For Governance') of the object.
`String`	`getTheType()` Retrieve the `type` property (displayed as 'Type') of the object.
`String`	`getTheUrl()` Retrieve the `url` property (displayed as 'URL') of the object.
`String`	`getToolId()` Retrieve the `tool_id` property (displayed as 'Tool ID') of the object.
`void`	`setAliasBusinessName(String aliasBusinessName)` Set the `alias_(business_name)` property (displayed as `Alias (Business Name)`) of the object.
`void`	`setAppliedDataClasses(ItemList<ClassificationContribution> appliedDataClasses)` Set the `applied_data_classes` property (displayed as `Data Classifications`) of the object.
`void`	`setComposition(String composition)` Set the `composition` property (displayed as `Composition`) of the object.
`void`	`setContributingOperations(ItemList<InfosetOperation> contributingOperations)` Set the `contributing_operations` property (displayed as `Applied Operations`) of the object.
`void`	`setContributingVolumes(ItemList<VolumeContribution> contributingVolumes)` Set the `contributing_volumes` property (displayed as `Volumes`) of the object.
`void`	`setCreated(Date created)` Set the `created` property (displayed as `Created`) of the object.
`void`	`setCreatedWith(InfosetOperation createdWith)` Set the `created_with` property (displayed as `Originating Operation`) of the object.
`void`	`setCreator(String creator)` Set the `creator` property (displayed as `Creator`) of the object.
`void`	`setInstance(Instance instance)` Set the `instance` property (displayed as `Instance`) of the object.
`void`	`setObjectCount(Number objectCount)` Set the `object_count` property (displayed as `Number of Objects`) of the object.
`void`	`setSize(Number size)` Set the `size` property (displayed as `Size (Bytes)`) of the object.
`void`	`setSyncState(String syncState)` Set the `sync_state` property (displayed as `State`) of the object.
`void`	`setSyncType(String syncType)` Set the `sync_type` property (displayed as `Include For Governance`) of the object.
`void`	`setTheType(String type)` Set the `type` property (displayed as `Type`) of the object.
`void`	`setTheUrl(String url)` Set the `url` property (displayed as `URL`) of the object.
`void`	`setToolId(String toolId)` Set the `tool_id` property (displayed as `Tool ID`) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset
getBlueprintElements, getImpactedBy, getImpactsOn, getInCollections, getNativeId, getReadByDesign, getReadByOperational, getReadByStatic, getReadByUserDefined, getWrittenByDesign, getWrittenByOperational, getWrittenByStatic, getWrittenByUserDefined, setBlueprintElements, setImpactedBy, setImpactsOn, setInCollections, setNativeId, setReadByDesign, setReadByOperational, setReadByStatic, setReadByUserDefined, setWrittenByDesign, setWrittenByOperational, setWrittenByStatic, setWrittenByUserDefined

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject
getAssignedToTerms, getGovernedByRules, getImplementsRules, getLabels, getLongDescription, getShortDescription, getStewards, getTheName, setAssignedToTerms, setGovernedByRules, setImplementsRules, setLabels, setLongDescription, setShortDescription, setStewards, setTheName

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference
areModificationDetailsPopulated, getContext, getCreatedBy, getCreatedOn, getId, getIdentity, getModifiedBy, getModifiedOn, getName, getNotes, getType, getUrl, isEmbeddedAsset, isFullyRetrieved, isIdentityPopulated, isSimpleType, isVirtualAsset, setContext, setCreatedBy, setCreatedOn, setFullyRetrieved, setId, setModifiedBy, setModifiedOn, setName, setNotes, setType, setUrl

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - aliasBusinessName
```
protected String aliasBusinessName
```
  - appliedDataClasses
```
protected ItemList<ClassificationContribution> appliedDataClasses
```
  - composition
```
protected String composition
```
    Valid values are:
    - MixedLevel (displayed in the UI as 'MixedLevel')
    - TopLevel (displayed in the UI as 'TopLevel')
  - contributingOperations
```
protected ItemList<InfosetOperation> contributingOperations
```
  - contributingVolumes
```
protected ItemList<VolumeContribution> contributingVolumes
```
  - created
```
protected Date created
```
  - createdWith
```
protected InfosetOperation createdWith
```
  - creator
```
protected String creator
```
  - instance
```
protected Instance instance
```
  - objectCount
```
protected Number objectCount
```
  - size
```
protected Number size
```
  - syncState
```
protected String syncState
```
  - syncType
```
protected String syncType
```
    Valid values are:
    - Regular (displayed in the UI as 'Regular')
    - InferredPartial (displayed in the UI as 'Inferred Partial')
    - InferredFull (displayed in the UI as 'Inferred Full')
  - toolId
```
protected String toolId
```
  - type
```
protected String type
```
    Valid values are:
    - User (displayed in the UI as 'User')
    - System (displayed in the UI as 'System')
  - url
```
protected String url
```
- Constructor Detail
  - Infoset
```
public Infoset()
```
- Method Detail
  - getAliasBusinessName
```
public String getAliasBusinessName()
```
    Retrieve the alias_(business_name) property (displayed as 'Alias (Business Name)') of the object.
    
    Returns:
    
    String
  - setAliasBusinessName
```
public void setAliasBusinessName(String aliasBusinessName)
```
    Set the alias_(business_name) property (displayed as Alias (Business Name)) of the object.
    
    Parameters:
    
    aliasBusinessName - the value to set
  - getAppliedDataClasses
```
public ItemList<ClassificationContribution> getAppliedDataClasses()
```
    Retrieve the applied_data_classes property (displayed as 'Data Classifications') of the object.
    
    Returns:
    
    ItemList<ClassificationContribution>
  - setAppliedDataClasses
```
public void setAppliedDataClasses(ItemList<ClassificationContribution> appliedDataClasses)
```
    Set the applied_data_classes property (displayed as Data Classifications) of the object.
    
    Parameters:
    
    appliedDataClasses - the value to set
  - getComposition
```
public String getComposition()
```
    Retrieve the composition property (displayed as 'Composition') of the object.
    
    Returns:
    
    String
  - setComposition
```
public void setComposition(String composition)
```
    Set the composition property (displayed as Composition) of the object.
    
    Parameters:
    
    composition - the value to set
  - getContributingOperations
```
public ItemList<InfosetOperation> getContributingOperations()
```
    Retrieve the contributing_operations property (displayed as 'Applied Operations') of the object.
    
    Returns:
    
    ItemList<InfosetOperation>
  - setContributingOperations
```
public void setContributingOperations(ItemList<InfosetOperation> contributingOperations)
```
    Set the contributing_operations property (displayed as Applied Operations) of the object.
    
    Parameters:
    
    contributingOperations - the value to set
  - getContributingVolumes
```
public ItemList<VolumeContribution> getContributingVolumes()
```
    Retrieve the contributing_volumes property (displayed as 'Volumes') of the object.
    
    Returns:
    
    ItemList<VolumeContribution>
  - setContributingVolumes
```
public void setContributingVolumes(ItemList<VolumeContribution> contributingVolumes)
```
    Set the contributing_volumes property (displayed as Volumes) of the object.
    
    Parameters:
    
    contributingVolumes - the value to set
  - getCreated
```
public Date getCreated()
```
    Retrieve the created property (displayed as 'Created') of the object.
    
    Returns:
    
    Date
  - setCreated
```
public void setCreated(Date created)
```
    Set the created property (displayed as Created) of the object.
    
    Parameters:
    
    created - the value to set
  - getCreatedWith
```
public InfosetOperation getCreatedWith()
```
    Retrieve the created_with property (displayed as 'Originating Operation') of the object.
    
    Returns:
    
    InfosetOperation
  - setCreatedWith
```
public void setCreatedWith(InfosetOperation createdWith)
```
    Set the created_with property (displayed as Originating Operation) of the object.
    
    Parameters:
    
    createdWith - the value to set
  - getCreator
```
public String getCreator()
```
    Retrieve the creator property (displayed as 'Creator') of the object.
    
    Returns:
    
    String
  - setCreator
```
public void setCreator(String creator)
```
    Set the creator property (displayed as Creator) of the object.
    
    Parameters:
    
    creator - the value to set
  - getInstance
```
public Instance getInstance()
```
    Retrieve the instance property (displayed as 'Instance') of the object.
    
    Returns:
    
    Instance
  - setInstance
```
public void setInstance(Instance instance)
```
    Set the instance property (displayed as Instance) of the object.
    
    Parameters:
    
    instance - the value to set
  - getObjectCount
```
public Number getObjectCount()
```
    Retrieve the object_count property (displayed as 'Number of Objects') of the object.
    
    Returns:
    
    Number
  - setObjectCount
```
public void setObjectCount(Number objectCount)
```
    Set the object_count property (displayed as Number of Objects) of the object.
    
    Parameters:
    
    objectCount - the value to set
  - getSize
```
public Number getSize()
```
    Retrieve the size property (displayed as 'Size (Bytes)') of the object.
    
    Returns:
    
    Number
  - setSize
```
public void setSize(Number size)
```
    Set the size property (displayed as Size (Bytes)) of the object.
    
    Parameters:
    
    size - the value to set
  - getSyncState
```
public String getSyncState()
```
    Retrieve the sync_state property (displayed as 'State') of the object.
    
    Returns:
    
    String
  - setSyncState
```
public void setSyncState(String syncState)
```
    Set the sync_state property (displayed as State) of the object.
    
    Parameters:
    
    syncState - the value to set
  - getSyncType
```
public String getSyncType()
```
    Retrieve the sync_type property (displayed as 'Include For Governance') of the object.
    
    Returns:
    
    String
  - setSyncType
```
public void setSyncType(String syncType)
```
    Set the sync_type property (displayed as Include For Governance) of the object.
    
    Parameters:
    
    syncType - the value to set
  - getToolId
```
public String getToolId()
```
    Retrieve the tool_id property (displayed as 'Tool ID') of the object.
    
    Returns:
    
    String
  - setToolId
```
public void setToolId(String toolId)
```
    Set the tool_id property (displayed as Tool ID) of the object.
    
    Parameters:
    
    toolId - the value to set
  - getTheType
```
public String getTheType()
```
    Retrieve the type property (displayed as 'Type') of the object.
    
    Returns:
    
    String
  - setTheType
```
public void setTheType(String type)
```
    Set the type property (displayed as Type) of the object.
    
    Parameters:
    
    type - the value to set
  - getTheUrl
```
public String getTheUrl()
```
    Retrieve the url property (displayed as 'URL') of the object.
    
    Returns:
    
    String
  - setTheUrl
```
public void setTheUrl(String url)
```
    Set the url property (displayed as URL) of the object.
    
    Parameters:
    
    url - the value to set

Class Infoset

Field Summary

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

Constructor Summary

Method Summary

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

Methods inherited from class java.lang.Object

Field Detail

aliasBusinessName

appliedDataClasses

composition

contributingOperations

contributingVolumes

created

createdWith

creator

instance

objectCount

size

syncState

syncType

toolId

type

url

Constructor Detail

Infoset

Method Detail

getAliasBusinessName

setAliasBusinessName

getAppliedDataClasses

setAppliedDataClasses

getComposition

setComposition

getContributingOperations

setContributingOperations

getContributingVolumes

setContributingVolumes

getCreated

setCreated

getCreatedWith

setCreatedWith

getCreator

setCreator

getInstance

setInstance

getObjectCount

setObjectCount

getSize

setSize

getSyncState

setSyncState

getSyncType

setSyncType

getToolId

setToolId

getTheType

setTheType

getTheUrl

setTheUrl