Class ecm.model.Reference


Extends ecm.model.Item.
Represents a link between a parent and child, in a compound document relationship.
Defined in: <ecm\model\Reference.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
ecm.model.Reference(properties)
Constructor

Field Summary

Field Attributes Field Name and Description
 
child 
The child ContentItem of this reference.
 
The compound document type represented by this Reference instance.
 
parent 
The parent ContentItem of this reference.
Fields borrowed from class ecm.model.Item:
attributes, dataObject, deleted, entryTemplateId, locked, lockedUser, mimetype, 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
 
Returns an instance of ecm.model.ContentClass for the content class that is associated with this content item.
 
saveAttributes(attributes, newTemplatename, callback, isBackgroundRequest, onError)
Updates the attribute values of this item.
Methods borrowed from class ecm.model.Item:
containsValue, getAttributeFormat, getAttributeType, getAttrLabel, getDisplayValue, getItemValue, getMimeClass, getModifyDate, getModifyUser, getPath, getStateClass, getUserInfo, getValue, getValues, hasAttribute, hasPrivilege, isAttributeReadOnly, isDeclareRecordEntryTemplate, isDocumentEntryTemplate, isEntryTemplate, isFolder, isFolderEntryTemplate, isSystemProperty, retrieveAttributes, setValue, setValues
Methods borrowed from class ecm.model._ModelObject:
destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.Reference(properties)

Constructor
Parameters:
properties
The properties for the model object. The properties can be any of the public fields as defined below and on ecm.model.Item.

Field Detail

child

The child ContentItem of this reference.

compoundDocumentType

The compound document type represented by this Reference instance.

parent

The parent ContentItem of this reference.

Method Detail

getContentClass()

Returns an instance of ecm.model.ContentClass for the content class that is associated with this content item.

saveAttributes(attributes, newTemplatename, callback, isBackgroundRequest, onError)

Updates the attribute values of this item. The attributes are saved to the repository.
Parameters:
attributes
An object containing the attribute values, keyed by attribute identifier.
newTemplatename
The new content class for the content item.
callback
A function that is invoked after the attributes have been updated. If errors are found with the attribute values, an object is passed to this callback which indicates the field, error message, and values in error.
isBackgroundRequest
A boolean flag indicating that this add request should be placed in a background process.
onError
A callback function that is called if there is an error returned when updating this item.