com.ibm.workplace.wcm.api
Interface SiteAreaPrototype

All Superinterfaces:

ContentComponentContainer, Document, Editable, EditableItem, HierarchicalPrototype, Item, Localized, Prototype, SiteFrameworkContainer, com.ibm.workplace.wcm.api.Visibility, WCMApiObject, WorkflowedDocument

public interface SiteAreaPrototype
extends HierarchicalPrototype, SiteFrameworkContainer, com.ibm.workplace.wcm.api.Visibility

An interface defining an object which is a site area prototype in the repository. A SiteAreaPrototype is associated with a parent site area authoring template. Properties and attributes on the SiteAreaPrototype will become the default values for SiteAreass created from its parent SiteAreaTemplate.

Note: Saving a site area prototype by calling Workspace.save() will throw a DocumentSaveException. Saving the parent SiteAreaTemplate will update this site area prototype.

In the Authoring User Interface, the site area prototype is referred to as the Default Site Area.

Since:

8.0

See Also:

SiteAreaTemplate

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.workplace.wcm.api.SiteFrameworkContainer

SiteFrameworkContainer.RenderingBehaviour

Nested classes/interfaces inherited from interface com.ibm.workplace.wcm.api.Visibility

com.ibm.workplace.wcm.api.Visibility.Scope

Method Summary

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

addSiteArea, addTemplateMapping, getAllChildren, getAllChildren, getAllDirectChildren, getAllDirectChildren, getAuthoringTemplateIds, getChildren, getChildren, getDefaultContent, getDirectChildren, getDirectChildren, getLinkedChildren, getParent, getRenderingBehaviour, getTemplateMapping, hasContent, hasDirectContent, hasLinkedContent, hasSiteArea, hasTemplateMapping, insertSiteArea, removeSiteArea, removeTemplateMapping, setDefaultContent, setRenderingBehaviour

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

addComponent, componentIterator, createComponent, getCombinedCategoryIds, getComponent, getComponentByReference, getComponentNames, hasComponent, removeComponent, setComponent

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.Visibility

getVisibilityByScope, isVisible, setVisible