com.ibm.workplace.wcm.api
Interface SiteArea

All Superinterfaces:

ContentComponentContainer, Document, Editable, SiteFrameworkContainer

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

Field Summary

static java.lang.String

COPYRIGHT Copyright statement

Method Summary

void	addContent(DocumentId p_contentId) Adds the Content with the specified DocumentId as the last child of this SiteArea.
DocumentId	getParent() Returns the DocumentId of the parent of this SiteArea.
boolean	hasContent(DocumentId p_contentId) Returns true if this SiteArea object has a child Content with the given DocumentId.
void	insertContent(DocumentId p_priorChildId, DocumentId p_contentId) Inserts the Content with a DocumentId specified by p_contentId as a child of this SiteArea after the Content with a DocumentId of p_priorChildId.
void	removeContent(DocumentId p_contentId) Removes a child Content with the given DocumentId from the this SiteArea.

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

addSiteArea, addTemplateMapping, getAllChildren, getAuthoringTemplateIds, getChildren, getDefaultContent, 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

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

addAuthors, addDeleteAccessMembers, addEditAccessMembers, addLiveAccessMembers, addOwners, addReadAccessMembers, isChanged, removeAuthors, removeDeleteAccessMembers, removeEditAccessMembers, removeLiveAccessMembers, removeOwners, removeReadAccessMembers, setDescription, setName

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

getAuthors, getDeleteAccessMembers, getDescription, getEditAccessMembers, getId, getLiveAccessMembers, getModifiedDate, getName, getOwners, getReadAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement

See Also:

Constant Field Values

Method Detail

hasContent

public boolean hasContent(DocumentId p_contentId)

Returns true if this SiteArea object has a child Content with the given DocumentId.

Parameters:

p_contentId - the ID of the content

Returns:

true if this SiteArea object has a child with the given DocumentId; false otherwise.

addContent

public void addContent(DocumentId p_contentId)
                throws DuplicateChildException

Adds the Content with the specified DocumentId as the last child of this SiteArea.

Parameters:

p_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

insertContent

public void insertContent(DocumentId p_priorChildId,
                          DocumentId p_contentId)
                   throws DuplicateChildException

Inserts the Content with a DocumentId specified by p_contentId as a child of this SiteArea after the Content with a DocumentId of p_priorChildId.

Parameters:

p_priorChildId - the DocumentId of the child Content to insert after

p_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

removeContent

public void removeContent(DocumentId p_contentId)

Removes a child Content with the given DocumentId from the this SiteArea.

Parameters:

p_contentId - the DocumentId of the Content to remove

getParent

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