Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.workplace.wcm.api
Interface SiteArea
- All Superinterfaces:
- ContentComponentContainer, Document, Editable, SiteFrameworkContainer, WorkflowedDocument
public interface SiteArea- extends SiteFrameworkContainer
Represents a SiteArea object.
SiteArea objects are grouped by Site objects to form the Site Framework.
Like Site objects, SiteArea objects can specify a relationship between AuthoringTemplate and PresentationTemplate objects. However, any relationship specified in a SiteArea will override the relationship specified in a Site.
An important feature of SiteArea objects to note is the ability to add Content objects. Adding a Content to a SiteArea groups the Content and will determine where the Content lies in the Site Framework.
A SiteArea may be the child of a Site or another SiteArea. A SiteArea may also be the parent of another SiteArea. Passing a null argument to a method of this interface will result in a NullPointerException, unless stated otherwise.
- See Also:
- Site
Method Summary void addContent(DocumentId contentId)
Deprecated. use Workspace.createContent(authoringTemplateId, parentSiteId, siblingId, position) insteadDocumentIdIterator getLinkedChildren()
Returns an iterator of DocumentId objects of the linked children of this container.DocumentId getParent()
Returns the DocumentId of the parent of this SiteArea.boolean hasContent(DocumentId contentId)
Returns true if this SiteArea object has a direct child or link to Content with the given DocumentId.boolean hasDirectContent(DocumentId contentId)
Returns true if this SiteArea object has a direct child Content with the given DocumentId.boolean hasLinkedContent(DocumentId contentId)
Returns true if this SiteArea object has a content link to the Content with the given DocumentId.void insertContent(DocumentId priorChildId, DocumentId contentId)
Deprecated. use Workspace.createContent(authoringTemplateId, parentSiteId, siblingId, position) insteadvoid removeContent(DocumentId contentId)
Deprecated. use Workspace.delete(DocumentId) instead.
Methods inherited from interface com.ibm.workplace.wcm.api.SiteFrameworkContainer addSiteArea, addTemplateMapping, getAllChildren, getAllChildren, getAllDirectChildren, getAllDirectChildren, getAuthoringTemplateIds, getChildren, getChildren, getDefaultContent, getDirectChildren, getDirectChildren, getTemplateMapping, hasSiteArea, hasTemplateMapping, insertSiteArea, removeSiteArea, removeTemplateMapping, setDefaultContent
Methods inherited from interface com.ibm.workplace.wcm.api.ContentComponentContainer addComponent, componentIterator, createComponent, getComponent, getComponentByReference, getComponentNames, hasComponent, removeComponent, setComponent
Method Detail hasContent
boolean hasContent(DocumentId contentId)
- Returns true if this SiteArea object has a direct child or link to Content with the given DocumentId.
- Parameters:
- contentId - the ID of the content
- Returns:
- true if this SiteArea object has a child with the given DocumentId; false otherwise.
hasDirectContent
boolean hasDirectContent(DocumentId contentId)
- Returns true if this SiteArea object has a direct child Content with the given DocumentId.
- Parameters:
- contentId - the ID of the content
- Returns:
- true if this SiteArea object has a child with the given DocumentId; false otherwise.
hasLinkedContent
boolean hasLinkedContent(DocumentId contentId)
- Returns true if this SiteArea object has a content link to the Content with the given DocumentId.
- Parameters:
- contentId - the ID of the content
- Returns:
- true if this SiteArea object has a content link to the given DocumentId; false otherwise.
addContent
void addContent(DocumentId contentId) throws DuplicateChildException
- Deprecated. use Workspace.createContent(authoringTemplateId, parentSiteId, siblingId, position) instead
- Adds the Content with the specified DocumentId as the last child of this SiteArea. If the specified Content already has a parent, a ContentLink will be created instead.
- Parameters:
- contentId - the DocumentId of the Content to add
- Throws:
- DuplicateChildException - if a Content with the given DocumentId already exists as a child of this SiteArea
- WCMIllegalStateException - if there's a problem retrieving the content document or creating a content link.
insertContent
void insertContent(DocumentId priorChildId, DocumentId contentId) throws DuplicateChildException
- Deprecated. use Workspace.createContent(authoringTemplateId, parentSiteId, siblingId, position) instead
- Inserts the Content with a DocumentId specified by contentId as a child of this SiteArea after the Content with a DocumentId of priorChildId. If the specified Content already has a parent, a ContentLink will be created instead.
- Parameters:
- priorChildId - the DocumentId of the child Content to insert after
- contentId - the DocumentId of the Content to add
- Throws:
- DuplicateChildException - if a Content with the given DocumentId already exists as a child of this SiteArea
- WCMIllegalStateException - if there's a problem retrieving the content document or creating a content link.
removeContent
void removeContent(DocumentId contentId) throws DuplicateChildException
- Deprecated. use Workspace.delete(DocumentId) instead.
- Removes a child Content with the given DocumentId from the this SiteArea. If the Content is linked to other SiteAreas, the first ContentLink is removed, and the Content is moved to the link's SiteArea. Otherwise the given Content or ContentLink is removed.
- Parameters:
- contentId - the DocumentId of the Content to remove
- Throws:
- WCMIllegalStateException - if there a problem retrieving the Content retrieving the Content's links, removing the Content, or removing a ContentLink.
- DuplicateChildException - if the Content is moved to a SiteArea that already has a child with the same name.
getParent
DocumentId getParent()
- Returns the DocumentId of the parent of this SiteArea.
The parent of this SiteArea may be a Site or another SiteArea.
This method will return null if the user does not have access to the parent of this SiteArea.
- Returns:
- the DocumentId of the parent of this SiteArea.
getLinkedChildren
DocumentIdIterator getLinkedChildren() throws DocumentRetrievalException
- Returns an iterator of DocumentId objects of the linked children of this container. The children are ContentLinks.
The user must have Read access to the ContentLink for it to be included in the returned iterator.
- Returns:
- an iterator of DocumentId objects of the immediate children of this SiteArea; or an empty iterator if no immediate children are found.
- Throws:
- DocumentRetrievalException - if there was a problem retrieving the linked children.
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD