com.ibm.workplace.wcm.api
Interface SiteAreaTemplate
- All Superinterfaces:
- AbstractAuthoringTemplate, Document, Editable, EditableItem, Hierarchical, HierarchicalTemplate, Item, Localized, WCMApiObject, WorkflowedDocument
public interface SiteAreaTemplate
- extends HierarchicalTemplate
Represents a site area authoring template. Site Area Authoring Templates are used to define
the types of site areas that can be created within the content management system.
New SiteArea
objects will derive their default attributes from
the SiteAreaTemplate
defined during its creation.
The SiteAreaPrototype
of the SiteAreaTemplate
is used to define the set of ContentComponent
s that make
up the target SiteArea
type.
- Since:
- 8.0
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 |
getGenericPrototype
SiteAreaPrototype getGenericPrototype()
- Returns the
SiteAreaPrototype
for this authoring template. To update
the site area prototype, save this authoring template.
This is the same as getSiteAreaPrototype()
.
- Specified by:
getGenericPrototype
in interface AbstractAuthoringTemplate
- Specified by:
getGenericPrototype
in interface HierarchicalTemplate
- Returns:
- a reference to the site area prototype
getSiteAreaPrototype
SiteAreaPrototype getSiteAreaPrototype()
- Returns the
SiteAreaPrototype
for this authoring template. To update
the site area prototype, save this authoring template.
This is the same as getGenericPrototype()
.
- Returns:
- a reference to the site area prototype
getItemProperties
SiteAreaTemplateItemProperties getItemProperties()
- Return the item properties for this site area template.
To have changes to the item properties persist, you must save this site area template.
- Specified by:
getItemProperties
in interface AbstractAuthoringTemplate
- Returns:
- Item properties of site area template.