org.odpi.openmetadata.accessservices.assetconsumer.properties

Class Asset

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetConsumerElementHeader

org.odpi.openmetadata.accessservices.assetconsumer.properties.Asset

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetCollectionMember

public class Asset
extends AssetConsumerElementHeader

Asset describes the basic properties of an Asset that include its name, type, description and owner. With this information it is possible to drill down and understand more details such as its location, classification and internal structure through the Asset Consumer's integration with the Connected Asset OMAS.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Asset() Default constructor
Asset(Asset template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Return comparison result based on the content of the properties.
Map<String,Object>	getAdditionalProperties() Return any additional properties associated with the asset.
List<Classification>	getClassifications() Return the list of active classifications for this asset.
String	getDescription() Return the description for this asset.
String	getDisplayName() Return the display name for this asset (normally a shortened for of the qualified name).
String	getGUID() Return the unique identifier for this asset.
String	getOwner() Return the owner for this asset.
String	getQualifiedName() Return the unique name for this asset.
String	getTypeDescription() Return the description for this Asset's type.
String	getTypeName() Return the name for this Asset's type.
List<String>	getZoneMembership() Return the names of the zones that this asset is a member of.
int	hashCode() Return hash code for this object
void	setAdditionalProperties(Map<String,Object> additionalProperties) Set up any additional properties associated with the asset.
void	setClassifications(List<Classification> classifications) Set up the list of active classifications for this asset.
void	setDescription(String description) Set up the description for this asset.
void	setDisplayName(String displayName) Set up the display name for this asset (normally a shortened for of the qualified name).
void	setGUID(String guid) Set up the unique identifier for this asset.
void	setOwner(String owner) Set up the owner for this asset.
void	setQualifiedName(String qualifiedName) Set up the unique name for this asset.
void	setTypeDescription(String typeDescription) Set up the description for this Asset's type.
void	setTypeName(String typeName) Set up the name for this Asset's type.
void	setZoneMembership(List<String> zoneMembership) Set up the names of the zones that this asset is a member of.
String	toString() JSON-style toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Asset

public Asset()

Default constructor

Asset

public Asset(Asset template)

Copy/clone constructor

Method Detail

getGUID

public String getGUID()

Return the unique identifier for this asset.

Returns:

string guid

setGUID

public void setGUID(String guid)

Set up the unique identifier for this asset.

Parameters:

guid - string guid for this asset

getTypeName

public String getTypeName()

Return the name for this Asset's type.

Returns:

string name

setTypeName

public void setTypeName(String typeName)

Set up the name for this Asset's type.

Parameters:

typeName - string name

getTypeDescription

public String getTypeDescription()

Return the description for this Asset's type.

Returns:

string description

setTypeDescription

public void setTypeDescription(String typeDescription)

Set up the description for this Asset's type.

Parameters:

typeDescription - string description

getQualifiedName

public String getQualifiedName()

Return the unique name for this asset.

Returns:

string name

setQualifiedName

public void setQualifiedName(String qualifiedName)

Set up the unique name for this asset.

Parameters:

qualifiedName - string name

getDisplayName

public String getDisplayName()

Return the display name for this asset (normally a shortened for of the qualified name).

Returns:

string name

setDisplayName

public void setDisplayName(String displayName)

Set up the display name for this asset (normally a shortened for of the qualified name).

Parameters:

displayName - string name

getDescription

public String getDescription()

Return the description for this asset.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the description for this asset.

Parameters:

description - string

getOwner

public String getOwner()

Return the owner for this asset. This is the user id of the person or engine that is responsible for managing this asset.

Returns:

string id

setOwner

public void setOwner(String owner)

Set up the owner for this asset. This is the user id of the person or engine that is responsible for managing this asset.

Parameters:

owner - string id

getZoneMembership

public List<String> getZoneMembership()

Return the names of the zones that this asset is a member of.

Returns:

list of zone names

setZoneMembership

public void setZoneMembership(List<String> zoneMembership)

Set up the names of the zones that this asset is a member of.

Parameters:

zoneMembership - list of zone names

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return any additional properties associated with the asset.

Returns:

map of property names to property values

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)

Set up any additional properties associated with the asset.

Parameters:

additionalProperties - map of property names to property values

getClassifications

public List<Classification> getClassifications()

Return the list of active classifications for this asset.

Returns:

list of classification objects

setClassifications

public void setClassifications(List<Classification> classifications)

Set up the list of active classifications for this asset.

Parameters:

classifications - list of classification objects

toString

public String toString()

JSON-style toString

Overrides:

toString in class Object

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class Object

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class Object

Returns:

int hash code