com.ibm.workplace.wcm.api
Interface AuthoringTemplate

All Superinterfaces:

AbstractAuthoringTemplate, Document, Editable, EditableItem, Hierarchical, Item, Localized, WCMApiObject, WorkflowedDocument

public interface AuthoringTemplate
extends AbstractAuthoringTemplate

Represents a content authoring template. Content Authoring Templates are used to define the types of content that can be created within the content management system. New Content objects will derive their default attributes from the AuthoringTemplate defined during its creation.

The ContentPrototype of the AuthoringTemplate is used to define the set of AuthoringTemplates that make up the target Content type. Note that an AuthoringTemplate is referred to as a "Content Template" since 8.0 in the Authoring UI.

Since:

7.0

Method Summary

ContentPrototype	getGenericPrototype() Returns the ContentPrototype for this authoring template.
ContentTemplateItemProperties	getItemProperties() Return the item properties for this content template.
ContentPrototype	getPrototype() Returns the ContentPrototype for this content authoring template.

Methods inherited from interface com.ibm.workplace.wcm.api.AbstractAuthoringTemplate

getTargetComponent, setTargetComponent

Methods inherited from interface com.ibm.workplace.wcm.api.Editable

addAuthors, addCategoryIds, addContributorAccessMembers, addDeleteAccessMembers, addEditAccessMembers, addEditorAccessMembers, addHistoryLogEntry, addLiveAccessMembers, addManagerAccessMembers, addMembersForAccess, addOwners, addReadAccessMembers, addUserAccessMembers, isChanged, removeAuthors, removeCategoryIds, removeContributorAccessMembers, removeDeleteAccessMembers, removeEditAccessMembers, removeEditorAccessMembers, removeLiveAccessMembers, removeManagerAccessMembers, removeMembersForAccess, removeOwners, removeReadAccessMembers, removeUserAccessMembers, setContributorAccessInheritance, setDescriptionTextProviderKey, setDescriptionTextProviderName, setEditorAccessInheritance, setInheritance, setKeywords, setManagerAccessInheritance, setPropagation, setTitleTextProviderKey, setTitleTextProviderName, setUserAccessInheritance

Methods inherited from interface com.ibm.workplace.wcm.api.Document

getAuthors, getCategoryIds, getContributorAccessMembers, getCreator, getDeleteAccessMembers, getDescription, getDescriptionTextProviderKey, getDescriptionTextProviderName, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getKeywords, getLastModifier, getLiveAccessMembers, getManagerAccessMembers, getMembersForAccess, getMembersForInheritedAccess, getOwnerLibrary, getOwners, getProject, getReadAccessMembers, getSourceWorkspace, getTitle, getTitleTextProviderKey, getTitleTextProviderName, getUserAccessMembers, getVersionCatalog, getVersionStrategy, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasProfile, hasProject, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isInherited, isManagerAccessInherited, isNew, isPropagated, isUserAccessInherited, isWorkflowed

Methods inherited from interface com.ibm.workplace.wcm.api.Item

getCreationDate, getDescription, getIdentity, getModifiedDate, getName, getTitle

Methods inherited from interface com.ibm.portal.Localized

getLocales

Methods inherited from interface com.ibm.workplace.wcm.api.EditableItem

setDescription, setName, setTitle

Methods inherited from interface com.ibm.workplace.wcm.api.WorkflowedDocument

addAdditionalViewers, addApprovers, approve, cancelDraftDocument, clearApprovers, createDraftDocument, decline, decline, getAdditionalViewers, getCurrentApprovers, getDateEnteredStage, getEffectiveDate, getExpiryDate, getGeneralDateOne, getGeneralDateTwo, getPendingWorkflowStatus, getPublishedDate, getPublishedId, getWorkflowId, getWorkflowStageId, getWorkflowStatus, hasApproverAccess, hasApproverAccess, hasDraft, isDraft, isDraftOfPublishedDocument, isExpired, isPublished, isWorkflowMovingBackward, nextWorkflowStage, nextWorkflowStage, nextWorkflowStage, previousWorkflowStage, previousWorkflowStage, removeAdditionalViewers, removeApprovers, restartWorkflow, setEffectiveDate, setExpiryDate, setGeneralDateOne, setGeneralDateTwo, setWorkflowId, setWorkflowId

Methods inherited from interface com.ibm.workplace.wcm.api.Hierarchical

getParentId

Method Detail

getGenericPrototype

ContentPrototype getGenericPrototype()

Returns the ContentPrototype for this authoring template. To update the content prototype, save this authoring template.

Specified by:

getGenericPrototype in interface AbstractAuthoringTemplate

Returns:

a reference to the content prototype

getPrototype

ContentPrototype getPrototype()

Returns the ContentPrototype for this content authoring template. To update the content prototype, save this authoring template.

Specified by:

getPrototype in interface AbstractAuthoringTemplate

Returns:

a reference to the content prototype

Throws:

java.lang.IllegalStateException

getItemProperties

ContentTemplateItemProperties getItemProperties()

Return the item properties for this content template. To have changes to the item properties persist, you must save this authoring template.

Specified by:

getItemProperties in interface AbstractAuthoringTemplate

Returns:

Item properties of content template.