Class ecm.model.EntryTemplate


Extends ecm.model._ModelObject.
Represents a single entry template in the repository. An entry template is used to manage the creation of a new content item. Entry template settings can also be applied when a document is checked in.

For performance reasons, the entry template settings are not filled in until the asynchronous ecm.model.EntryTemplate retrieveEntryTemplate method is called.


Defined in: <ecm\model\EntryTemplate.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
Constructs the entry template model object.

Field Summary

Field Attributes Field Name and Description
 
A string holding the content class description text.
 
A string holding the content class display label.
 
A string holding the content class name.
 
FileNet P8 only.
 
A boolean value indicating whether the user can select the repository as the destination without filing the document in a folder.
 
FileNet P8 only.
 
A boolean value indicating whether the What do you want to save pull-down menu contains Local document.
 
A boolean value indicating whether the What do you want to save pull-down menu contains Information about a document.
 
A boolean value indicating whether this entry template will allow the user to select the content file.
 
A boolean value indicating whether this entry template will allow the user to select the folder under which the new content item will be filed.
 
A boolean value indicating whether the What do you want to save pull-down menu is displayd to the user.
 
A boolean value indicating whether this entry template will allow the user to set property values.
 
A boolean value indicating whether this entry template allows the user to modify security settings.
 
FileNet P8 only.
 
FileNet P8 only.
 
IBM Content Manager only.
 
A string value of the custom layout properties control registry class to be created.
 
A string holding the declare as record setting.
 
A string holding the entry template description text.
 
A boolean value indicating whether this entry template is editable.
 
FileNet P8 only.
 
A string value holding the entry template builder that will be created for this entry template.
 
folder 
A ecm.model.ContentItem folder object under which the new content item will be filed.
 
FileNet P8 only.
 
A boolean value indicating whether the settings for this template have been retrieved.
 
itemId 
A string value holding the item id.
 
A string value of the custom layout properties pane class to be created.
 
markup 
A string value holding custom HTML markup from the layout designer.
 
A string holding the MIME type of this entry template.
 
mode 
A string holding the mode of add, edit, or copy.
 
A string value of the custom layout properties model integration class to be created.
 
FileNet P8 only.
 
A boolean value indicating whether this entry template overrides the security defined by the class.
 
An array of ecm.model.Permission objects specifying the security for the new content item.
 
An array of ecm.model.EntryTemplatePropertyOptions objects that specifies the property display order and property options such as hidden, read only, etc.
 
The ecm.model.Repository object where the entry template is stored.
 
A string value holding custom resources from the layout designer.
 
A boolean value indicating whether this entry template only allows the user to select the specified folder or a sub-folder as the folder under which the new content item will be filed.
 
A ecm.model.ContentItem folder in which to file a new entry template when it is added to the repository.
 
FileNet P8 only.
 
FileNet P8 only.
 
FileNet P8 only.
 
A string that indicates if this entry template is the default for a teamspace.
 
An array of ecm.model.Permission objects specifying the security for the entry template.
 
type 
A string holding the type of object this entry template will add.
 
A boolean value indicating whether this entry template should be applied when a document added using this entry template is checked in.
 
A boolean value indicating whether this entry template should be used on the document information pane.
 
A boolean value indicating whether this entry template should be used on the properties dialog.
 
A boolean value indicating whether this entry template should be used on the viewer properties pane.
 
A boolean value indicating whether the workflow is launched by the user.
 
A boolean value indicating whether the user can modify the launch step.
 
vsId 
A string value holding the version series id.
 
An optional ecm.model.WorkItem object that specifies the workflow to launch on the content item.
 
A boolean indicating that the workflow is a pre-defined workflow (versus a custom workflow).
 
A string holding the workflow version.
Fields borrowed from class ecm.model._ModelObject:
categorization, id, isRecurring, name, nameFilter, pane, status, userId

Method Summary

Method Attributes Method Name and Description
 
Returns a clone of this entry template.
<static>  
ecm.model.EntryTemplate.EntryTemplate.registerControlRegistry(controlRegistry)
Static function that registers a control registry extension for enhancing the Property Layout Editor controls.
<static>  
ecm.model.EntryTemplate.EntryTemplate.registerFactory(factory)
Static function that registers a factory for sub-classes of EntryTemplate.
<static>  
ecm.model.EntryTemplate.EntryTemplate.registerModelIntegration(modelIntegration)
Static function that registers a model integration extension for enhancing the Property Layout Editor controls.
 
onEntryTemplateRetrieved(template, response)
An event function called when the entry template has been retrieved.
 
retrieveEntryTemplate(callback, editMode, allowFailure)
Retrieves the entry template object information.
 
Returns the JSON representation of this entry template.
Methods borrowed from class ecm.model._ModelObject:
destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.EntryTemplate(properties)

Constructs the entry template model object.
Parameters:
properties
The properties for the entry template object. Can be any of the public fields as defined below and on ecm.model._ModelObject.

Field Detail

addClassDescription

A string holding the content class description text.

addClassLabel

A string holding the content class display label.

addClassName

A string holding the content class name.

allowDuplicateFileNames

FileNet P8 only. A boolean value indicating whether this entry template will allow duplicate file names when adding a content file.

allowNoFolderSelected

A boolean value indicating whether the user can select the repository as the destination without filing the document in a folder.
Since:
2.0.3

allowSaveExternalDocumentLink

FileNet P8 only. A boolean value indicating whether the What do you want to save pull-down menu contains Link to an external document.
Since:
2.0.3

allowSaveLocalDocument

A boolean value indicating whether the What do you want to save pull-down menu contains Local document.
Since:
2.0.3

allowSavePropertiesOnly

A boolean value indicating whether the What do you want to save pull-down menu contains Information about a document.
Since:
2.0.3

allowUserSelectFile

A boolean value indicating whether this entry template will allow the user to select the content file. Applies to pre-2.0.3 entry templates.

allowUserSelectFolder

A boolean value indicating whether this entry template will allow the user to select the folder under which the new content item will be filed.

allowUserSelectSaveChoice

A boolean value indicating whether the What do you want to save pull-down menu is displayd to the user.
Since:
2.0.3

allowUserSetPropertyValues

A boolean value indicating whether this entry template will allow the user to set property values.

allowUserSetSecurity

A boolean value indicating whether this entry template allows the user to modify security settings.

asMinorVersion

FileNet P8 only. A ecm.model.EntryTemplateOption object for the add or check in as minor version setting. This setting is initialized to be shown, editable, and false. When the value is false add or check in creates a major version.

autoClassify

FileNet P8 only. A ecm.model.EntryTemplateOption object for the auto classify on add setting. This setting is initialized to be hidden, read only, and false.

checkinAsNewVersion

IBM Content Manager only. A ecm.model.EntryTemplateOption object for the check in as new version setting. This setting is initialized to be shown, editable, and true. When the value is false check in replaces the current version. When the class does not allow new versions to be created the setting will always be false. When the CM class requires that new versions be created the setting will always be true.
Since:
2.0.3

controlRegistryClass

A string value of the custom layout properties control registry class to be created.
Since:
2.0.3

declareRecord

A string holding the declare as record setting. One of the values in ecm.model.EntryTemplate.DECLARE.

description

A string holding the entry template description text.

editable

A boolean value indicating whether this entry template is editable.

enableCompoundDocuments

FileNet P8 only. A ecm.model.EntryTemplateOption object for enabling added documents to use compound documents. This setting is initialized to be hidden, read only, and false.
Since:
2.0.3

entryTemplateBuilderWidgetClass

A string value holding the entry template builder that will be created for this entry template. Plugin-writers can override this to provide a custom builder to handle their own entry templates.
Since:
2.0.3

folder

A ecm.model.ContentItem folder object under which the new content item will be filed.

inheritSecurityFromParentFolder

FileNet P8 only. A boolean value indicating whether the new content item inherits security from the parent folder. This is optional only when adding documents. A new folder always inherits security from the parent folder.
Since:
2.0.3

isRetrieved

A boolean value indicating whether the settings for this template have been retrieved.

itemId

A string value holding the item id. (IBM Content Manager only)
Since:
2.0.3

layoutPropertiesPaneClass

A string value of the custom layout properties pane class to be created.
Since:
2.0.3

markup

A string value holding custom HTML markup from the layout designer. (This value can be null.)
Since:
2.0.3

mimetype

A string holding the MIME type of this entry template.
Since:
2.0.3

mode

A string holding the mode of add, edit, or copy.
Since:
2.0.3

modelIntegrationClass

A string value of the custom layout properties model integration class to be created.
Since:
2.0.3

objectStore

FileNet P8 only. The destination object store for content added using this entry template. The destination object store can be a different object store than the one that contains the entry template. It is also possible for there to be no repository configuration for the destination object store in the current desktop configuration. This is an object valued property where the object store information is stored in the properties id, symbolicName, and displayName.

overrideClassSecurity

A boolean value indicating whether this entry template overrides the security defined by the class.
Since:
2.0.3

permissions

An array of ecm.model.Permission objects specifying the security for the new content item.

propertiesOptions

An array of ecm.model.EntryTemplatePropertyOptions objects that specifies the property display order and property options such as hidden, read only, etc.

repository

The ecm.model.Repository object where the entry template is stored.

resources

A string value holding custom resources from the layout designer. (This value can be null.)
Since:
2.0.3

restrictToSelectedFolderOrDescendant

A boolean value indicating whether this entry template only allows the user to select the specified folder or a sub-folder as the folder under which the new content item will be filed.

saveToFolder

A ecm.model.ContentItem folder in which to file a new entry template when it is added to the repository.
Since:
2.0.3

saveToFolderInheritParentSecurity

FileNet P8 only. A boolean value indicating whether this entry template inherits security from the parent folder.
Since:
2.0.3

securityPolicy

FileNet P8 only. An optional ecm.model.SecurityPolicy object that is applied to the new content item.

targetRepository

FileNet P8 only. The destination repository for content added using this entry template. The destination repository can be a different repository in the same domain than the one that contains the entry template.

teamspaceDefault

A string that indicates if this entry template is the default for a teamspace. If the string is empty ("") this entry template is not the default for a teamspace.

templatePermissions

An array of ecm.model.Permission objects specifying the security for the entry template.
Since:
2.0.3

type

A string holding the type of object this entry template will add. One of the values in ecm.model.EntryTemplate.TYPE.

useForCheckin

A boolean value indicating whether this entry template should be applied when a document added using this entry template is checked in.

useForDocumentInformationProperties

A boolean value indicating whether this entry template should be used on the document information pane.
Since:
2.0.3

useForProperties

A boolean value indicating whether this entry template should be used on the properties dialog.
Since:
2.0.3

useForViewerProperties

A boolean value indicating whether this entry template should be used on the viewer properties pane.
Since:
2.0.3

userLaunchesWorkflow

A boolean value indicating whether the workflow is launched by the user.
Since:
2.0.3

userModifiesLaunchStep

A boolean value indicating whether the user can modify the launch step.
Since:
2.0.3

vsId

A string value holding the version series id. (FileNet P8 only)

workflow

An optional ecm.model.WorkItem object that specifies the workflow to launch on the content item.

workflowPredefined

A boolean indicating that the workflow is a pre-defined workflow (versus a custom workflow).
Since:
2.0.3

workflowVersion

A string holding the workflow version. One of the values in ecm.model.EntryTemplate.WORKFLOW_VERSION.
Since:
2.0.3

Method Detail

clone()

Returns a clone of this entry template.
Since:
2.0.3

<static> ecm.model.EntryTemplate.EntryTemplate.registerControlRegistry(controlRegistry)

Static function that registers a control registry extension for enhancing the Property Layout Editor controls.
Parameters:
controlRegistry

<static> ecm.model.EntryTemplate.EntryTemplate.registerFactory(factory)

Static function that registers a factory for sub-classes of EntryTemplate.
Parameters:
factory
A factory object with createFromJSON() method to possibly create a sub-class of EntryTemplate from JSON. The factory method should return null when the given JSON is not one for known sub-classes, giving chances for other factories to create one or falling back to the default EntryTemplate construction.

<static> ecm.model.EntryTemplate.EntryTemplate.registerModelIntegration(modelIntegration)

Static function that registers a model integration extension for enhancing the Property Layout Editor controls.
Parameters:
modelIntegration

onEntryTemplateRetrieved(template, response)

An event function called when the entry template has been retrieved.
Parameters:
template
A ecm.model.EntryTemplate object
response
The response object used to retrieve this entry template if it exists.

retrieveEntryTemplate(callback, editMode, allowFailure)

Retrieves the entry template object information.
Parameters:
callback
A function called when the entry template information has been retrieved, it is passed this ecm.model.EntryTemplate object.
editMode
A boolean flag indicating if the entry template should be retrieved for editing (true) or for use with an item (false).
allowFailure
A boolean flag that tells the server to ignore any failure to retrieve the entry template. This is set to true when attempting to retrieve the entry template associated with a document during checkin action processing. It allows the checkin to proceed without raising an error if the entry template used to add the document was deleted from the repository.

toJson()

Returns the JSON representation of this entry template.
Since:
2.0.3