org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base

Class Volume

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.Volume

public class Volume
extends InformationAsset

POJO for the volume asset type in IGC, displayed as 'Volume' 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	dataServer
protected ItemList<Infoset>	infosets
protected Instance	instance
protected Date	lastHarvested
protected Number	objectCount
protected String	serverName
protected Number	size
protected String	sourceType
protected String	syncState
protected String	toolId
protected String	type Valid values are: Primary (displayed in the UI as 'Primary') Retention (displayed in the UI as 'Retention') Discovery (displayed in the UI as 'Discovery'), 11.7.0.0 only Export (displayed in the UI as 'Export'), 11.7.0.0 only DiscoveryExport (displayed in the UI as 'Discovery Export'), 11.7.0.1 onwards System (displayed in the UI as 'System'), 11.7.0.1 onwards
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
Volume()

Method Summary

Modifier and Type	Method and Description
String	getDataServer() Retrieve the data_server property (displayed as 'Data Server') of the object.
ItemList<Infoset>	getInfosets() Retrieve the infosets property (displayed as 'InfoSets') of the object.
Instance	getInstance() Retrieve the instance property (displayed as 'Instance') of the object.
Date	getLastHarvested() Retrieve the last_harvested property (displayed as 'Last Harvest Date') of the object.
Number	getObjectCount() Retrieve the object_count property (displayed as 'Number of Objects') of the object.
String	getServerName() Retrieve the server_name property (displayed as 'Server') of the object.
Number	getSize() Retrieve the size property (displayed as 'Size (Bytes)') of the object.
String	getSourceType() Retrieve the source_type property (displayed as 'Source Type') of the object.
String	getSyncState() Retrieve the sync_state property (displayed as 'State') 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	setDataServer(String dataServer) Set the data_server property (displayed as Data Server) of the object.
void	setInfosets(ItemList<Infoset> infosets) Set the infosets property (displayed as InfoSets) of the object.
void	setInstance(Instance instance) Set the instance property (displayed as Instance) of the object.
void	setLastHarvested(Date lastHarvested) Set the last_harvested property (displayed as Last Harvest Date) of the object.
void	setObjectCount(Number objectCount) Set the object_count property (displayed as Number of Objects) of the object.
void	setServerName(String serverName) Set the server_name property (displayed as Server) of the object.
void	setSize(Number size) Set the size property (displayed as Size (Bytes)) of the object.
void	setSourceType(String sourceType) Set the source_type property (displayed as Source Type) of the object.
void	setSyncState(String syncState) Set the sync_state property (displayed as State) 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

dataServer

protected String dataServer

infosets

protected ItemList<Infoset> infosets

instance

protected Instance instance

lastHarvested

protected Date lastHarvested

objectCount

protected Number objectCount

serverName

protected String serverName

size

protected Number size

sourceType

protected String sourceType

syncState

protected String syncState

toolId

protected String toolId

type

protected String type

Valid values are:

• Primary (displayed in the UI as 'Primary')
• Retention (displayed in the UI as 'Retention')
• Discovery (displayed in the UI as 'Discovery'), 11.7.0.0 only
• Export (displayed in the UI as 'Export'), 11.7.0.0 only
• DiscoveryExport (displayed in the UI as 'Discovery Export'), 11.7.0.1 onwards
• System (displayed in the UI as 'System'), 11.7.0.1 onwards

url

protected String url

Constructor Detail

Volume

public Volume()

Method Detail

getDataServer

public String getDataServer()

Retrieve the data_server property (displayed as 'Data Server') of the object.

Returns:

String

setDataServer

public void setDataServer(String dataServer)

Set the data_server property (displayed as Data Server) of the object.

Parameters:

dataServer - the value to set

getInfosets

public ItemList<Infoset> getInfosets()

Retrieve the infosets property (displayed as 'InfoSets') of the object.

Returns:

ItemList<Infoset>

setInfosets

public void setInfosets(ItemList<Infoset> infosets)

Set the infosets property (displayed as InfoSets) of the object.

Parameters:

infosets - 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

getLastHarvested

public Date getLastHarvested()

Retrieve the last_harvested property (displayed as 'Last Harvest Date') of the object.

Returns:

Date

setLastHarvested

public void setLastHarvested(Date lastHarvested)

Set the last_harvested property (displayed as Last Harvest Date) of the object.

Parameters:

lastHarvested - 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

getServerName

public String getServerName()

Retrieve the server_name property (displayed as 'Server') of the object.

Returns:

String

setServerName

public void setServerName(String serverName)

Set the server_name property (displayed as Server) of the object.

Parameters:

serverName - 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

getSourceType

public String getSourceType()

Retrieve the source_type property (displayed as 'Source Type') of the object.

Returns:

String

setSourceType

public void setSourceType(String sourceType)

Set the source_type property (displayed as Source Type) of the object.

Parameters:

sourceType - 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

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