org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest

Class AssetResponse

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.OCFOMASAPIResponse

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.AssetResponse

All Implemented Interfaces:

Serializable

public class AssetResponse
extends OCFOMASAPIResponse

AssetResponse is the response structure used on the OMAS REST API calls that return a asset bean object as a response. It also returns counts of the number of connected elements for the asset. This can be implemented cheaply as a single pass through the relationships linked to the asset and, assuming that the AssetUniverse structure is sparsely populated, and most callers only assess a specific subset of the information, it reduces the number of server calls needed to populate the AssetUniverse.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssetResponse() Default constructor
AssetResponse(AssetResponse 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.
Asset	getAsset() Return the asset result.
int	getCertificationCount() Return the count of attached certification.
int	getCommentCount() Return the count of attached comments.
int	getConnectionCount() Return the count of connections for the asset.
int	getExternalIdentifierCount() Return the count of external identifiers for this asset.
int	getExternalReferencesCount() Return the count of attached external references.
int	getInformalTagCount() Return the count of attached informal tags.
int	getKnownLocationsCount() Return the count of known locations.
LastAttachment	getLastAttachment() Return the record of the last attachment to be made to the asset.
int	getLicenseCount() Return the count of license for this asset.
int	getLikeCount() Return the number of likes for the asset.
int	getNoteLogsCount() Return the count of attached note logs.
int	getRatingsCount() Return the count of attached ratings.
int	getRelatedAssetCount() Return the count of related assets.
int	getRelatedMediaReferenceCount() Return the count of related media references.
SchemaType	getSchemaType() Is there an attached schema?
int	hashCode() Return hash code for this object
void	setAsset(Asset asset) Set up the asset result.
void	setCertificationCount(int certificationCount) Set up the count of attached certifications for the asset.
void	setCommentCount(int commentCount) Set up the count of attached comments.
void	setConnectionCount(int connectionCount) Set up the count of connections.
void	setExternalIdentifierCount(int externalIdentifierCount) Set up the count of external identifiers for this asset.
void	setExternalReferencesCount(int externalReferencesCount) Set up the count of attached external references.
void	setInformalTagCount(int informalTagCount) Set up the count of attached informal tags.
void	setKnownLocationsCount(int knownLocationsCount) Set up the count of known locations.
void	setLastAttachment(LastAttachment lastAttachment) Set up the record of the last attachment to be made to the asset.
void	setLicenseCount(int licenseCount) Set up the count of licenses for this asset.
void	setLikeCount(int likeCount) Set up the count of likes for the asset.
void	setNoteLogsCount(int noteLogsCount) Set up the count of attached note logs.
void	setRatingsCount(int ratingsCount) Set up the count of attach ratings.
void	setRelatedAssetCount(int relatedAssetCount) Set up the count of related assets.
void	setRelatedMediaReferenceCount(int relatedMediaReferenceCount) Set up the count of related media references.
void	setSchemaType(SchemaType schemaType) Set up whether there is an attached schema.
String	toString() JSON-style toString

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetResponse

public AssetResponse()

Default constructor

AssetResponse

public AssetResponse(AssetResponse template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getAsset

public Asset getAsset()

Return the asset result.

Returns:

unique identifier

setAsset

public void setAsset(Asset asset)

Set up the asset result.

Parameters:

asset - unique identifier

getCertificationCount

public int getCertificationCount()

Return the count of attached certification.

Returns:

count

setCertificationCount

public void setCertificationCount(int certificationCount)

Set up the count of attached certifications for the asset.

Parameters:

certificationCount - count

getCommentCount

public int getCommentCount()

Return the count of attached comments.

Returns:

count

setCommentCount

public void setCommentCount(int commentCount)

Set up the count of attached comments.

Parameters:

commentCount - count

getConnectionCount

public int getConnectionCount()

Return the count of connections for the asset.

Returns:

count

setConnectionCount

public void setConnectionCount(int connectionCount)

Set up the count of connections.

Parameters:

connectionCount - count

getExternalIdentifierCount

public int getExternalIdentifierCount()

Return the count of external identifiers for this asset.

Returns:

count

setExternalIdentifierCount

public void setExternalIdentifierCount(int externalIdentifierCount)

Set up the count of external identifiers for this asset.

Parameters:

externalIdentifierCount - count

getExternalReferencesCount

public int getExternalReferencesCount()

Return the count of attached external references.

Returns:

count

setExternalReferencesCount

public void setExternalReferencesCount(int externalReferencesCount)

Set up the count of attached external references.

Parameters:

externalReferencesCount - count

getInformalTagCount

public int getInformalTagCount()

Return the count of attached informal tags.

Returns:

count

setInformalTagCount

public void setInformalTagCount(int informalTagCount)

Set up the count of attached informal tags.

Parameters:

informalTagCount - count

getLicenseCount

public int getLicenseCount()

Return the count of license for this asset.

Returns:

count

setLicenseCount

public void setLicenseCount(int licenseCount)

Set up the count of licenses for this asset.

Parameters:

licenseCount - count

getLikeCount

public int getLikeCount()

Return the number of likes for the asset.

Returns:

count

setLikeCount

public void setLikeCount(int likeCount)

Set up the count of likes for the asset.

Parameters:

likeCount - count

getKnownLocationsCount

public int getKnownLocationsCount()

Return the count of known locations.

Returns:

count

setKnownLocationsCount

public void setKnownLocationsCount(int knownLocationsCount)

Set up the count of known locations.

Parameters:

knownLocationsCount - count

getNoteLogsCount

public int getNoteLogsCount()

Return the count of attached note logs.

Returns:

count

setNoteLogsCount

public void setNoteLogsCount(int noteLogsCount)

Set up the count of attached note logs.

Parameters:

noteLogsCount - count

getRatingsCount

public int getRatingsCount()

Return the count of attached ratings.

Returns:

count

setRatingsCount

public void setRatingsCount(int ratingsCount)

Set up the count of attach ratings.

Parameters:

ratingsCount - count

getRelatedAssetCount

public int getRelatedAssetCount()

Return the count of related assets.

Returns:

count

setRelatedAssetCount

public void setRelatedAssetCount(int relatedAssetCount)

Set up the count of related assets.

Parameters:

relatedAssetCount - count

getRelatedMediaReferenceCount

public int getRelatedMediaReferenceCount()

Return the count of related media references.

Returns:

count

setRelatedMediaReferenceCount

public void setRelatedMediaReferenceCount(int relatedMediaReferenceCount)

Set up the count of related media references.

Parameters:

relatedMediaReferenceCount - count

getSchemaType

public SchemaType getSchemaType()

Is there an attached schema?

Returns:

schema type bean

setSchemaType

public void setSchemaType(SchemaType schemaType)

Set up whether there is an attached schema.

Parameters:

schemaType - schema type bean

getLastAttachment

public LastAttachment getLastAttachment()

Return the record of the last attachment to be made to the asset.

Returns:

last attachment details

setLastAttachment

public void setLastAttachment(LastAttachment lastAttachment)

Set up the record of the last attachment to be made to the asset.

Parameters:

lastAttachment - last attachment details

toString

public String toString()

JSON-style toString

Overrides:

toString in class OCFOMASAPIResponse

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 FFDCResponseBase

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class FFDCResponseBase

Returns:

int hash code