|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SiteFrameworkContainer
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.
Site
,
SiteArea
Nested Class Summary | |
---|---|
static class |
SiteFrameworkContainer.RenderingBehaviour
The possible rendering behaviours for a SiteArea |
Method Summary | |
---|---|
void |
addSiteArea(DocumentId siteAreaId)
Deprecated. use Workspace.createSiteArea(parentId, siblingId, position)
instead. |
void |
addTemplateMapping(DocumentId authoringTemplateId,
DocumentId presentationTemplateId)
Adds a mapping for the specified AuthoringTemplate and
PresentationTemplate . |
DocumentIdIterator |
getAllChildren()
Returns a depth first iterator over all children of this Site
or SiteArea . |
DocumentIdIterator |
getAllChildren(int workflowStatusFilter)
Returns a depth first iterator over all children of this Site
or SiteArea . |
DocumentIdIterator |
getAllDirectChildren()
Returns a depth first iterator over all children of this Site
or SiteArea , excluding ContentLinks . |
DocumentIdIterator |
getAllDirectChildren(int workflowStatusFilter)
Returns a depth first iterator over all children of this Site
or SiteArea , excluding ContentLinks . |
DocumentIdIterator |
getAuthoringTemplateIds()
Returns an iterator of DocumentId objects for the
Authoring Templates associated with this container. |
DocumentIdIterator |
getChildren()
Returns an iterator of DocumentId objects of the immediate children
of this container. |
DocumentIdIterator |
getChildren(int workflowStatusFilter)
Returns an iterator of DocumentId objects of the immediate children
of this container. |
DocumentId |
getDefaultContent()
Returns the DocumentId of the default Content object. |
DocumentIdIterator |
getDirectChildren()
Returns an iterator of DocumentId objects of the immediate children
of this container. |
DocumentIdIterator |
getDirectChildren(int workflowStatusFilter)
Returns an iterator of DocumentId objects of the immediate children
of this container. |
DocumentIdIterator |
getLinkedChildren()
Returns an iterator of DocumentId objects of the linked children
of this container. |
DocumentId |
getParent()
Deprecated. Since 8.0, use Hierarchical.getParentId() |
SiteFrameworkContainer.RenderingBehaviour |
getRenderingBehaviour()
Get the rendering behaviour of the current SiteArea . |
DocumentId |
getTemplateMapping(DocumentId authoringTemplateId)
Returns the DocumentId of the PresentationTemplate mapped
to the AuthoringTemplate with the given DocumentId . |
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 . |
boolean |
hasSiteArea(DocumentId siteAreaId)
Returns true if the container has a child SiteArea with the
given DocumentId . |
boolean |
hasTemplateMapping(DocumentId authoringTemplateId)
Returns true if the container is associated with the the AuthoringTemplate with the given DocumentId . |
void |
insertSiteArea(DocumentId priorChildId,
DocumentId siteAreaId)
Deprecated. use Workspace.createSiteArea(parentId, siblingId, position)
instead. |
void |
removeSiteArea(DocumentId siteAreaId)
Deprecated. use Workspace.delete(id) instead. |
void |
removeTemplateMapping(DocumentId authoringTemplateId)
Removes the mapping for the AuthoringTemplate with the given
DocumentId |
void |
setDefaultContent(DocumentId contentId)
Sets the default Content for this Site or SiteArea if
the DocumentId argument is not null. |
void |
setRenderingBehaviour(SiteFrameworkContainer.RenderingBehaviour renderingBehaviour)
Sets the rendering behaviour of the current SiteArea . |
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.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 |
Method Detail |
---|
SiteFrameworkContainer.RenderingBehaviour getRenderingBehaviour()
SiteArea
.
void setRenderingBehaviour(SiteFrameworkContainer.RenderingBehaviour renderingBehaviour)
SiteArea
.
renderingBehaviour
- The rendering behaviour to setvoid setDefaultContent(DocumentId contentId)
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.
contentId
- the DocumentId
of the Content
object to be
set as the default Content
for this Site
or SiteArea
DocumentId getDefaultContent() throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
DocumentId
of the default Content
object. If
there is no default Content
object set, then null will be
returned.
DocumentId
of the default Content
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have access to default
Content
page
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the DocumentId
of the default
Content
page cannot be retrievedboolean hasTemplateMapping(DocumentId authoringTemplateId)
AuthoringTemplate
with the given DocumentId
.
authoringTemplateId
- the DocumentId
of the
AuthoringTemplate
to check
AuthoringTemplate
with the given DocumentId
; false otherwise.DocumentId getTemplateMapping(DocumentId authoringTemplateId) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
DocumentId
of the PresentationTemplate
mapped
to the AuthoringTemplate
with the given DocumentId
.
A PropertyRetrievalException
is thrown if the
authoring template is not associated with the container, or if authoring template is mapped to a
presentation template, but the presentation template can not be retrieved.
For PortalPage
s, returns null if the container is associated with the given authoring template,
but the authoring template is not mapped to a presentation template.
authoringTemplateId
- the AuthoringTemplate
to look up
DocumentId
of the PresentationTemplate
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have the appropriate access to the
PresentationTemplate
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the DocumentId
of the
PresentationTemplate
cannot be retrievedDocumentIdIterator getAuthoringTemplateIds()
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.
DocumentId
objects for the
Authoring Templates
associated with this container;
or an empty iterator if no Authoring Templates
are found.void addTemplateMapping(DocumentId authoringTemplateId, DocumentId presentationTemplateId) throws com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
AuthoringTemplate
and
PresentationTemplate
.
For PortalPage
s, the PresentationTemplate
can be null to associate an authoring template
that does not have a mapped presentation template.
authoringTemplateId
- the DocumentId
of the AuthoringTemplate
presentationTemplateId
- the DocumentId
of the PresentationTemplate
com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
- if the mapping already existsvoid removeTemplateMapping(DocumentId authoringTemplateId)
AuthoringTemplate
with the given
DocumentId
authoringTemplateId
- the DocumentId
of the
AuthoringTemplate
DocumentIdIterator getChildren()
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.
DocumentId
objects of the immediate
children of this Site
or SiteArea
; or an empty iterator if
no immediate children are found.DocumentIdIterator getChildren(int workflowStatusFilter)
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.
This method supports searching for draft
(Workspace.WORKFLOWSTATUS_DRAFT
),published
(Workspace.WORKFLOWSTATUS_PUBLISHED
) or expired
(Workspace.WORKFLOWSTATUS_EXPIRED
) items or all items
regardless of their workflow status (Workspace.WORKFLOWSTATUS_ALL
).
A combination of workflow status can be specified using a bitwise OR. For
example Workspace.WORKFLOWSTATUS_PUBLISHED | Workspace.WORKFLOWSTATUS_EXPIRED
.
workflowStatusFilter
- the constant to say whether to retrieve DRAFT, PUBLISHED, and/or EXPIRED
DocumentId
objects of the immediate
children of this Site
or SiteArea
; or an empty iterator if
no immediate children are found.DocumentIdIterator getAllChildren()
Site
or SiteArea
. The children are either SiteArea
,
Content
or ContentLink
.
For example, a Site Framework that looks like:
a call toMySite1 SiteAreaA SiteAreaA1 SiteAreaA1-1 ContentA1-1 SiteAreaA1-2 ContentA1-1 (Link) SiteAreaA2 SiteAreaB SiteAreaB1
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.
DocumentId
s of the children of this Site
or SiteArea
DocumentIdIterator getAllChildren(int workflowStatusFilter)
Site
or SiteArea
. The children are either SiteArea
,
Content
or ContentLink
.
For example, a Site Framework that looks like:
a call toMySite1 SiteAreaA SiteAreaA1 SiteAreaA1-1 ContentA1-1 SiteAreaA1-2 ContentA1-1 (Link) SiteAreaA2 SiteAreaB SiteAreaB1
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.
* This method supports searching for draft
(Workspace.WORKFLOWSTATUS_DRAFT
),published
(Workspace.WORKFLOWSTATUS_PUBLISHED
) or expired
(Workspace.WORKFLOWSTATUS_EXPIRED
) items or all items
regardless of their workflow status (Workspace.WORKFLOWSTATUS_ALL
).
A combination of workflow status can be specified using a bitwise OR. For
example Workspace.WORKFLOWSTATUS_PUBLISHED | Workspace.WORKFLOWSTATUS_EXPIRED
.
workflowStatusFilter
- the constant to say whether to retrieve DRAFT, PUBLISHED, and/or EXPIRED
DocumentId
s of the children of this Site
or SiteArea
DocumentIdIterator getDirectChildren()
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.
DocumentId
objects of the immediate
children of this SiteArea
; or an empty iterator if
no immediate children are found.DocumentIdIterator getDirectChildren(int workflowStatusFilter)
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.
This method supports searching for draft
(Workspace.WORKFLOWSTATUS_DRAFT
),published
(Workspace.WORKFLOWSTATUS_PUBLISHED
) or expired
(Workspace.WORKFLOWSTATUS_EXPIRED
) items or all items
regardless of their workflow status (Workspace.WORKFLOWSTATUS_ALL
).
A combination of workflow status can be specified using a bitwise OR. For
example Workspace.WORKFLOWSTATUS_PUBLISHED | Workspace.WORKFLOWSTATUS_EXPIRED
.
workflowStatusFilter
- the constant to say whether to retrieve DRAFT, PUBLISHED, and/or EXPIRED
DocumentId
objects of the immediate
children of this SiteArea
; or an empty iterator if
no immediate children are found.DocumentIdIterator getAllDirectChildren()
Site
or SiteArea
, excluding ContentLinks
. The children
are either SiteArea
or Content
.
For example, a Site Framework that looks like:
a call toMySite1 SiteAreaA SiteAreaA1 SiteAreaA1-1 ContentA1-1 SiteAreaA1-2 ContentA1-1 (Link) SiteAreaA2 SiteAreaB SiteAreaB1
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.
DocumentIds
of the children of this Site
or SiteArea
DocumentIdIterator getAllDirectChildren(int workflowStatusFilter)
Site
or SiteArea
, excluding ContentLinks
. The children
are either SiteArea
or Content
.
For example, a Site Framework that looks like:
a call toMySite1 SiteAreaA SiteAreaA1 SiteAreaA1-1 ContentA1-1 SiteAreaA1-2 ContentA1-1 (Link) SiteAreaA2 SiteAreaB SiteAreaB1
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.
This method supports searching for draft
(Workspace.WORKFLOWSTATUS_DRAFT
),published
(Workspace.WORKFLOWSTATUS_PUBLISHED
) or expired
(Workspace.WORKFLOWSTATUS_EXPIRED
) items or all items
regardless of their workflow status (Workspace.WORKFLOWSTATUS_ALL
).
A combination of workflow status can be specified using a bitwise OR. For
example Workspace.WORKFLOWSTATUS_PUBLISHED | Workspace.WORKFLOWSTATUS_EXPIRED
.
workflowStatusFilter
- the constant to say whether to retrieve DRAFT, PUBLISHED, and/or EXPIRED
DocumentIds
of the children of this Site
or SiteArea
boolean hasSiteArea(DocumentId siteAreaId)
SiteArea
with the
given DocumentId
.
siteAreaId
- the DocumentId
of the SiteArea
to check for
SiteArea
with the given DocumentId
is a child of this container; false otherwisevoid addSiteArea(DocumentId siteAreaId) throws com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Workspace.createSiteArea(parentId, siblingId, position)
instead.
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.
siteAreaId
- the DocumentId
of the SiteArea
to be added
com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
- if a SiteArea
with the given DocumentId
already exists as a child of this Site
or SiteArea
com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException
- if the SiteArea
can not be retrieved
or the SiteArea already has a parent.
void insertSiteArea(DocumentId priorChildId, DocumentId siteAreaId) throws com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Workspace.createSiteArea(parentId, siblingId, position)
instead.
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.
priorChildId
- the DocumentId
of the SiteArea
to insert aftersiteAreaId
- the DocumentId
of the SiteArea
to insert
com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
- if a SiteArea
with the given DocumentId
already exists as a child of this Site
or SiteArea
com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException
- if the SiteArea
can not be retrieved
or the SiteArea already has a parent.
void removeSiteArea(DocumentId siteAreaId)
Workspace.delete(id)
instead.
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.
This method has been modified to only perform delete operation. To move a site area
use Workspace.moveSiteFrameworkDocument
.
siteAreaId
- the DocumentId
of the SiteArea
to remove
com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException
- if there was a problem retrieving the
SiteArea
or removing it.boolean hasContent(DocumentId contentId)
SiteArea
object has a
direct child or link to Content
with the given DocumentId
.
contentId
- the ID of the content
SiteArea
object has a child with
the given DocumentId
; false otherwise.boolean hasDirectContent(DocumentId contentId)
SiteArea
object has a
direct child Content
with the given DocumentId
.
contentId
- the ID of the content
SiteArea
object has a child with
the given DocumentId
; false otherwise.boolean hasLinkedContent(DocumentId contentId)
SiteArea
object has a
content link to the Content
with the given DocumentId
.
contentId
- the ID of the content
SiteArea
object has a content link to
the given DocumentId
; false otherwise.DocumentId getParent()
Hierarchical.getParentId()
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
, or if this is a top level site area.
DocumentId
of the parent of this SiteArea
.DocumentIdIterator getLinkedChildren() throws com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
DocumentId
objects of the linked children
of this container. The children are ContentLink
s.
The user must have Read access to the ContentLink
for it to be included in the returned iterator.
DocumentId
objects of the immediate
children of this SiteArea
; or an empty iterator if
no immediate children are found.
com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
- if there was a problem retrieving the linked children.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |