de.espirit.firstspirit.access.store.pagestore

Interface Body

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, Workflowable

All Known Subinterfaces:

GCABody

public interface Body
extends IDProvider

This interface provides methods to handle the bodys of pages in the PageStore. A page in PageStore can have zero or several bodies. To get all bodies for a page use Page.getChildren(Body.class)

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Field Summary

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Method Summary

Methods

Modifier and Type	Method and Description
Section	createSection(String name, Template template) Create a new section with the given name and template.
SectionReference	createSectionReference(String name, Section sourceSection) Creates a section reference based on the given source section as new child of this body.
String	getName() Get the name of a body for a Page
boolean	isHidden() State if the body is hidden for the user
void	setHidden(boolean hidden) Set the state of the body: hide/show
void	setName(String name) Set the name of a body

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, update

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Method Detail

getName

@NotNull
String getName()

Get the name of a body for a Page

Specified by:

getName in interface StoreElement

Returns:

name of a body

Since:

3.0

setName

void setName(String name)
             throws LockException

Set the name of a body

Parameters:

name - new name of a body

Throws:

LockException - occurs if this node already locked by another user

Since:

3.0

isHidden

boolean isHidden()

State if the body is hidden for the user

Returns:

true for hidden; false for visible

Since:

3.0

setHidden

void setHidden(boolean hidden)
               throws LockException

Set the state of the body: hide/show

Parameters:

hidden - true show the body; false hide the body

Throws:

LockException - occurs if this node already locked by another user

Since:

3.0

createSection

Section createSection(String name,
                    Template template)
                      throws IllegalArgumentException,
                             LockException,
                             ElementDeletedException

Create a new section with the given name and template.

Parameters:

name - name of the section to be created

template - template instance for the section to be created (either a section or table template instance).

Returns:

new section (an instance of Section or Content2Section)

Throws:

IOException - when some error during server communication occurs

NullPointerException - when parameter template is null

IllegalArgumentException - when the provided template is an instance of TableTemplate and the page already contains a content section or the type of the template is Template.PAGE_TEMPLATE.

LockException

ElementDeletedException

Since:

3.0

createSectionReference

SectionReference createSectionReference(String name,
                                      Section sourceSection)
                                        throws LockException,
                                               ElementDeletedException

Creates a section reference based on the given source section as new child of this body.

Parameters:

sourceSection - the source section for the new section reference

Throws:

LockException

ElementDeletedException

Since:

3.0