Class ecm.model.AttachmentItem

Extends ecm.model.Item.
Represents a single attachment item from a P8 workflow. Attachment item's can hold real documents and folders that have been "attached".
Defined in: <ecm\model\AttachmentItem.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.AttachmentItem(properties) Constructs an attachment item.

Field Summary

Field Attributes	Field Name and Description
	authoredName This is the user authored name for the attachment parameter (not the prompt or display name).
	connectionPoint A string value indicating the process engine connection point to use (optional).
	modified A boolean flag for indicating that the attachment list of content items has been modified.
	objectStore The object store containing the P8 content item.

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
	addAttachment(attachmentItems, item, repository, version, vsId, type) Helper function used to add a new attachment item into the attachment lists.
	getFolderContents() Return an instance of ecm.model.ResultSet holding the attachment content items.
	removeAttachment(attachmentItems, items) Helper function used to remove an content item from the attachment list.
	retrieveAttachmentContents(foldersOnly, refresh, callback) Helper function that will retrieve all the attachment items for a particular attachment parameter.

Methods borrowed from class ecm.model.Item:: containsValue, getAttributeFormat, getAttributeType, getAttrLabel, getContentClass, 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.AttachmentItem(properties)

Constructs an attachment item.

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

Field Detail

authoredName

This is the user authored name for the attachment parameter (not the prompt or display name).

connectionPoint

A string value indicating the process engine connection point to use (optional). Will override the connection point configured on the repository in the Admin data base.

modified

A boolean flag for indicating that the attachment list of content items has been modified.

objectStore

The object store containing the P8 content item.

Method Detail

addAttachment(attachmentItems, item, repository, version, vsId, type)

Helper function used to add a new attachment item into the attachment lists. Model layer information is saved to the mid-tier when completeStep() function is called on the work item.

Parameters:
attachmentItems: Array of attachment items.
item: ContentItem holding item to add.
repository: Repository
version: Object identifier for statically linked versions of documents.
vsId: Version series identifier (GUID) for current or released versions of documents.
type: Object type, document or folder.

{ecm.model.ResultSet} getFolderContents()

Return an instance of ecm.model.ResultSet holding the attachment content items. Property is populated after call to retrieveAttachmentContents function.

Returns:: {ecm.model.ResultSet}

removeAttachment(attachmentItems, items)

Helper function used to remove an content item from the attachment list. Model layer information is saved to the mid-tier when completeStep() is called on the work item.

Parameters:
attachmentItems: Array of attachment items.
items: list of ContentItem objects selected to be removed.

retrieveAttachmentContents(foldersOnly, refresh, callback)

Helper function that will retrieve all the attachment items for a particular attachment parameter.

Parameters:
foldersOnly: A boolean flag to indicate whether to retrieve only folders (for tree view rendering).
refresh: A boolean flag to indicated whether to use the cached list (or not)
callback: A function that is called when the action has completed. It is passed an ecm.model.ResultSet object.