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

Class RelatedMediaReference

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

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

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

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

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

public class RelatedMediaReference
extends ExternalReference

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

Field Summary

Fields

Modifier and Type	Field	Description
protected MediaType	mediaType
protected List<MediaUsage>	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, qualifiedName

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

extendedProperties

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
MediaType	getMediaType()	Return the type of media referenced.
List<MediaUsage>	getMediaUsageList()	Return the list of recommended uses for the related media.
int	hashCode()	Hash of properties
void	setMediaType(MediaType mediaType)	Set up the type of media referenced.
void	setMediaUsageList(List<MediaUsage> 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, getQualifiedName, setAdditionalProperties, setQualifiedName

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

getExtendedProperties, setExtendedProperties

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

getClassifications, getGUID, setClassifications, setGUID

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions

Methods inherited from class java.lang.Object

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

Field Details

mediaType

protected MediaType mediaType

mediaUsageList

protected List<MediaUsage> mediaUsageList

Constructor Details

RelatedMediaReference

public RelatedMediaReference()

Default constructor

RelatedMediaReference

public RelatedMediaReference(RelatedMediaReference templateRelatedMediaReference)

Copy/clone constructor.

Parameters:

templateRelatedMediaReference - element to copy

Method Details

getMediaType

public MediaType getMediaType()

Return the type of media referenced.

Returns:

related media type enum

setMediaType

public void setMediaType(MediaType mediaType)

Set up the type of media referenced.

Parameters:

mediaType - related media type enum

getMediaUsageList

public List<MediaUsage> getMediaUsageList()

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

Returns:

List of MediaUsage

setMediaUsageList

public void setMediaUsageList(List<MediaUsage> 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