org.odpi.openmetadata.frameworks.connectors.properties.beans

Class RelatedMediaReference

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.ExternalReference

org.odpi.openmetadata.frameworks.connectors.properties.beans.RelatedMediaReference

All Implemented Interfaces:

Serializable

public class RelatedMediaReference
extends ExternalReference

RelatedMediaReference stores information about an link to an external media file that is relevant to this asset.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected RelatedMediaType	mediaType
protected List<RelatedMediaUsage>	mediaUsageList

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ExternalReference

displayName, linkDescription, organization, referenceId, resourceDescription, uri, version

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, confidenceGovernanceClassification, confidentialityGovernanceClassification, criticalityGovernanceClassification, latestChange, latestChangeDetails, meanings, qualifiedName, retentionGovernanceClassification, searchKeywords, securityTags

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
RelatedMediaReference() Default constructor
RelatedMediaReference(RelatedMediaReference templateRelatedMediaReference) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
RelatedMediaType	getMediaType() Return the type of media referenced.
List<RelatedMediaUsage>	getMediaUsageList() Return the list of recommended uses for the related media.
int	hashCode() Hash of properties
void	setMediaType(RelatedMediaType mediaType) Set up the type of media referenced.
void	setMediaUsageList(List<RelatedMediaUsage> mediaUsageList) Set up the list of recommended uses for the related media.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ExternalReference

getDisplayName, getLinkDescription, getOrganization, getReferenceId, getResourceDescription, getURI, getVersion, setDisplayName, setLinkDescription, setOrganization, setReferenceId, setResourceDescription, setURI, setVersion

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getConfidenceGovernanceClassification, getConfidentialityGovernanceClassification, getCriticalityGovernanceClassification, getLatestChange, getLatestChangeDetails, getMeanings, getQualifiedName, getRetentionGovernanceClassification, getSearchKeywords, getSecurityTags, setAdditionalProperties, setConfidenceGovernanceClassification, setConfidentialityGovernanceClassification, setCriticalityGovernanceClassification, setLatestChange, setLatestChangeDetails, setMeanings, setQualifiedName, setRetentionGovernanceClassification, setSearchKeywords, setSecurityTags

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Field Detail

mediaType

protected RelatedMediaType mediaType

mediaUsageList

protected List<RelatedMediaUsage> mediaUsageList

Constructor Detail

RelatedMediaReference

public RelatedMediaReference()

Default constructor

RelatedMediaReference

public RelatedMediaReference(RelatedMediaReference templateRelatedMediaReference)

Copy/clone constructor.

Parameters:

templateRelatedMediaReference - element to copy

Method Detail

getMediaType

public RelatedMediaType getMediaType()

Return the type of media referenced.

Returns:

related media type enum

setMediaType

public void setMediaType(RelatedMediaType mediaType)

Set up the type of media referenced.

Parameters:

mediaType - related media type enum

getMediaUsageList

public List<RelatedMediaUsage> getMediaUsageList()

Return the list of recommended uses for the related media. Null means no usage guidance is available.

Returns:

List of RelatedMediaUsage

setMediaUsageList

public void setMediaUsageList(List<RelatedMediaUsage> mediaUsageList)

Set up the list of recommended uses for the related media. Null means no usage guidance is available.

Parameters:

mediaUsageList - List of recommended uses for this media

toString

public String toString()

Standard toString method.

Overrides:

toString in class ExternalReference

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class ExternalReference

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Hash of properties

Overrides:

hashCode in class ExternalReference

Returns:

int