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

Modifier and Type	Method and Description
void	addToFavoriteList(CmsContainerPageRpcContext context, java.lang.String clientId) Adds an element specified by it's id to the favorite list.
void	addToRecentList(CmsContainerPageRpcContext context, java.lang.String clientId) Adds an element specified by it's id to the recent list.
boolean	checkContainerpageOrElementsChanged(CmsUUID structureId, CmsUUID detailContentId, java.lang.String contentLocale) Check if a page or its elements have been changed.
CmsCreateElementData	checkCreateNewElement(CmsUUID pageStructureId, java.lang.String clientId, java.lang.String resourceType, CmsContainer container, 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.
boolean	checkNewWidgetsAvailable(CmsUUID structureId) Checks whether the Acacia widgets are available for all fields of the content.
CmsUUID	copyElement(CmsUUID pageId, CmsUUID originalElementId, java.lang.String locale) Creates a new element with a given model element and returns the copy'S structure id.
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.
CmsContainer	getContainerInfo() This method is used for serialization purposes only.
CmsDialogOptionsAndInfo	getDeleteOptions(java.lang.String clientId, CmsUUID pageStructureId, java.lang.String requestParams) Returns the delete options.
CmsDialogOptionsAndInfo	getEditOptions(java.lang.String clientId, CmsUUID pageStructureId, java.lang.String requestParams, boolean isListElement) Returns the edit options.
CmsContainerElement	getElementInfo() This method is used for serialization purposes only.
java.util.Map<java.lang.String,CmsContainerElementData>	getElementsData(CmsContainerPageRpcContext context, CmsUUID detailContentId, java.lang.String reqParams, java.util.Collection<java.lang.String> clientIds, java.util.Collection<CmsContainer> containers, boolean alwaysCopy, java.lang.String dndSource, java.lang.String locale) Returns container element data by client id.
CmsElementSettingsConfig	getElementSettingsConfig(CmsContainerPageRpcContext context, java.lang.String clientId, java.lang.String containerId, java.util.Collection<CmsContainer> containers, java.lang.String locale) Returns container element settings config data.
CmsContainerElementData	getElementWithSettings(CmsContainerPageRpcContext context, CmsUUID detailContentId, 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, CmsUUID detailContentId, java.util.Collection<CmsContainer> containers, java.lang.String locale) Returns the container element data of the favorite list.
CmsContainerPageGalleryData	getGalleryDataForPage(java.util.List<CmsContainer> containers, CmsUUID elementView, java.lang.String uri, java.lang.String locale) Returns the gallery configuration data according to the current page containers and the selected element view.
CmsContainerElementData	getNewElementData(CmsContainerPageRpcContext context, CmsUUID detailContentId, 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.
CmsDialogOptionsAndInfo	getNewOptions(java.lang.String clientId, CmsUUID pageStructureId, java.lang.String requestParams) Gets the edit handler options for creating a new element.
java.util.List<CmsContainerElementData>	getRecentList(CmsUUID pageStructureId, CmsUUID detailContentId, java.util.Collection<CmsContainer> containers, java.lang.String locale) Returns the container element data of the recent list.
CmsRemovedElementStatus	getRemovedElementStatus(java.lang.String id, CmsUUID containerpageId) Gets the status of a removed element.
void	handleDelete(java.lang.String clientId, java.lang.String deleteOption, CmsUUID pageStructureId, java.lang.String requestParams) Handles the element deletion.
int	loadClipboardTab() Loads the index of the clipboard tab last selected by the user.
CmsCntPageData	prefetch() Returns the initialization data.
CmsUUID	prepareForEdit(java.lang.String clientId, java.lang.String editOption, CmsUUID pageStructureId, java.lang.String requestParams) Prepares an element to be edited.
CmsContainerElementData	replaceElement(CmsContainerPageRpcContext context, CmsUUID detailContentId, java.lang.String reqParams, java.lang.String clientId, java.lang.String replaceId, java.util.Collection<CmsContainer> containers, java.lang.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.
long	saveContainerpage(CmsUUID pageStructureId, java.util.List<CmsContainer> containers) Saves the container-page.
long	saveDetailContainers(CmsUUID detailId, java.lang.String detailContainerResource, java.util.List<CmsContainer> containers) Saves the detail containers.
CmsContainerElementData	saveElementSettings(CmsContainerPageRpcContext context, CmsUUID detailContentId, java.lang.String reqParams, java.lang.String clientId, java.util.Map<java.lang.String,java.lang.String> settings, java.util.List<CmsContainer> containers, java.lang.String locale) Saves the settings for the given element to the container page and returns the updated element data.
void	saveFavoriteList(java.util.List<java.lang.String> clientIds, java.lang.String uri) Saves the favorite list.
CmsGroupContainerSaveResult	saveGroupContainer(CmsContainerPageRpcContext context, CmsUUID detailContentId, java.lang.String reqParams, CmsGroupContainer groupContainer, java.util.Collection<CmsContainer> containers, java.lang.String locale) Saves a group-container element.
java.util.Map<java.lang.String,CmsContainerElementData>	saveInheritanceContainer(CmsUUID pageStructureId, CmsUUID detailContentId, CmsInheritanceContainer inheritanceContainer, java.util.Collection<CmsContainer> containers, java.lang.String locale) Saves an inheritance container.
void	saveRecentList(java.util.List<java.lang.String> clientIds, java.lang.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.

Method Detail

addToFavoriteList

void addToFavoriteList(CmsContainerPageRpcContext context,
                       java.lang.String clientId)
                throws CmsRpcException

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

Parameters:

context - the rpc context

clientId - the element id

Throws:

CmsRpcException - if something goes wrong processing the request

addToRecentList

void addToRecentList(CmsContainerPageRpcContext context,
                     java.lang.String clientId)
              throws CmsRpcException

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

Parameters:

context - the rpc context

clientId - the element id

Throws:

CmsRpcException - if something goes wrong processing the request

checkContainerpageOrElementsChanged

boolean checkContainerpageOrElementsChanged(CmsUUID structureId,
                                            CmsUUID detailContentId,
                                            java.lang.String contentLocale)
                                     throws CmsRpcException

Check if a page or its elements have been changed.

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

checkCreateNewElement

CmsCreateElementData checkCreateNewElement(CmsUUID pageStructureId,
                                           java.lang.String clientId,
                                           java.lang.String resourceType,
                                           CmsContainer container,
                                           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

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

checkNewWidgetsAvailable

boolean checkNewWidgetsAvailable(CmsUUID structureId)
                          throws CmsRpcException

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

Parameters:

structureId - the structure id of the content

Returns:

true if Acacia widgets are available for all fields

Throws:

CmsRpcException - if something goes wrong

copyElement

CmsUUID copyElement(CmsUUID pageId,
                    CmsUUID originalElementId,
                    java.lang.String locale)
             throws CmsRpcException

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

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

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

getContainerInfo

CmsContainer getContainerInfo()

This method is used for serialization purposes only.

Returns:

container info

getDeleteOptions

CmsDialogOptionsAndInfo getDeleteOptions(java.lang.String clientId,
                                         CmsUUID pageStructureId,
                                         java.lang.String requestParams)
                                  throws CmsRpcException

Returns the delete options.

Parameters:

clientId - the client element id

pageStructureId - the current page structure id

requestParams - optional request parameters

Returns:

the delete options

Throws:

CmsRpcException - in case something goes wrong

getEditOptions

CmsDialogOptionsAndInfo getEditOptions(java.lang.String clientId,
                                       CmsUUID pageStructureId,
                                       java.lang.String requestParams,
                                       boolean isListElement)
                                throws CmsRpcException

Returns the edit options.

Parameters:

clientId - the client element id

pageStructureId - 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

getElementInfo

CmsContainerElement getElementInfo()

This method is used for serialization purposes only.

Returns:

element info

getElementsData

java.util.Map<java.lang.String,CmsContainerElementData> getElementsData(CmsContainerPageRpcContext context,
                                                                        CmsUUID detailContentId,
                                                                        java.lang.String reqParams,
                                                                        java.util.Collection<java.lang.String> clientIds,
                                                                        java.util.Collection<CmsContainer> containers,
                                                                        boolean alwaysCopy,
                                                                        java.lang.String dndSource,
                                                                        java.lang.String locale)
                                                                 throws CmsRpcException

Returns container element data by client id.

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

alwaysCopy - 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

getElementSettingsConfig

CmsElementSettingsConfig getElementSettingsConfig(CmsContainerPageRpcContext context,
                                                  java.lang.String clientId,
                                                  java.lang.String containerId,
                                                  java.util.Collection<CmsContainer> containers,
                                                  java.lang.String locale)
                                           throws CmsRpcException

Returns container element settings config data.

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

getElementWithSettings

CmsContainerElementData getElementWithSettings(CmsContainerPageRpcContext context,
                                               CmsUUID detailContentId,
                                               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:

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

getFavoriteList

java.util.List<CmsContainerElementData> getFavoriteList(CmsUUID pageStructureId,
                                                        CmsUUID detailContentId,
                                                        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

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

getGalleryDataForPage

CmsContainerPageGalleryData getGalleryDataForPage(java.util.List<CmsContainer> containers,
                                                  CmsUUID elementView,
                                                  java.lang.String uri,
                                                  java.lang.String locale)
                                           throws CmsRpcException

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

Parameters:

containers - the page containers

elementView - the element view

uri - the page URI

locale - the content locale

Returns:

the gallery data

Throws:

CmsRpcException - in case something goes wrong

getNewElementData

CmsContainerElementData getNewElementData(CmsContainerPageRpcContext context,
                                          CmsUUID detailContentId,
                                          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:

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

locale - the content locale

Returns:

the element data

Throws:

CmsRpcException - if something goes wrong processing the request

getNewOptions

CmsDialogOptionsAndInfo getNewOptions(java.lang.String clientId,
                                      CmsUUID pageStructureId,
                                      java.lang.String requestParams)
                               throws CmsRpcException

Gets the edit handler options for creating a new element.

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

getRecentList

java.util.List<CmsContainerElementData> getRecentList(CmsUUID pageStructureId,
                                                      CmsUUID detailContentId,
                                                      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

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

getRemovedElementStatus

CmsRemovedElementStatus getRemovedElementStatus(java.lang.String id,
                                                CmsUUID containerpageId)
                                         throws CmsRpcException

Gets the status of a removed element.

Parameters:

id - the client id of the removed element

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

handleDelete

void handleDelete(java.lang.String clientId,
                  java.lang.String deleteOption,
                  CmsUUID pageStructureId,
                  java.lang.String requestParams)
           throws CmsRpcException

Handles the element deletion.

Parameters:

clientId - the client element id

deleteOption - the selected delete option

pageStructureId - the current page structure id

requestParams - optional request parameters

Throws:

CmsRpcException - in case something goes wrong

loadClipboardTab

int loadClipboardTab()

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

Returns:

the clipboard tab index

prefetch

CmsCntPageData prefetch()
                 throws CmsRpcException

Returns the initialization data.

Returns:

the initialization data

Throws:

CmsRpcException - if something goes wrong

prepareForEdit

CmsUUID prepareForEdit(java.lang.String clientId,
                       java.lang.String editOption,
                       CmsUUID pageStructureId,
                       java.lang.String requestParams)
                throws CmsRpcException

Prepares an element to be edited.

Parameters:

clientId - the client element id

editOption - the selected delete option

pageStructureId - 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

replaceElement

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

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

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

saveClipboardTab

void saveClipboardTab(int tabIndex)

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

Parameters:

tabIndex - the index of the selected clipboard tab

saveContainerpage

long saveContainerpage(CmsUUID pageStructureId,
                       java.util.List<CmsContainer> containers)
                throws CmsRpcException

Saves the container-page.

Parameters:

pageStructureId - the container page structure id

containers - the container-page's containers

Returns:

the server time stamp of time of saving

Throws:

CmsRpcException - if something goes wrong processing the request

saveDetailContainers

long saveDetailContainers(CmsUUID detailId,
                          java.lang.String detailContainerResource,
                          java.util.List<CmsContainer> containers)
                   throws CmsRpcException

Saves the detail containers.

Parameters:

detailId - the detail content id

detailContainerResource - the detail container resource path

containers - the container-page's containers

Returns:

the server time stamp of time of saving

Throws:

CmsRpcException - if something goes wrong processing the request

saveElementSettings

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

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

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

saveFavoriteList

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

Saves the favorite list.

Parameters:

clientIds - favorite list element id's

uri - the container page URI

Throws:

CmsRpcException - if something goes wrong processing the request

saveGroupContainer

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

Saves a group-container element.

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

saveInheritanceContainer

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

Saves an inheritance container.

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

saveRecentList

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

Saves the recent list.

Parameters:

clientIds - recent list element id's

uri - the container page URI

Throws:

CmsRpcException - if something goes wrong processing the request

setEditSmallElements

void setEditSmallElements(boolean editSmallElements)
                   throws CmsRpcException

Enables or disables editing for small elements on page load.

Parameters:

editSmallElements - the defautl setting for the small element editability

Throws:

CmsRpcException - if something goes wrong

setElementView

void setElementView(CmsUUID elementView)
             throws CmsRpcException

Sets the element view.

Parameters:

elementView - the element view

Throws:

CmsRpcException - if something goes wrong processing the request

setLastPage

void setLastPage(CmsUUID pageId,
                 CmsUUID detailId)
          throws CmsRpcException

Stores information about the container page last edited.

Parameters:

pageId - the page id

detailId - the detail content id

Throws:

CmsRpcException - if something goes wrong