com.ibm.workplace.wcm.api
Interface SiteFrameworkContainer

All Superinterfaces:

ContentComponentContainer, Document, Editable

All Known Subinterfaces:

Site, SiteArea

public interface SiteFrameworkContainer

extends ContentComponentContainer

The ability to organize and build a Site Framework is enabled by implementing the SiteFrameworkContainer interface.

A Site Framework is a hierarchy consisting of Site, SiteArea and Content objects. Site and SiteArea extends the SiteFrameworkContainer interface to provide a uniform interface when organizing and building the Site Framework.

Passing a null argument to any method of this interface will result in a NullPointerException, unless stated otherwise.

See Also:

Site, SiteArea

Method Summary

void	addSiteArea(com.ibm.workplace.wcm.api.DocumentId siteAreaId) Deprecated. use Workspace.createSiteArea(parentId, siblingId, position) instead.
void	addTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId, com.ibm.workplace.wcm.api.DocumentId presentationTemplateId) Adds a mapping for the specified AuthoringTemplate and PresentationTemplate.
com.ibm.workplace.wcm.api.DocumentIdIterator	getAllChildren() Returns a depth first iterator over all children of this Site or SiteArea.
com.ibm.workplace.wcm.api.DocumentIdIterator	getAllDirectChildren() Returns a depth first iterator over all children of this Site or SiteArea, excluding ContentLinks.
com.ibm.workplace.wcm.api.DocumentIdIterator	getAuthoringTemplateIds() Returns an iterator of DocumentId objects for the Authoring Templates associated with this container.
com.ibm.workplace.wcm.api.DocumentIdIterator	getChildren() Returns an iterator of DocumentId objects of the immediate children of this container.
com.ibm.workplace.wcm.api.DocumentId	getDefaultContent() Returns the DocumentId of the default Content object.
com.ibm.workplace.wcm.api.DocumentIdIterator	getDirectChildren() Returns an iterator of DocumentId objects of the immediate children of this container.
com.ibm.workplace.wcm.api.DocumentId	getTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId) Returns the DocumentId of the PresentationTemplate mapped to the AuthoringTemplate with the given DocumentId.
boolean	hasSiteArea(com.ibm.workplace.wcm.api.DocumentId siteAreaId) Returns true if the container has a child SiteArea with the given DocumentId.
boolean	hasTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId) Returns true if the container has a mapping for the AuthoringTemplate with the given DocumentId.
void	insertSiteArea(com.ibm.workplace.wcm.api.DocumentId priorChildId, com.ibm.workplace.wcm.api.DocumentId siteAreaId) Deprecated. use Workspace.createSiteArea(parentId, siblingId, position) instead.
void	removeSiteArea(com.ibm.workplace.wcm.api.DocumentId siteAreaId) Deprecated. use Workspace.delete(id) instead.
void	removeTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId) Removes the mapping for the AuthoringTemplate with the given DocumentId
void	setDefaultContent(com.ibm.workplace.wcm.api.DocumentId contentId) Sets the default Content for this Site or SiteArea if the DocumentId argument is not null.

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, addHistoryLogEntry, addLiveAccessMembers, addOwners, addReadAccessMembers, isChanged, removeAuthors, removeDeleteAccessMembers, removeEditAccessMembers, removeLiveAccessMembers, removeOwners, removeReadAccessMembers, setDescription, setName, setTitle

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

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

Method Detail

setDefaultContent

public void setDefaultContent(com.ibm.workplace.wcm.api.DocumentId contentId)

Sets the default Content for this Site or SiteArea if the DocumentId argument is not null. The default Content is the page that is requested if only a path to the Site or SiteArea is requested.

Parameters:

contentId - the DocumentId of the Content object to be set as the default Content for this Site or SiteArea

getDefaultContent

public com.ibm.workplace.wcm.api.DocumentId getDefaultContent()
                                                       throws AuthorizationException,
                                                              PropertyRetrievalException

Returns the DocumentId of the default Content object. If there is no default Content object set, then null will be returned.

Returns:

the DocumentId of the default Content

Throws:

AuthorizationException - if the user does not have access to default Content page

PropertyRetrievalException - if the DocumentId of the default Content page cannot be retrieved

hasTemplateMapping

public boolean hasTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId)

Returns true if the container has a mapping for the AuthoringTemplate with the given DocumentId.

Parameters:

authoringTemplateId - the DocumentId of the AuthoringTemplate to check

Returns:

true if a mapping exists for the AuthoringTemplate with the given DocumentId; false otherwise.

getTemplateMapping

public com.ibm.workplace.wcm.api.DocumentId getTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId)
                                                        throws AuthorizationException,
                                                               PropertyRetrievalException

Returns the DocumentId of the PresentationTemplate mapped to the AuthoringTemplate with the given DocumentId.

Parameters:

authoringTemplateId - the AuthoringTemplate to look up

Returns:

the DocumentId of the PresentationTemplate

Throws:

AuthorizationException - if the user does not have the appropriate access to the PresentationTemplate

PropertyRetrievalException - if the DocumentId of the PresentationTemplate cannot be retrieved

getAuthoringTemplateIds

public com.ibm.workplace.wcm.api.DocumentIdIterator getAuthoringTemplateIds()

Returns an iterator of DocumentId objects for the Authoring Templates associated with this container.

The user must have Read access to the Authoring Template for it to be included in the returned iterator.

Returns:

an iterator of DocumentId objects for the Authoring Templates associated with this container; or an empty iterator if no Authoring Templates are found.

addTemplateMapping

public void addTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId,
                               com.ibm.workplace.wcm.api.DocumentId presentationTemplateId)
                        throws DuplicateMappingException

Adds a mapping for the specified AuthoringTemplate and PresentationTemplate.

Parameters:

authoringTemplateId - the DocumentId of the AuthoringTemplate

presentationTemplateId - the DocumentId of the PresentationTemplate

Throws:

DuplicateMappingException - if the mapping already exists

removeTemplateMapping

public void removeTemplateMapping(com.ibm.workplace.wcm.api.DocumentId authoringTemplateId)

Removes the mapping for the AuthoringTemplate with the given DocumentId

Parameters:

authoringTemplateId - the DocumentId of the AuthoringTemplate

getChildren

public com.ibm.workplace.wcm.api.DocumentIdIterator getChildren()

Returns an iterator of DocumentId objects of the immediate children of this container. The children are either SiteArea, Content or ContentLink.

The user must have Read access to the SiteArea or Content for it to be included in the returned iterator.

This function will only return published Content and ContentLinks. This function's performance may not scale well to a large search result set size.

Returns:

an iterator of DocumentId objects of the immediate children of this Site or SiteArea; or an empty iterator if no immediate children are found.

getAllChildren

public com.ibm.workplace.wcm.api.DocumentIdIterator getAllChildren()

Returns a depth first iterator over all children of this Site or SiteArea. The children are either SiteArea, Content or ContentLink.

For example, a Site Framework that looks like:

 MySite1
    SiteAreaA
       SiteAreaA1
          SiteAreaA1-1
            ContentA1-1
          SiteAreaA1-2
             ContentA1-1 (Link)
       SiteAreaA2
    SiteAreaB
       SiteAreaB1
 

a call to getAllChildren() for SiteAreaA1 will return DocumentId objects for the children of SiteAreaA1 in this order:

SiteAreaA1-1, ContentA1-1, SiteAreaA1-2, ContentA1-1 (Link).

The user must have Read access to the SiteArea or Content for it to be included in the returned iterator.

This function will only return published Content and ContentLinks. This function's performance may not scale well to a large search result set size.

Returns:

an iterator of the DocumentIds of the children of this Site or SiteArea

getDirectChildren

public com.ibm.workplace.wcm.api.DocumentIdIterator getDirectChildren()

Returns an iterator of DocumentId objects of the immediate children of this container. The children are either SiteArea or Content.

The user must have Read access to the SiteArea or Content 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.

getAllDirectChildren

public com.ibm.workplace.wcm.api.DocumentIdIterator getAllDirectChildren()

Returns a depth first iterator over all children of this Site or SiteArea, excluding ContentLinks. The children are either SiteArea or Content.

For example, a Site Framework that looks like:

 MySite1
    SiteAreaA
       SiteAreaA1
          SiteAreaA1-1
            ContentA1-1
          SiteAreaA1-2
            ContentA1-1 (Link)
       SiteAreaA2
    SiteAreaB
       SiteAreaB1
 

a call to getAllDirectChildren() for SiteAreaA1 will return DocumentId objects for the children of SiteAreaA1 in this order:

SiteAreaA1-1, ContentA1-1, SiteAreaA1-2.

The user must have Read access to the SiteArea or Content for it to be included in the returned iterator.

This function will only return published Content. This function's performance may not scale well to a large search result set size.

Returns:

an iterator of the DocumentIds of the children of this Site or SiteArea

hasSiteArea

public boolean hasSiteArea(com.ibm.workplace.wcm.api.DocumentId siteAreaId)

Returns true if the container has a child SiteArea with the given DocumentId.

Parameters:

siteAreaId - the DocumentId of the SiteArea to check for

Returns:

true if the SiteArea with the given DocumentId is a child of this container; false otherwise

addSiteArea

public void addSiteArea(com.ibm.workplace.wcm.api.DocumentId siteAreaId)
                 throws DuplicateChildException

Deprecated. use Workspace.createSiteArea(parentId, siblingId, position) instead.

Adds the SiteArea with a DocumentId specified by siteAreaId as the last child of this Site or SiteArea. The Site Area being added needs to be saved after this call to complete the add operation.

Parameters:

siteAreaId - the DocumentId of the SiteArea to be added

Throws:

DuplicateChildException - if a SiteArea with the given DocumentId already exists as a child of this Site or SiteArea

WCMIllegalStateException - if the SiteArea can not be retrieved or the SiteArea already has a parent.

insertSiteArea

public void insertSiteArea(com.ibm.workplace.wcm.api.DocumentId priorChildId,
                           com.ibm.workplace.wcm.api.DocumentId siteAreaId)
                    throws DuplicateChildException

Deprecated. use Workspace.createSiteArea(parentId, siblingId, position) instead.

Inserts the SiteArea with a DocumentId specified by siteAreaId as a child of this Site or SiteArea after the SiteArea with a DocumentId of priorChildId. The Site Area being inserted needs to be saved after this call to complete the insert operation.

Parameters:

priorChildId - the DocumentId of the SiteArea to insert after

siteAreaId - the DocumentId of the SiteArea to insert

Throws:

DuplicateChildException - if a SiteArea with the given DocumentId already exists as a child of this Site or SiteArea

WCMIllegalStateException - if the SiteArea can not be retrieved or the SiteArea already has a parent.

removeSiteArea

public void removeSiteArea(com.ibm.workplace.wcm.api.DocumentId siteAreaId)

Deprecated. use Workspace.delete(id) instead.

Removes a child SiteArea with the given DocumentId from this Site or SiteArea.

If the object specified by the DocumentId argument is not a child SiteArea of this Site or SiteArea, no changes occur.

Parameters:

siteAreaId - the DocumentId of the SiteArea to remove

Throws:

WCMIllegalStateException - if there was a problem retrieving the SiteArea or removing it.