Package org.opencms.ade.containerpage

Class CmsContainerpageService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

org.opencms.gwt.CmsGwtService

org.opencms.ade.containerpage.CmsContainerpageService

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, I_CmsContainerpageService

public class CmsContainerpageService
extends CmsGwtService
implements I_CmsContainerpageService

The RPC service used by the container-page editor.

Since:

8.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDINFO_EDIT_SMALL_ELEMENTS	Additional info key for storing the "edit small elements" setting on the user.
static final String	ATTR_CLIPBOARD_TAB	Session attribute name used to store the selected clipboard tab.
static final int	MAX_VISIBLE_ELEMENT_USES	Maximum number of reuse locations to display in the reuse warning dialog.
static final String	MODEL_GROUP_PATH_FRAGMENT	The model group pages path fragment.
static final String	PARAM_PAGE_EDITOR_PLACEMENT_MODE_ENABLED	Runtime property key to enable / disable placement mode.
static final String	SOURCE_CONTAINERPAGE_ID_SETTING	The source container page id settings key.

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Constructor Summary

Constructors

Constructor	Description
CmsContainerpageService()

Method Summary

Modifier and Type	Method	Description
void	addToFavoriteList(CmsContainerPageRpcContext context, String clientId)	Adds an element specified by it's id to the favorite list.
void	addToRecentList(CmsContainerPageRpcContext context, String clientId)	Adds an element specified by it's id to the recent list.
boolean	checkContainerpageOrElementsChanged(CmsUUID structureId, CmsUUID detailContentId, String contentLocale)	Check if a page or its elements have been changed.
CmsCreateElementData	checkCreateNewElement(CmsUUID pageStructureId, CmsUUID detailContentId, String clientId, String resourceType, CmsContainer container, String locale)	To create a new element of the given type this method will check if a model resource needs to be selected, otherwise creates the new element.
boolean	checkNewWidgetsAvailable(CmsUUID structureId)	Checks whether the Acacia widgets are available for all fields of the content.
CmsUUID	convertToServerId(String id)	Parses an element id.
CmsUUID	copyElement(CmsUUID pageId, CmsUUID originalElementId, String locale)	Creates a new element with a given model element and returns the copy'S structure id.
CmsContainerElement	createNewElement(CmsUUID pageStructureId, CmsUUID detailContentId, String clientId, String resourceType, CmsUUID modelResourceStructureId, String locale)	Creates a new element of the given type and returns the new element data containing structure id and site path.
static List<CmsModelResourceInfo>	generateModelResourceList(CmsObject cms, String resourceType, List<CmsResource> modelResources, Locale contentLocale)	Generates the model resource data list.
CmsContainerElementBean	getCachedElement(String clientId, String pageRootPath)	Reads the cached element-bean for the given client-side-id from cache.
CmsContainer	getContainerInfo()	This method is used for serialization purposes only.
CmsDialogOptionsAndInfo	getDeleteOptions(String clientId, CmsUUID pageId, String requestParams)	Returns the delete options.
CmsDialogOptionsAndInfo	getEditOptions(String clientId, CmsUUID pageId, String requestParams, boolean isListElement)	Returns the edit options.
CmsContainerElement	getElementInfo()	This method is used for serialization purposes only.
Map<String,CmsContainerElementData>	getElementsData(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, Collection<String> clientIds, Collection<CmsContainer> containers, boolean allwaysCopy, String dndSource, String locale)	Returns container element data by client id.
CmsElementSettingsConfig	getElementSettingsConfig(CmsContainerPageRpcContext context, String clientId, String containerId, Collection<CmsContainer> containers, String locale)	Returns container element settings config data.
Set<CmsUUID>	getElementsLockedForPublishing(Set<CmsUUID> idsToCheck)	Checks which structure ids of a given set belong to resources locked for publishing by the current user, and then returns those.
CmsContainerElementData	getElementWithSettings(CmsContainerPageRpcContext context, CmsUUID detailContentId, String uriParams, String clientId, Map<String,String> settings, Collection<CmsContainer> containers, String locale)	Gets the element data for an id and a map of settings.
List<CmsContainerElementData>	getFavoriteList(CmsUUID pageStructureId, CmsUUID detailContentId, Collection<CmsContainer> containers, String locale)	Returns the container element data of the favorite list.
CmsContainerPageGalleryData	getGalleryDataForPage(List<CmsContainer> containers, CmsUUID elementView, String uri, CmsUUID detailContentId, String locale, CmsTemplateContextInfo templateContextInfo)	Returns the gallery configuration data according to the current page containers and the selected element view.
CmsListElementCreationDialogData	getListElementCreationOptions(CmsUUID structureId, String jsonListAddData)	Loads the data for the list element creation dialog.
CmsContainerElementData	getNewElementData(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, String resourceType, Collection<CmsContainer> containers, String localeName)	Returns new container element data for the given resource type name.
CmsDialogOptionsAndInfo	getNewOptions(String clientId, CmsUUID pageStructureId, String requestParams)	Gets the edit handler options for creating a new element.
List<CmsContainerElementData>	getRecentList(CmsUUID pageStructureId, CmsUUID detailContentId, Collection<CmsContainer> containers, String locale)	Returns the container element data of the recent list.
CmsRemovedElementStatus	getRemovedElementStatus(String id, CmsUUID contextId, CmsUUID containerpageId)	Gets the status of a removed element.
CmsReuseInfo	getReuseInfo(CmsUUID pageId, CmsUUID detailId, CmsUUID elementId)	Loads the reuse information for a container element.
static String	getSerializedContainerInfo(CmsContainer container)	Returns serialized container data.
static String	getSerializedElementInfo(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsContainerElementBean elementBean, CmsContainerPageBean page)	Returns the serialized element data.
void	handleDelete(String clientId, String deleteOption, CmsUUID pageId, String requestParams)	Handles the element deletion.
CmsRemovedElementStatus	internalGetRemovedElementStatus(CmsUUID structureId, CmsUUID contextId, CmsUUID containerpageId)	Internal helper method to get the status of a removed element.
static boolean	isEditingModelGroups(CmsObject cms, CmsResource containerPage)	Checks whether the current page is a model group page.
int	loadClipboardTab()	Loads the index of the clipboard tab last selected by the user.
CmsCntPageData	prefetch()	Returns the initialization data.
static CmsCntPageData	prefetch(javax.servlet.http.HttpServletRequest request)	Fetches the container page data.
CmsUUID	prepareForEdit(String clientId, String editOption, CmsUUID pageId, String requestParams)	Prepares an element to be edited.
CmsContainerElementData	replaceElement(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, String clientId, String replaceId, Collection<CmsContainer> containers, String locale)	Returns the element data to replace a given content element with another while keeping it's settings.
void	saveClipboardTab(int tabIndex)	Saves the index of the clipboard tab selected by the user.
CmsPageSaveStatus	saveContainerpage(CmsUUID pageStructureId, List<CmsContainer> containers)	Saves the container-page.
CmsPageSaveStatus	saveDetailContainers(CmsUUID detailId, String detailContainerResource, List<CmsContainer> containers)	Saves the detail containers.
CmsContainerElementData	saveElementSettings(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, String clientId, Map<String,String> settings, List<CmsContainer> containers, String locale)	Saves the settings for the given element to the container page and returns the updated element data.
void	saveFavoriteList(List<String> clientIds, String uri)	Saves the favorite list.
CmsGroupContainerSaveResult	saveGroupContainer(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, CmsGroupContainer groupContainer, Collection<CmsContainer> containers, String locale)	Saves a group-container element.
Map<String,CmsContainerElementData>	saveInheritanceContainer(CmsUUID pageStructureId, CmsUUID detailContentId, CmsInheritanceContainer inheritanceContainer, Collection<CmsContainer> containers, String locale)	Saves an inheritance container.
void	saveRecentList(List<String> clientIds, String uri)	Saves the recent list.
void	setEditSmallElements(boolean editSmallElements)	Enables or disables editing for small elements on page load.
void	setElementView(CmsUUID elementView)	Sets the element view.
void	setLastPage(CmsUUID pageId, CmsUUID detailId)	Stores information about the container page last edited.
void	setSessionCache(CmsADESessionCache cache)	Sets the session cache.
static void	unlockPage(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Unlocks a page or set of pages if they are locked by the current user.

Methods inherited from class org.opencms.gwt.CmsGwtService

checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, isBroadcastCall, log, log, logError, service, setBroadcastPoll, setCms, setContext, setRequest, setResponse, tryUnlock

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init

Methods inherited from class java.lang.Object

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

Field Details

PARAM_PAGE_EDITOR_PLACEMENT_MODE_ENABLED

public static final String PARAM_PAGE_EDITOR_PLACEMENT_MODE_ENABLED

Runtime property key to enable / disable placement mode.

See Also:

• Constant Field Values

ADDINFO_EDIT_SMALL_ELEMENTS

public static final String ADDINFO_EDIT_SMALL_ELEMENTS

Additional info key for storing the "edit small elements" setting on the user.

See Also:

• Constant Field Values

ATTR_CLIPBOARD_TAB

public static final String ATTR_CLIPBOARD_TAB

Session attribute name used to store the selected clipboard tab.

See Also:

• Constant Field Values

MODEL_GROUP_PATH_FRAGMENT

public static final String MODEL_GROUP_PATH_FRAGMENT

The model group pages path fragment.

See Also:

• Constant Field Values

SOURCE_CONTAINERPAGE_ID_SETTING

public static final String SOURCE_CONTAINERPAGE_ID_SETTING

The source container page id settings key.

See Also:

• Constant Field Values

MAX_VISIBLE_ELEMENT_USES

public static final int MAX_VISIBLE_ELEMENT_USES

Maximum number of reuse locations to display in the reuse warning dialog.

See Also:

• Constant Field Values

Constructor Details

CmsContainerpageService

public CmsContainerpageService()

Method Details

generateModelResourceList

public static List<CmsModelResourceInfo> generateModelResourceList(CmsObject cms,
 String resourceType,
 List<CmsResource> modelResources,
 Locale contentLocale)
                                                            throws CmsException

Generates the model resource data list.

Parameters:

cms - the cms context

resourceType - the resource type name

modelResources - the model resource

contentLocale - the content locale

Returns:

the model resources data

Throws:

CmsException - if something goes wrong reading the resource information

getSerializedContainerInfo

public static String getSerializedContainerInfo(CmsContainer container)
                                         throws Exception

Returns serialized container data.

Parameters:

container - the container

Returns:

the serialized data

Throws:

Exception - if serialization fails

getSerializedElementInfo

public static String getSerializedElementInfo(CmsObject cms,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 CmsContainerElementBean elementBean,
 CmsContainerPageBean page)
                                       throws Exception

Returns the serialized element data.

Parameters:

cms - the cms context

request - the servlet request

response - the servlet response

elementBean - the element to serialize

page - the container page

Returns:

the serialized element data

Throws:

Exception - if something goes wrong

isEditingModelGroups

public static boolean isEditingModelGroups(CmsObject cms,
 CmsResource containerPage)

Checks whether the current page is a model group page.

Parameters:

cms - the CMS context

containerPage - the current page

Returns:

true if the current page is a model group page

prefetch

public static CmsCntPageData prefetch(javax.servlet.http.HttpServletRequest request)
                               throws CmsRpcException

Fetches the container page data.

Parameters:

request - the current request

Returns:

the container page data

Throws:

CmsRpcException - if something goes wrong

unlockPage

public static void unlockPage(CmsObject cms,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                       throws Exception

Unlocks a page or set of pages if they are locked by the current user.

This is not called via the normal GWT-RPC mechanism, but with the browser's sendBeacon function.

Parameters:

cms - the CMS context

request - the current request

response - the current response

Throws:

Exception - if something goes wrong

addToFavoriteList

public void addToFavoriteList(CmsContainerPageRpcContext context,
 String clientId)
                       throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Adds an element specified by it's id to the favorite list.

Specified by:

addToFavoriteList in interface I_CmsContainerpageService

Parameters:

context - the rpc context

clientId - the element id

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.addToFavoriteList(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, java.lang.String)

addToRecentList

public void addToRecentList(CmsContainerPageRpcContext context,
 String clientId)
                     throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Adds an element specified by it's id to the recent list.

Specified by:

addToRecentList in interface I_CmsContainerpageService

Parameters:

context - the rpc context

clientId - the element id

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.addToRecentList(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, java.lang.String)

checkContainerpageOrElementsChanged

public boolean checkContainerpageOrElementsChanged(CmsUUID structureId,
 CmsUUID detailContentId,
 String contentLocale)
                                            throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Check if a page or its elements have been changed.

Specified by:

checkContainerpageOrElementsChanged in interface I_CmsContainerpageService

Parameters:

structureId - the structure id of the resource

detailContentId - the structure id of the detail content (may be null)

contentLocale - the content locale

Returns:

true if there were changes in the page or its elements

Throws:

CmsRpcException - if the RPC call fails

See Also:

• I_CmsContainerpageService.checkContainerpageOrElementsChanged(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String)

checkCreateNewElement

public CmsCreateElementData checkCreateNewElement(CmsUUID pageStructureId,
 CmsUUID detailContentId,
 String clientId,
 String resourceType,
 CmsContainer container,
 String locale)
                                           throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

To create a new element of the given type this method will check if a model resource needs to be selected, otherwise creates the new element. Returns a bean containing either the new element data or a list of model resources to select.

Specified by:

checkCreateNewElement in interface I_CmsContainerpageService

Parameters:

pageStructureId - the container page structure id

detailContentId - the structure id of the detail content

clientId - the client id of the new element (this will be the structure id of the configured new resource)

resourceType - the resource tape of the new element

container - the parent container

locale - the content locale

Returns:

the bean containing either the new element data or a list of model resources to select

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.checkCreateNewElement(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, org.opencms.ade.containerpage.shared.CmsContainer, java.lang.String)

checkNewWidgetsAvailable

public boolean checkNewWidgetsAvailable(CmsUUID structureId)
                                 throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Checks whether the Acacia widgets are available for all fields of the content.

Specified by:

checkNewWidgetsAvailable in interface I_CmsContainerpageService

Parameters:

structureId - the structure id of the content

Returns:

true if Acacia widgets are available for all fields

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.checkNewWidgetsAvailable(org.opencms.util.CmsUUID)

convertToServerId

public CmsUUID convertToServerId(String id)
                          throws CmsIllegalArgumentException

Parses an element id.

Parameters:

id - the element id

Returns:

the corresponding structure id

Throws:

CmsIllegalArgumentException - if the id has not the right format

copyElement

public CmsUUID copyElement(CmsUUID pageId,
 CmsUUID originalElementId,
 String locale)
                    throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Creates a new element with a given model element and returns the copy'S structure id.

Specified by:

copyElement in interface I_CmsContainerpageService

Parameters:

pageId - the container page id

originalElementId - the model element id

locale - the content locale

Returns:

the structure id of the copy

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.copyElement(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String)

createNewElement

public CmsContainerElement createNewElement(CmsUUID pageStructureId,
 CmsUUID detailContentId,
 String clientId,
 String resourceType,
 CmsUUID modelResourceStructureId,
 String locale)
                                     throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Creates a new element of the given type and returns the new element data containing structure id and site path.

Specified by:

createNewElement in interface I_CmsContainerpageService

Parameters:

pageStructureId - the container page structure id

detailContentId - the structure id of the detail content

clientId - the client id of the new element (this will be the structure id of the configured new resource)

resourceType - the resource tape of the new element

modelResourceStructureId - the model resource structure id

locale - the content locale

Returns:

the new element data containing structure id and site path

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.createNewElement(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, org.opencms.util.CmsUUID, java.lang.String)

getCachedElement

public CmsContainerElementBean getCachedElement(String clientId,
 String pageRootPath)
                                         throws CmsException

Reads the cached element-bean for the given client-side-id from cache.

Parameters:

clientId - the client-side-id

pageRootPath - the container page root path

Returns:

the cached container element bean

Throws:

CmsException - in case reading the element resource fails

getContainerInfo

public CmsContainer getContainerInfo()

Description copied from interface: I_CmsContainerpageService

This method is used for serialization purposes only.

Specified by:

getContainerInfo in interface I_CmsContainerpageService

Returns:

container info

See Also:

• I_CmsContainerpageService.getContainerInfo()

getDeleteOptions

public CmsDialogOptionsAndInfo getDeleteOptions(String clientId,
 CmsUUID pageId,
 String requestParams)
                                         throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns the delete options.

Specified by:

getDeleteOptions in interface I_CmsContainerpageService

Parameters:

clientId - the client element id

pageId - the current page structure id

requestParams - optional request parameters

Returns:

the delete options

Throws:

CmsRpcException - in case something goes wrong

See Also:

• I_CmsContainerpageService.getDeleteOptions(java.lang.String, org.opencms.util.CmsUUID, java.lang.String)

getEditOptions

public CmsDialogOptionsAndInfo getEditOptions(String clientId,
 CmsUUID pageId,
 String requestParams,
 boolean isListElement)
                                       throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns the edit options.

Specified by:

getEditOptions in interface I_CmsContainerpageService

Parameters:

clientId - the client element id

pageId - the current page structure id

requestParams - optional request parameters

isListElement - in case a list element, not a container element is about to be edited

Returns:

the edit options

Throws:

CmsRpcException - in case something goes wrong

See Also:

• I_CmsContainerpageService.getEditOptions(java.lang.String, org.opencms.util.CmsUUID, java.lang.String, boolean)

getElementInfo

public CmsContainerElement getElementInfo()

Description copied from interface: I_CmsContainerpageService

This method is used for serialization purposes only.

Specified by:

getElementInfo in interface I_CmsContainerpageService

Returns:

element info

See Also:

• I_CmsContainerpageService.getElementInfo()

getElementsData

public Map<String,CmsContainerElementData> getElementsData(CmsContainerPageRpcContext context,
 CmsUUID detailContentId,
 String reqParams,
 Collection<String> clientIds,
 Collection<CmsContainer> containers,
 boolean allwaysCopy,
 String dndSource,
 String locale)
                                                    throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns container element data by client id.

Specified by:

getElementsData in interface I_CmsContainerpageService

Parameters:

context - the rpc context

detailContentId - the detail content structure id

reqParams - optional request parameters

clientIds - the requested element id's

containers - the containers of the current page

allwaysCopy - true in case reading data for a clipboard element used as a copy group

dndSource - the drag and drop source container (if we are getting the data for the drag and drop case)

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.getElementsData(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, org.opencms.util.CmsUUID, java.lang.String, java.util.Collection, java.util.Collection, boolean, java.lang.String, java.lang.String)

getElementSettingsConfig

public CmsElementSettingsConfig getElementSettingsConfig(CmsContainerPageRpcContext context,
 String clientId,
 String containerId,
 Collection<CmsContainer> containers,
 String locale)
                                                  throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns container element settings config data.

Specified by:

getElementSettingsConfig in interface I_CmsContainerpageService

Parameters:

context - the rpc context

clientId - the requested element id

containerId - the parent container id

containers - the containers of the current page

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.getElementSettingsConfig(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, java.lang.String, java.lang.String, java.util.Collection, java.lang.String)

getElementsLockedForPublishing

public Set<CmsUUID> getElementsLockedForPublishing(Set<CmsUUID> idsToCheck)
                                            throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Checks which structure ids of a given set belong to resources locked for publishing by the current user, and then returns those.

Specified by:

getElementsLockedForPublishing in interface I_CmsContainerpageService

Parameters:

idsToCheck - the set of ids to check

Returns:

the subset of ids which belong to resources locked for publishing by the current user

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.getElementsLockedForPublishing(java.util.Set)

getElementWithSettings

public CmsContainerElementData getElementWithSettings(CmsContainerPageRpcContext context,
 CmsUUID detailContentId,
 String uriParams,
 String clientId,
 Map<String,String> settings,
 Collection<CmsContainer> containers,
 String locale)
                                               throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Gets the element data for an id and a map of settings.

Specified by:

getElementWithSettings in interface I_CmsContainerpageService

Parameters:

context - the RPC context

detailContentId - the detail content structure id

uriParams - optional request parameters

clientId - the requested element ids

settings - the settings for which the element data should be loaded

containers - the containers of the current page

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.getElementWithSettings(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.util.Map, java.util.Collection, java.lang.String)

getFavoriteList

public List<CmsContainerElementData> getFavoriteList(CmsUUID pageStructureId,
 CmsUUID detailContentId,
 Collection<CmsContainer> containers,
 String locale)
                                              throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns the container element data of the favorite list.

Specified by:

getFavoriteList in interface I_CmsContainerpageService

Parameters:

pageStructureId - the container page structure id

detailContentId - the detail content structure id

containers - the containers of the current page

locale - the content locale

Returns:

the favorite list element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.getFavoriteList(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.util.Collection, java.lang.String)

getGalleryDataForPage

public CmsContainerPageGalleryData getGalleryDataForPage(List<CmsContainer> containers,
 CmsUUID elementView,
 String uri,
 CmsUUID detailContentId,
 String locale,
 CmsTemplateContextInfo templateContextInfo)
                                                  throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns the gallery configuration data according to the current page containers and the selected element view.

Specified by:

getGalleryDataForPage in interface I_CmsContainerpageService

Parameters:

containers - the page containers

elementView - the element view

uri - the page URI

detailContentId - the detail content id

locale - the content locale

templateContextInfo - the template context information

Returns:

the gallery data

Throws:

CmsRpcException - in case something goes wrong

See Also:

• I_CmsContainerpageService.getGalleryDataForPage(java.util.List, org.opencms.util.CmsUUID, java.lang.String, org.opencms.util.CmsUUID, java.lang.String, org.opencms.gwt.shared.CmsTemplateContextInfo)

getListElementCreationOptions

public CmsListElementCreationDialogData getListElementCreationOptions(CmsUUID structureId,
 String jsonListAddData)
                                                               throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Loads the data for the list element creation dialog.

Specified by:

getListElementCreationOptions in interface I_CmsContainerpageService

Parameters:

structureId - the structure id of the container element for which we want to load the options

jsonListAddData - the list-add metadata read from the DOM

Returns:

the data for the list element creation dialog

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.getListElementCreationOptions(org.opencms.util.CmsUUID, java.lang.String)

getNewElementData

public CmsContainerElementData getNewElementData(CmsContainerPageRpcContext context,
 CmsUUID detailContentId,
 String reqParams,
 String resourceType,
 Collection<CmsContainer> containers,
 String localeName)
                                          throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns new container element data for the given resource type name.

Specified by:

getNewElementData in interface I_CmsContainerpageService

Parameters:

context - the RPC context

detailContentId - the detail content structure id

reqParams - optional request parameters

resourceType - the requested element resource type name

containers - the containers of the current page

localeName - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.getNewElementData(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.util.Collection, java.lang.String)

getNewOptions

public CmsDialogOptionsAndInfo getNewOptions(String clientId,
 CmsUUID pageStructureId,
 String requestParams)
                                      throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Gets the edit handler options for creating a new element.

Specified by:

getNewOptions in interface I_CmsContainerpageService

Parameters:

clientId - the client id of the selected element

pageStructureId - the container page structure id

requestParams - the request parameter string

Returns:

the dialog option data from the edit handler

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.getNewOptions(java.lang.String, org.opencms.util.CmsUUID, java.lang.String)

getRecentList

public List<CmsContainerElementData> getRecentList(CmsUUID pageStructureId,
 CmsUUID detailContentId,
 Collection<CmsContainer> containers,
 String locale)
                                            throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns the container element data of the recent list.

Specified by:

getRecentList in interface I_CmsContainerpageService

Parameters:

pageStructureId - the container page structure id

detailContentId - the detail content structure id

containers - the containers of the current page

locale - the content locale

Returns:

the recent list element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.getRecentList(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.util.Collection, java.lang.String)

getRemovedElementStatus

public CmsRemovedElementStatus getRemovedElementStatus(String id,
 CmsUUID contextId,
 CmsUUID containerpageId)
                                                throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Gets the status of a removed element.

Specified by:

getRemovedElementStatus in interface I_CmsContainerpageService

Parameters:

id - the client id of the removed element

contextId - the id of the resource used to look up the sitemap configuration

containerpageId - the id of the page which should be excluded from the relation check, or null if no page should be excluded

Returns:

the status of the removed element

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.getRemovedElementStatus(java.lang.String, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)

getReuseInfo

public CmsReuseInfo getReuseInfo(CmsUUID pageId,
 CmsUUID detailId,
 CmsUUID elementId)
                          throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Loads the reuse information for a container element.

Specified by:

getReuseInfo in interface I_CmsContainerpageService

Parameters:

pageId - the current page id

detailId - the current detail id

elementId - the id of the element to check

Returns:

the reuse information for the element

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.getReuseInfo(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)

handleDelete

public void handleDelete(String clientId,
 String deleteOption,
 CmsUUID pageId,
 String requestParams)
                  throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Handles the element deletion.

Specified by:

handleDelete in interface I_CmsContainerpageService

Parameters:

clientId - the client element id

deleteOption - the selected delete option

pageId - the current page structure id

requestParams - optional request parameters

Throws:

CmsRpcException - in case something goes wrong

See Also:

• I_CmsContainerpageService.handleDelete(java.lang.String, java.lang.String, org.opencms.util.CmsUUID, java.lang.String)

internalGetRemovedElementStatus

public CmsRemovedElementStatus internalGetRemovedElementStatus(CmsUUID structureId,
 CmsUUID contextId,
 CmsUUID containerpageId)
                                                        throws CmsException

Internal helper method to get the status of a removed element.

Parameters:

structureId - the structure id of the removed element

contextId - the id of the resource used to look up the sitemap configuration

containerpageId - the id of the page to exclude from the relation check, or null if no page should be excluded

Returns:

the status of the removed element

Throws:

CmsException - in case reading the resource fails

loadClipboardTab

public int loadClipboardTab()

Description copied from interface: I_CmsContainerpageService

Loads the index of the clipboard tab last selected by the user.

Specified by:

loadClipboardTab in interface I_CmsContainerpageService

Returns:

the clipboard tab index

See Also:

• I_CmsContainerpageService.loadClipboardTab()

prefetch

public CmsCntPageData prefetch()
                        throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns the initialization data.

Specified by:

prefetch in interface I_CmsContainerpageService

Returns:

the initialization data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.prefetch()

prepareForEdit

public CmsUUID prepareForEdit(String clientId,
 String editOption,
 CmsUUID pageId,
 String requestParams)
                       throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Prepares an element to be edited.

Specified by:

prepareForEdit in interface I_CmsContainerpageService

Parameters:

clientId - the client element id

editOption - the selected delete option

pageId - the current page structure id

requestParams - optional request parameters

Returns:

the structure ID of the content to edit

Throws:

CmsRpcException - in case something goes wrong

See Also:

• I_CmsContainerpageService.prepareForEdit(java.lang.String, java.lang.String, org.opencms.util.CmsUUID, java.lang.String)

replaceElement

public CmsContainerElementData replaceElement(CmsContainerPageRpcContext context,
 CmsUUID detailContentId,
 String reqParams,
 String clientId,
 String replaceId,
 Collection<CmsContainer> containers,
 String locale)
                                       throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Returns the element data to replace a given content element with another while keeping it's settings.

Specified by:

replaceElement in interface I_CmsContainerpageService

Parameters:

context - the rpc context

detailContentId - the detail content structure id

reqParams - optional request parameters

clientId - the id of the element to replace

replaceId - the id of the replacing element

containers - the containers of the current page

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.replaceElement(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.lang.String, java.util.Collection, java.lang.String)

saveClipboardTab

public void saveClipboardTab(int tabIndex)

Description copied from interface: I_CmsContainerpageService

Saves the index of the clipboard tab selected by the user.

Specified by:

saveClipboardTab in interface I_CmsContainerpageService

Parameters:

tabIndex - the index of the selected clipboard tab

See Also:

• I_CmsContainerpageService.saveClipboardTab(int)

saveContainerpage

public CmsPageSaveStatus saveContainerpage(CmsUUID pageStructureId,
 List<CmsContainer> containers)
                                    throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Saves the container-page.

Specified by:

saveContainerpage in interface I_CmsContainerpageService

Parameters:

pageStructureId - the container page structure id

containers - the container-page's containers

Returns:

the page save status

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.saveContainerpage(org.opencms.util.CmsUUID, java.util.List)

saveDetailContainers

public CmsPageSaveStatus saveDetailContainers(CmsUUID detailId,
 String detailContainerResource,
 List<CmsContainer> containers)
                                       throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Saves the detail containers.

Specified by:

saveDetailContainers in interface I_CmsContainerpageService

Parameters:

detailId - the detail content id

detailContainerResource - the detail container resource path

containers - the container-page's containers

Returns:

the page save status

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.saveDetailContainers(org.opencms.util.CmsUUID, java.lang.String, java.util.List)

saveElementSettings

public CmsContainerElementData saveElementSettings(CmsContainerPageRpcContext context,
 CmsUUID detailContentId,
 String reqParams,
 String clientId,
 Map<String,String> settings,
 List<CmsContainer> containers,
 String locale)
                                            throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Saves the settings for the given element to the container page and returns the updated element data.

Specified by:

saveElementSettings in interface I_CmsContainerpageService

Parameters:

context - the RPC context

detailContentId - the detail content structure id

reqParams - optional request parameters

clientId - the requested element ids

settings - the settings for which the element data should be loaded

containers - the containers of the current page

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.saveElementSettings(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.util.Map, java.util.List, java.lang.String)

saveFavoriteList

public void saveFavoriteList(List<String> clientIds,
 String uri)
                      throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Saves the favorite list.

Specified by:

saveFavoriteList in interface I_CmsContainerpageService

Parameters:

clientIds - favorite list element id's

uri - the container page URI

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.saveFavoriteList(java.util.List, java.lang.String)

saveGroupContainer

public CmsGroupContainerSaveResult saveGroupContainer(CmsContainerPageRpcContext context,
 CmsUUID detailContentId,
 String reqParams,
 CmsGroupContainer groupContainer,
 Collection<CmsContainer> containers,
 String locale)
                                               throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Saves a group-container element.

Specified by:

saveGroupContainer in interface I_CmsContainerpageService

Parameters:

context - the RPC context

detailContentId - the detail content structure id

reqParams - optional request parameters

groupContainer - the group-container to save

containers - the containers of the current page

locale - the content locale

Returns:

the data of the saved group container

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.saveGroupContainer(org.opencms.ade.containerpage.shared.CmsContainerPageRpcContext, org.opencms.util.CmsUUID, java.lang.String, org.opencms.ade.containerpage.shared.CmsGroupContainer, java.util.Collection, java.lang.String)

saveInheritanceContainer

public Map<String,CmsContainerElementData> saveInheritanceContainer(CmsUUID pageStructureId,
 CmsUUID detailContentId,
 CmsInheritanceContainer inheritanceContainer,
 Collection<CmsContainer> containers,
 String locale)
                                                             throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Saves an inheritance container.

Specified by:

saveInheritanceContainer in interface I_CmsContainerpageService

Parameters:

pageStructureId - the current page's structure id

detailContentId - the detail content structure id

inheritanceContainer - the inheritance container to save

containers - the containers of the current page

locale - the requested locale

Returns:

the element data of the saved container

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.saveInheritanceContainer(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, org.opencms.ade.containerpage.shared.CmsInheritanceContainer, java.util.Collection, java.lang.String)

saveRecentList

public void saveRecentList(List<String> clientIds,
 String uri)
                    throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Saves the recent list.

Specified by:

saveRecentList in interface I_CmsContainerpageService

Parameters:

clientIds - recent list element id's

uri - the container page URI

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContainerpageService.saveRecentList(java.util.List, java.lang.String)

setEditSmallElements

public void setEditSmallElements(boolean editSmallElements)
                          throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Enables or disables editing for small elements on page load.

Specified by:

setEditSmallElements in interface I_CmsContainerpageService

Parameters:

editSmallElements - the defautl setting for the small element editability

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.setEditSmallElements(boolean)

setElementView

public void setElementView(CmsUUID elementView)

Description copied from interface: I_CmsContainerpageService

Sets the element view.

Specified by:

setElementView in interface I_CmsContainerpageService

Parameters:

elementView - the element view

See Also:

• I_CmsContainerpageService.setElementView(org.opencms.util.CmsUUID)

setLastPage

public void setLastPage(CmsUUID pageId,
 CmsUUID detailId)
                 throws CmsRpcException

Description copied from interface: I_CmsContainerpageService

Stores information about the container page last edited.

Specified by:

setLastPage in interface I_CmsContainerpageService

Parameters:

pageId - the page id

detailId - the detail content id

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContainerpageService.setLastPage(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)

setSessionCache

public void setSessionCache(CmsADESessionCache cache)

Sets the session cache.

Parameters:

cache - the session cache