Class ecm.model.VideoAnnotation


Extends ecm.model.Item.
Represents a single annotation item, for example, a bookmark or an annotation. Each annotation item is associated with a content item.
Defined in: <ecm\model\VideoAnnotation.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
Constructs a video annotation.

Field Summary

Field Attributes Field Name and Description
 
A ecm.model.ContentItem object associated.
 
TYPE 
Data type constants.
Fields borrowed from class ecm.model.Item:
attributes, dataObject, deleted, entryTemplateId, locked, lockedUser, mimetype, parent, privileges, repository, resultSet
Fields borrowed from class ecm.model._ModelObject:
categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes Method Name and Description
 
deleteThis(callback, errorback, skipOnChange)
Deletes this annotation item.
 
Gets the date this annotation item was added as a string formatted to the current locale.
 
getDisplayValue(attribute)
Overrides ecm.model.Item.getDisplayValue to always return actual values for some of the attributes.
 
Gets the version number of the content item.
 
Gets the display name of the originator.
 
Gets the Id of the originator.
 
Gets the short name of the originator.
 
Returns true if this annotation item can be deleted by the current user.
 
Returns true if this annotation item can be edited by the current user.
 
Returns true if this annotation item is created by the current user.
 
save(callback, errorback, skipOnChange)
Saves this annotation item.
Methods borrowed from class ecm.model.Item:
containsValue, getAttributeFormat, getAttributeType, getAttrLabel, getContentClass, getItemValue, getMimeClass, getModifyDate, getModifyUser, getPath, getStateClass, getUserInfo, getValue, getValues, hasAttribute, hasPrivilege, isAttributeReadOnly, isContentTiff, isDeclareRecordEntryTemplate, isDocumentEntryTemplate, isEntryTemplate, isFolder, isFolderEntryTemplate, isSystemProperty, retrieveAttributes, setValue, setValues
Methods borrowed from class ecm.model._ModelObject:
destroy, getSortCriteria, onChange, own, refresh, toString

Constructor Detail

ecm.model.VideoAnnotation()

Constructs a video annotation.

Field Detail

contentItem

A ecm.model.ContentItem object associated.

TYPE

Data type constants.

Method Detail

deleteThis(callback, errorback, skipOnChange)

Deletes this annotation item.
Parameters:
callback
errorback
skipOnChange

{String} getDateAdded()

Gets the date this annotation item was added as a string formatted to the current locale.
Returns:
{String} The date formatted to the current locale.

getDisplayValue(attribute)

Overrides ecm.model.Item.getDisplayValue to always return actual values for some of the attributes.
Parameters:
attribute
The name of the attribute.

getItemVersion()

Gets the version number of the content item.

getOriginatorDisplayName()

Gets the display name of the originator.

getOriginatorId()

Gets the Id of the originator.

getOriginatorShortName()

Gets the short name of the originator.

isDeletable()

Returns true if this annotation item can be deleted by the current user.

isEditable()

Returns true if this annotation item can be edited by the current user.

isMine()

Returns true if this annotation item is created by the current user.

save(callback, errorback, skipOnChange)

Saves this annotation item.
Parameters:
callback
errorback
skipOnChange