Package de.espirit.firstspirit.access.store.sitestore

Interface PageGroup

All Superinterfaces:

Comparable<StoreElement>, StoreElement, Workflowable

public interface PageGroup
extends StoreElement

This interface provides methods to handle the page-groups in the SiteStore For creating a page-group see de.espirit.firstspirit.access.store.sitestore.SiteStoreRoot

Since:

3.0

Method Summary

Modifier and Type	Method	Description
void	add(int position, PageRef member)	Add a member to this group.
void	add(PageRef member)	Convenience method to add a member at the end.
String	getId()	Provides this group's id.
List<PageRef>	getMembers()	Get a copy of the sorted list of this group's members.
@NotNull String	getName()	Get the name of the page-group
void	remove(PageRef member)	Remove a member from this group.
void	setMembers(List<PageRef> members)	Set the members for this page group from the given list keeping the given order.
void	setName(String name)	Set the name of the page-group

Methods inherited from interface java.lang.Comparable

compareTo

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, getParent, getPermission, getPermission, getPermission, getPreviousSibling, 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

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

getName

@NotNull
@NotNull String getName()

Get the name of the page-group

Specified by:

getName in interface StoreElement

Returns:

name of the page-group

Since:

3.0

setName

void setName(String name)
      throws LockException

Set the name of the page-group

Parameters:

name - new name of the page-group

Throws:

LockException

Since:

3.0

getId

String getId()

Provides this group's id.

Returns:

The id.

Since:

3.0

add

void add(PageRef member)

Convenience method to add a member at the end.

Parameters:

member - The member to add.

Since:

4.0

add

void add(int position,
 PageRef member)

Add a member to this group.

Parameters:

position - The position to add to.

member - The member to add.

Throws:

IndexOutOfBoundsException - If position < 0 or position > size.

Since:

4.0

remove

void remove(PageRef member)

Remove a member from this group.

Parameters:

member - The member to be removed.

Since:

4.0

getMembers

List<PageRef> getMembers()

Get a copy of the sorted list of this group's members.

Returns:

A copy of the sorted list of members.

Since:

4.0

setMembers

void setMembers(List<PageRef> members)

Set the members for this page group from the given list keeping the given order.

Parameters:

members - The members to set.

Since:

4.0