workspace.tools.views.userMetaData Namespace Reference

Functions
def	getUserMetaDataField (fieldName, library, autoAddField=False)
	Get the MediaFileUserMetaDataField from a Library and field name. More...
def	getUserMetaDataEntry (mediaFile, fieldName)
	Get a UserMetaData Entry from a MediaFile. More...
def	setUserMetaDataEntry (mediaFile, fieldName, value, autoAddField=True)
	Set a UserMetaData Entry for a MediaFile. More...
def	getMediaFileUserMetaDataDictionary (mediaFile)
	Get all UserMetaData entries from a MediaFile. More...
def	getMediaFileUserMetaDataDictionaryList (mediaFile)
	Get all UserMetaData entries from a MediaFile. More...
def	getMediaFileUserMetaData (mediaFile)
	Get all UserMetaData entries from a MediaFile. More...
def	addOrUpdateMediaFileUserMetaData (mediaFile, data, autoAddFields=True)
	Set Multiple UserMetaData entries for a MediaFile. More...
def	getLibraryUserMetaDataFields (library)
	Get a list of UserMetaDataFields defined for a Library. More...

Function Documentation

def workspace.tools.views.userMetaData.addOrUpdateMediaFileUserMetaData	(		mediaFile,
			data,
			autoAddFields = True
	)

Set Multiple UserMetaData entries for a MediaFile.

Add or update UserMetaData records for a MediaFile

Note

If they don't exist, new fields will automatically be created in the Library.

This is not an atomic transaction, such that on error, none, some, or all of the data may have been saved.

This will update existing records or add new, but it will not delete existing records that are not contained within this list (e.g., if records 1 and 2 exist, and 2 and 3 are passed to this function, 1, 2, and 3 will exist at the end).

Parameters

mediaFile	MediaFile Object
data	Dictionary of entries, as {fieldName: value}

Returns

True on success, False on any error

def workspace.tools.views.userMetaData.getLibraryUserMetaDataFields

(

library

)

Get a list of UserMetaDataFields defined for a Library.

Parameters

library

Library Object.

Returns

A list of UserMetaDataFields, as a Django QuerySet.

def workspace.tools.views.userMetaData.getMediaFileUserMetaData

(

mediaFile

)

Get all UserMetaData entries from a MediaFile.

Parameters

mediaFile

MediaFile Object

Returns

all metaData entries for a mediaFile as a Django Queryset

def workspace.tools.views.userMetaData.getMediaFileUserMetaDataDictionary

(

mediaFile

)

Get all UserMetaData entries from a MediaFile.

Parameters

mediaFile

MediaFile Object

Returns

all metaData entries for a mediaFile as a dictionary {fieldName: value}

def workspace.tools.views.userMetaData.getMediaFileUserMetaDataDictionaryList

(

mediaFile

)

Get all UserMetaData entries from a MediaFile.

Parameters

mediaFile

MediaFile Object

Returns

List of dictionaries, one dictionary per entry: [{id: <entry id>="">, fieldName: <name>, value:

}]

def workspace.tools.views.userMetaData.getUserMetaDataEntry	(		mediaFile,
			fieldName
	)

Get a UserMetaData Entry from a MediaFile.

Parameters

mediaFile	MediaFile Object
fieldName	String Name of the UserMetaData Field.

Returns

String value of the UserMetaData entry, None if not found.

def workspace.tools.views.userMetaData.getUserMetaDataField	(		fieldName,
			library,
			autoAddField = False
	)

Get the MediaFileUserMetaDataField from a Library and field name.

Parameters

fieldName	String name of the UserMetaData Field.
library	Library object in which to search for the field.
autoAddField	If True, add the field to the Library if it does not exist.

Returns

MediaFileUserMetaDataField Object, None if not found.

def workspace.tools.views.userMetaData.setUserMetaDataEntry	(		mediaFile,
			fieldName,
			value,
			autoAddField = True
	)

Set a UserMetaData Entry for a MediaFile.

Parameters

mediaFile	MediaFile Object
fieldName	String Name of the UserMetaData Field.
value	String value to set for the field.
autoAddField	If the UserMetaDataField does not exist, create it if True.

Returns

True on Success, False on any failure.