#include <MetaDataTypes.h>
Public Types
typedef object_type data_type

Public Member Functions
ResourceRef (const PMString &instanceID="", const metadata::URI &documentID="", const metadata::URI &origDocumentID="", const PMString &versionID="", const PMString &renditionClass="", const PMString &renditionParams="", const PMString &manageTo="", const PMString &manageUI="", const PMString &manager="", const PMString &managerVariant="", const PMString &fileURL="")

ResourceRef (const ResourceRef &other)

ResourceRef & operator= (const ResourceRef &other)

bool operator== (const ResourceRef &other)

bool16 HasXMPReference () const

void Clear ()

void SetInstanceID (const PMString &instanceID)

PMString GetInstanceID () const

void SetDocumentID (const metadata::URI &documentID)

metadata::URI GetDocumentID () const

void SetOrigDocumentID (const metadata::URI &origDocumentID)

metadata::URI GetOrigDocumentID () const

void SetVersionID (const PMString &versionID)

PMString GetVersionID () const

void SetRenditionClass (const PMString &renditionClass)

PMString GetRenditionClass () const

void SetRenditionParams (const PMString &renditionParams)

PMString GetRenditionParams () const

void SetManageTo (const PMString &manageTo)

PMString GetManageTo () const

void SetManageUI (const PMString &manageUI)

PMString GetManageUI () const

void SetManager (const PMString &manager)

PMString GetManager () const

void SetManagerVariant (const PMString &managerVariant)

PMString GetManagerVariant () const

void SetFileURL (const PMString &fileURL)

PMString GetFileURL () const

Detailed Description

This class is used to store and manipulate reference to a XMP Media Management Properties

Member Typedef Documentation

typedef object_type metadata::ResourceRef::data_type

Data type for the ResourceRef

Constructor & Destructor Documentation

metadata::ResourceRef::ResourceRef	(	const PMString &	instanceID = `""`,
		const metadata::URI &	documentID = `""`,
		const metadata::URI &	origDocumentID = `""`,
		const PMString &	versionID = `""`,
		const PMString &	renditionClass = `""`,
		const PMString &	renditionParams = `""`,
		const PMString &	manageTo = `""`,
		const PMString &	manageUI = `""`,
		const PMString &	manager = `""`,
		const PMString &	managerVariant = `""`,
		const PMString &	fileURL = `""`
	)

inline

Constructor

Parameters

instanceID	IN A Unique Instance Id of the document.
documentID	IN The common identifier for all versions and renditions of a document.
origDocumentID	IN The common identifier for the original document.
versionID	IN This property should be used primarily by a media management system.
renditionClass	IN Rendition class name for this resource.
renditionParams	IN May be used to provide additional rendition parameters that are too complex or verbose to encode in RenditionClass.
manageTo	IN A URI identifying the managed resource to the asset management system.
manageUI	IN A URI that can be used to access information about the managed resource through a webbrowser.
manager	IN Name of the asset management system that manages this resource.
managerVariant	IN Specifies a particular variant of the asset management system.
fileURL	IN URL for the file.

metadata::ResourceRef::ResourceRef ( const ResourceRef & other )

inline

Copy Constructor.

Parameters

other IN Another resourceRef from which to create this resourceRef.

Member Function Documentation

void metadata::ResourceRef::Clear ( void )

inline

Clears all the resource references.

metadata::URI metadata::ResourceRef::GetDocumentID ( ) const

inline

Returns the document id of the XMP resource.

Returns: Document id.

PMString metadata::ResourceRef::GetFileURL ( ) const

inline

Returns the URL for the file.

Returns: The URL for the file.

PMString metadata::ResourceRef::GetInstanceID ( ) const

inline

Returns the instance id of the XMP resource.

Returns: Instance Id.

PMString metadata::ResourceRef::GetManager ( ) const

inline

Returns the name of the asset management system that manages this resource.

Returns: The name of the asset management system.

PMString metadata::ResourceRef::GetManagerVariant ( ) const

inline

Returns the name of a particular variant of the asset management system.

Returns: The name of a particular variant of the asset management system.

PMString metadata::ResourceRef::GetManageTo ( ) const

inline

Returns the URI identifying the managed resource to the asset management system.

Returns: The URI identifying the managed resource to the asset management system.

PMString metadata::ResourceRef::GetManageUI ( ) const

inline

Returns URI that can be used to access information about the managed resource through a webbrowser.

Returns: The URI that can be used to access information about the managed resource through a webbrowser.

metadata::URI metadata::ResourceRef::GetOrigDocumentID ( ) const

inline

Returns the common identifier for the origianl document from which all deriviatives, conversions, versions, and renditions came from.

Returns: The common identifier for the original document (should stay the same for all derivatives, conversions, versions, and renditions of the document).

PMString metadata::ResourceRef::GetRenditionClass ( ) const

inline

Returns the rendition class name of the XMP resource.

Returns: The rendition class name.

PMString metadata::ResourceRef::GetRenditionParams ( ) const

inline

Returns the rendition parameters that are too complex or verbose to encode in RenditionClass.

Returns: The rendition parameters.

PMString metadata::ResourceRef::GetVersionID ( ) const

inline

Returns the version id of the XMP resource.

Returns: Version id.

bool16 metadata::ResourceRef::HasXMPReference ( ) const

inline

Returns kTrue if any XMP Media Management Properties is not blank.

Returns: kTrue if any of the following Instance ID, Document ID, Version ID, RenditionClass, RenditionParams, ManageTo, ManageUI, Manager or ManagerVariant is not blank. kFalse otherwise.

ResourceRef& metadata::ResourceRef::operator= ( const ResourceRef & other )

inline

Assignment operator.

Parameters

other IN Another resourceRef from which to set this resourceRef.

Returns: Reference to self.

bool metadata::ResourceRef::operator== ( const ResourceRef & other )

inline

Equality operator.

Parameters

other IN Another resourceRef to compare from.

Returns: true if both are equal, false otherwise.

void metadata::ResourceRef::SetDocumentID ( const metadata::URI & documentID )

inline

Sets the document id of the XMP resource.

Parameters

documentID IN Document id.

void metadata::ResourceRef::SetFileURL ( const PMString & fileURL )

inline

Sets the URL for the file.

Parameters

fileURL IN The URL for the file.

void metadata::ResourceRef::SetInstanceID ( const PMString & instanceID )

inline

Sets the instance id of the XMP resource.

Parameters

instanceID IN Instance id.

void metadata::ResourceRef::SetManager ( const PMString & manager )

inline

Sets the name of the asset management system that manages this resource.

Parameters

manager IN The name of the asset management system.

void metadata::ResourceRef::SetManagerVariant ( const PMString & managerVariant )

inline

Sets the name of a particular variant of the asset management system.

Parameters

managerVariant IN The name of a particular variant of the asset management system.

void metadata::ResourceRef::SetManageTo ( const PMString & manageTo )

inline

Sets the URI identifying the managed resource to the asset management system.

Parameters

manageTo IN The URI identifying the managed resource to the asset management system.

void metadata::ResourceRef::SetManageUI ( const PMString & manageUI )

inline

Sets the URI that can be used to access information about the managed resource through a webbrowser.

Parameters

manageUI IN The URI that can be used to access information about the managed resource through a webbrowser.

void metadata::ResourceRef::SetOrigDocumentID ( const metadata::URI & origDocumentID )

inline

Sets the common identifier for the original document (should stay the same for all derivatives, conversions, versions, and renditions of the document).

Parameters

origDocumentID IN The common identifier for the original document.

void metadata::ResourceRef::SetRenditionClass ( const PMString & renditionClass )

inline

Sets the rendition class name of the XMP resource.

Parameters

renditionClass IN The rendition class name.

void metadata::ResourceRef::SetRenditionParams ( const PMString & renditionParams )

inline

Sets the rendition parameters that are too complex or verbose to encode in RenditionClass.

Parameters

renditionParams IN The rendition parameters.

void metadata::ResourceRef::SetVersionID ( const PMString & versionID )

inline

Sets the version id of the XMP resource.

Parameters

versionID IN Version id.

Public Member Functions
	ResourceRef (const PMString &instanceID="", const metadata::URI &documentID="", const metadata::URI &origDocumentID="", const PMString &versionID="", const PMString &renditionClass="", const PMString &renditionParams="", const PMString &manageTo="", const PMString &manageUI="", const PMString &manager="", const PMString &managerVariant="", const PMString &fileURL="")

	ResourceRef (const ResourceRef &other)

ResourceRef &	operator= (const ResourceRef &other)

bool	operator== (const ResourceRef &other)

bool16	HasXMPReference () const

void	Clear ()

void	SetInstanceID (const PMString &instanceID)

PMString	GetInstanceID () const

void	SetDocumentID (const metadata::URI &documentID)

metadata::URI	GetDocumentID () const

void	SetOrigDocumentID (const metadata::URI &origDocumentID)

metadata::URI	GetOrigDocumentID () const

void	SetVersionID (const PMString &versionID)

PMString	GetVersionID () const

void	SetRenditionClass (const PMString &renditionClass)

PMString	GetRenditionClass () const

void	SetRenditionParams (const PMString &renditionParams)

PMString	GetRenditionParams () const

void	SetManageTo (const PMString &manageTo)

PMString	GetManageTo () const

void	SetManageUI (const PMString &manageUI)

PMString	GetManageUI () const

void	SetManager (const PMString &manager)

PMString	GetManager () const

void	SetManagerVariant (const PMString &managerVariant)

PMString	GetManagerVariant () const

void	SetFileURL (const PMString &fileURL)

PMString	GetFileURL () const