org.odpi.openmetadata.accessservices.assetconsumer.rest

Class AssetCollectionRequestBody

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody

org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetCollectionRequestBody

All Implemented Interfaces:

Serializable

public class AssetCollectionRequestBody
extends AssetConsumerOMASAPIRequestBody

AssetCollectionRequestBody defines the properties used to create an asset connector anchor object. Asset collections are linked off of the individual's profile.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssetCollectionRequestBody() Default Constructor
AssetCollectionRequestBody(AssetCollectionRequestBody template) Copy/clone Constructor - the resulting object.

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.
AssetCollectionOrder	getCollectionOrdering() Return the property to use to determine the order that assets are returned.
String	getCollectionUse() Return the description of how the collection is used by the actor.
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	getQualifiedName() Return the unique name for this asset.
int	hashCode() Return hash code for this object
void	setAdditionalProperties(Map<String,Object> additionalProperties) Set up any additional properties associated with the asset.
void	setCollectionOrdering(AssetCollectionOrder collectionOrdering) Set up the property to use to determine the order that assets are returned.
void	setCollectionUse(String collectionUse) Set up the description of how the collection is used by the actor.
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	setQualifiedName(String qualifiedName) Set up the unique name for this asset.
String	toString() JSON-style toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetCollectionRequestBody

public AssetCollectionRequestBody()

Default Constructor

AssetCollectionRequestBody

public AssetCollectionRequestBody(AssetCollectionRequestBody template)

Copy/clone Constructor - the resulting object.

Parameters:

template - object being copied

Method Detail

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

getCollectionUse

public String getCollectionUse()

Return the description of how the collection is used by the actor.

Returns:

text

setCollectionUse

public void setCollectionUse(String collectionUse)

Set up the description of how the collection is used by the actor.

Parameters:

collectionUse - test

getCollectionOrdering

public AssetCollectionOrder getCollectionOrdering()

Return the property to use to determine the order that assets are returned.

Returns:

AssetCollectionOrder enum

setCollectionOrdering

public void setCollectionOrdering(AssetCollectionOrder collectionOrdering)

Set up the property to use to determine the order that assets are returned.

Parameters:

collectionOrdering - AssetCollectionOrder enum

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

toString

public String toString()

JSON-style toString

Overrides:

toString in class AssetConsumerOMASAPIRequestBody

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