org.opencms.xml.containerpage
Class CmsContainerPageBean

java.lang.Object
  org.opencms.xml.containerpage.CmsContainerPageBean

public class CmsContainerPageBean
extends java.lang.Object

Describes one locale of a container page.

Since:

8.0

Constructor Summary

CmsContainerPageBean(java.util.Locale locale, java.util.List<CmsContainerBean> containers)
Creates a new container page bean.

Method Summary

boolean	containsElement(CmsUUID elementId) Returns true if the element with the provided id is contained in this container.
java.util.Map<java.lang.String,CmsContainerBean>	getContainers() Returns all container of this page.
java.util.Map<CmsUUID,java.lang.Boolean>	getContainsElement() Returns a lazy initialized map that describes if a certain element if part of this container.
java.util.List<CmsUUID>	getElementIds() Returns the id's of all elements in this container.
java.util.List<CmsContainerElementBean>	getElements() Returns the elements of all containers in this page.
java.util.Locale	getLocale() Returns the locale.
java.util.List<java.lang.String>	getNames() Returns the list of container names.
java.util.Set<java.lang.String>	getTypes() Returns the types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsContainerPageBean

public CmsContainerPageBean(java.util.Locale locale,
                            java.util.List<CmsContainerBean> containers)

Creates a new container page bean.

Parameters:

locale - the locale

containers - the containers

Method Detail

containsElement

public boolean containsElement(CmsUUID elementId)

Returns true if the element with the provided id is contained in this container.

Parameters:

elementId - the element id to check

Returns:

true if the element with the provided id is contained in this container

getContainers

public java.util.Map<java.lang.String,CmsContainerBean> getContainers()

Returns all container of this page.

Returns:

all container of this page

getContainsElement

public java.util.Map<CmsUUID,java.lang.Boolean> getContainsElement()

Returns a lazy initialized map that describes if a certain element if part of this container.

Returns:

a lazy initialized map that describes if a certain element if part of this container

getElementIds

public java.util.List<CmsUUID> getElementIds()

Returns the id's of all elements in this container.

Returns:

the id's of all elements in this container

getElements

public java.util.List<CmsContainerElementBean> getElements()

Returns the elements of all containers in this page.

Returns:

the elements of all containers in this page

getLocale

public java.util.Locale getLocale()

Returns the locale.

Returns:

the locale

getNames

public java.util.List<java.lang.String> getNames()

Returns the list of container names.

Returns:

the list of container names

getTypes

public java.util.Set<java.lang.String> getTypes()

Returns the types.

Returns:

the types