org.opencms.ade.containerpage.shared.rpc
Interface I_CmsContainerpageService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

CmsContainerpageService

public interface I_CmsContainerpageService
extends com.google.gwt.user.client.rpc.RemoteService

The RPC service interface used by the container-page editor.

Since:

8.0.0

Method Summary

void	addToFavoriteList(java.lang.String clientId) Adds an element specified by it's id to the favorite list.
void	addToRecentList(java.lang.String clientId) Adds an element specified by it's id to the recent list.
CmsCreateElementData	checkCreateNewElement(CmsUUID pageStructureId, java.lang.String clientId, java.lang.String resourceType, java.lang.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.
CmsContainerElement	createNewElement(CmsUUID pageStructureId, java.lang.String clientId, java.lang.String resourceType, CmsUUID modelResourceStructureId, java.lang.String locale) Creates a new element of the given type and returns the new element data containing structure id and site path.
java.util.Map<java.lang.String,CmsContainerElementData>	getElementsData(CmsUUID pageStructureId, java.lang.String reqParams, java.util.Collection<java.lang.String> clientIds, java.util.Collection<CmsContainer> containers, java.lang.String locale) Returns container element data by client id.
CmsContainerElementData	getElementWithSettings(CmsUUID pageStructureId, java.lang.String reqParams, java.lang.String clientId, java.util.Map<java.lang.String,java.lang.String> settings, java.util.Collection<CmsContainer> containers, java.lang.String locale) Gets the element data for an id and a map of settings.
java.util.List<CmsContainerElementData>	getFavoriteList(CmsUUID pageStructureId, java.util.Collection<CmsContainer> containers, java.lang.String locale) Returns the container element data of the favorite list.
CmsContainerElementData	getNewElementData(CmsUUID pageStructureId, java.lang.String reqParams, java.lang.String resourceType, java.util.Collection<CmsContainer> containers, java.lang.String locale) Returns new container element data for the given resource type name.
java.util.List<CmsContainerElementData>	getRecentList(CmsUUID pageStructureId, java.util.Collection<CmsContainer> containers, java.lang.String locale) Returns the container element data of the recent list.
CmsCntPageData	prefetch() Returns the initialization data.
void	saveContainerpage(CmsUUID pageStructureId, java.util.List<CmsContainer> containers, java.lang.String locale) Saves the container-page.
void	saveFavoriteList(java.util.List<java.lang.String> clientIds) Saves the favorite list.
java.util.Map<java.lang.String,CmsContainerElementData>	saveGroupContainer(CmsUUID pageStructureId, java.lang.String reqParams, CmsGroupContainer groupContainer, java.util.Collection<CmsContainer> containers, java.lang.String locale) Saves a group-container element.
void	saveRecentList(java.util.List<java.lang.String> clientIds) Saves the recent list.
void	syncSaveContainerpage(CmsUUID pageStructureId, java.util.List<CmsContainer> containers, java.lang.String locale) Saves the container-page in a synchronized RPC call.

Method Detail

addToFavoriteList

void addToFavoriteList(java.lang.String clientId)
                       throws CmsRpcException

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

Parameters:

clientId - the element id

Throws:

CmsRpcException - if something goes wrong processing the request

addToRecentList

void addToRecentList(java.lang.String clientId)
                     throws CmsRpcException

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

Parameters:

clientId - the element id

Throws:

CmsRpcException - if something goes wrong processing the request

checkCreateNewElement

CmsCreateElementData checkCreateNewElement(CmsUUID pageStructureId,
                                           java.lang.String clientId,
                                           java.lang.String resourceType,
                                           java.lang.String locale)
                                           throws CmsRpcException

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.

Parameters:

pageStructureId - the container page structure id

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

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

createNewElement

CmsContainerElement createNewElement(CmsUUID pageStructureId,
                                     java.lang.String clientId,
                                     java.lang.String resourceType,
                                     CmsUUID modelResourceStructureId,
                                     java.lang.String locale)
                                     throws CmsRpcException

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

Parameters:

pageStructureId - the container page structure id

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

getElementsData

java.util.Map<java.lang.String,CmsContainerElementData> getElementsData(CmsUUID pageStructureId,
                                                                        java.lang.String reqParams,
                                                                        java.util.Collection<java.lang.String> clientIds,
                                                                        java.util.Collection<CmsContainer> containers,
                                                                        java.lang.String locale)
                                                                        throws CmsRpcException

Returns container element data by client id.

Parameters:

pageStructureId - the container page structure id

reqParams - optional request parameters

clientIds - the requested element id's

containers - the containers of the current page

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

getElementWithSettings

CmsContainerElementData getElementWithSettings(CmsUUID pageStructureId,
                                               java.lang.String reqParams,
                                               java.lang.String clientId,
                                               java.util.Map<java.lang.String,java.lang.String> settings,
                                               java.util.Collection<CmsContainer> containers,
                                               java.lang.String locale)
                                               throws CmsRpcException

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

Parameters:

pageStructureId - the container page 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

getFavoriteList

java.util.List<CmsContainerElementData> getFavoriteList(CmsUUID pageStructureId,
                                                        java.util.Collection<CmsContainer> containers,
                                                        java.lang.String locale)
                                                        throws CmsRpcException

Returns the container element data of the favorite list.

Parameters:

pageStructureId - the container page 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

getNewElementData

CmsContainerElementData getNewElementData(CmsUUID pageStructureId,
                                          java.lang.String reqParams,
                                          java.lang.String resourceType,
                                          java.util.Collection<CmsContainer> containers,
                                          java.lang.String locale)
                                          throws CmsRpcException

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

Parameters:

pageStructureId - the container page structure id

reqParams - optional request parameters

resourceType - the requested element resource type name

containers - the containers of the current page

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

getRecentList

java.util.List<CmsContainerElementData> getRecentList(CmsUUID pageStructureId,
                                                      java.util.Collection<CmsContainer> containers,
                                                      java.lang.String locale)
                                                      throws CmsRpcException

Returns the container element data of the recent list.

Parameters:

pageStructureId - the container page 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

prefetch

CmsCntPageData prefetch()
                        throws CmsRpcException

Returns the initialization data.

Returns:

the initialization data

Throws:

CmsRpcException - if something goes wrong

saveContainerpage

void saveContainerpage(CmsUUID pageStructureId,
                       java.util.List<CmsContainer> containers,
                       java.lang.String locale)
                       throws CmsRpcException

Saves the container-page.

Parameters:

pageStructureId - the container page structure id

containers - the container-page's containers

locale - the content locale

Throws:

CmsRpcException - if something goes wrong processing the request

saveFavoriteList

void saveFavoriteList(java.util.List<java.lang.String> clientIds)
                      throws CmsRpcException

Saves the favorite list.

Parameters:

clientIds - favorite list element id's

Throws:

CmsRpcException - if something goes wrong processing the request

saveGroupContainer

java.util.Map<java.lang.String,CmsContainerElementData> saveGroupContainer(CmsUUID pageStructureId,
                                                                           java.lang.String reqParams,
                                                                           CmsGroupContainer groupContainer,
                                                                           java.util.Collection<CmsContainer> containers,
                                                                           java.lang.String locale)
                                                                           throws CmsRpcException

Saves a group-container element.

Parameters:

pageStructureId - the container page 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

saveRecentList

void saveRecentList(java.util.List<java.lang.String> clientIds)
                    throws CmsRpcException

Saves the recent list.

Parameters:

clientIds - recent list element id's

Throws:

CmsRpcException - if something goes wrong processing the request

syncSaveContainerpage

void syncSaveContainerpage(CmsUUID pageStructureId,
                           java.util.List<CmsContainer> containers,
                           java.lang.String locale)
                           throws CmsRpcException

Saves the container-page in a synchronized RPC call.

Parameters:

pageStructureId - the container page structure id

containers - the container-page's containers

locale - the content locale

Throws:

CmsRpcException - if something goes wrong processing the request