com.ibm.workplace.wcm.api
Interface ContentPrototype
- All Superinterfaces:
- ContentComponentContainer, Document, Editable, EditableItem, Item, Localized, Prototype, com.ibm.workplace.wcm.api.Visibility, WCMApiObject, WorkflowedDocument
public interface ContentPrototype
- extends Prototype, ContentComponentContainer, com.ibm.workplace.wcm.api.Visibility
An interface defining an object which is a content prototype in the repository.
A ContentPrototype
is associated with a parent content authoring template.
Properties and attributes on the ContentPrototype
will become the default
values for Content
created from its parent AuthoringTemplate
.
Note: Saving a content prototype by calling Workspace.save()
will throw
a DocumentSaveException
. Saving the parent AuthoringTemplate
will update
this content prototype.
In the Authoring User Interface, the content prototype is referred to as the Default Content.
- See Also:
AuthoringTemplate
Nested classes/interfaces inherited from interface com.ibm.workplace.wcm.api.Visibility |
com.ibm.workplace.wcm.api.Visibility.Scope |
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.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.Visibility |
getVisibilityByScope, isVisible, setVisible |
setPresentationTemplateOverride
void setPresentationTemplateOverride(DocumentId p_presentationTemplateId)
- Set the presentation template override for this content prototype. This Presentation Template will always be used to
render content created by this content prototype. This override takes priority over the default presentation template
set on the authoring template as well as any authoring template to presentation template mapping on the site area.
- Parameters:
p_presentationTemplateId
- the DocumentId of the presentation template to set as for overriding. Use null to
specify that no override should be defined.- Since:
- 8.5 CF7
getPresentationTemplateOverride
DocumentId<PresentationTemplate> getPresentationTemplateOverride()
throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException,
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- Retrieve the presentation template override for this content prototype. This can be null.
- Returns:
- the presentation template override
- Throws:
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have the appropriate access to the PresentationTemplate
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the PresentationTemplate
DocumentId cannot be retrieved- Since:
- 8.5 CF7