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

public interface I_CmsContainerpageServiceAsync

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

Since:

8.0.0

Method Summary

void	addToFavoriteList(java.lang.String clientId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Adds an element specified by it's id to the favorite list.
void	addToRecentList(java.lang.String clientId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Adds an element specified by it's id to the recent list.
void	checkCreateNewElement(CmsUUID pageStructureId, java.lang.String clientId, java.lang.String resourceType, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsCreateElementData> callback) 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.
void	checkNewWidgetsAvailable(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> resultCallback) Checks whether the Acacia widgets are available for all fields of the content.
void	createNewElement(CmsUUID pageStructureId, java.lang.String clientId, java.lang.String resourceType, CmsUUID modelResourceStructureId, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElement> callback) Creates a new element of the given type and returns the new element data containing structure id and site path.
void	getElementInfo(com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElement> callback) This method is used for serialization purposes only.
void	getElementsData(CmsUUID pageStructureId, java.lang.String reqParams, java.util.Collection<java.lang.String> clientIds, java.util.Collection<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,CmsContainerElementData>> callback) Requests container element data by client id.
void	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, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback) Gets the element data for an id and a map of settings.
void	getFavoriteList(CmsUUID pageStructureId, java.util.Collection<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsContainerElementData>> callback) Requests the container element data of the favorite list.
void	getNewElementData(CmsUUID pageStructureId, java.lang.String reqParams, java.lang.String resourceType, java.util.Collection<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback) Returns new container element data for the given resource type name.
void	getRecentList(CmsUUID pageStructureId, java.util.Collection<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsContainerElementData>> callback) Requests the container element data of the recent list.
void	getRemovedElementStatus(java.lang.String id, com.google.gwt.user.client.rpc.AsyncCallback<CmsRemovedElementStatus> callback) Gets the status of a removed element.
void	prefetch(com.google.gwt.user.client.rpc.AsyncCallback<CmsCntPageData> callback) Returns the initialization data.
void	saveContainerpage(CmsUUID pageStructureId, java.util.List<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Saves the container-page.
void	saveFavoriteList(java.util.List<java.lang.String> clientIds, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Saves the favorite list.
void	saveGroupContainer(CmsUUID pageStructureId, java.lang.String reqParams, CmsGroupContainer groupContainer, java.util.Collection<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsGroupContainerSaveResult> callback) Saves a group-container element.
void	saveInheritanceContainer(CmsUUID pageStructureId, CmsInheritanceContainer inheritanceContainer, java.util.Collection<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,CmsContainerElementData>> callback) Saves an inheritance container.
void	saveRecentList(java.util.List<java.lang.String> clientIds, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Saves the recent list.
void	syncSaveContainerpage(CmsUUID pageStructureId, java.util.List<CmsContainer> containers, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Generates request builder to make a synchronized RPC call saving the container-page.

Method Detail

addToFavoriteList

void addToFavoriteList(java.lang.String clientId,
                       com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

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

Parameters:

clientId - the element id

callback - the call-back executed on response

addToRecentList

void addToRecentList(java.lang.String clientId,
                     com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

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

Parameters:

clientId - the element id

callback - the call-back executed on response

checkCreateNewElement

void checkCreateNewElement(CmsUUID pageStructureId,
                           java.lang.String clientId,
                           java.lang.String resourceType,
                           java.lang.String locale,
                           com.google.gwt.user.client.rpc.AsyncCallback<CmsCreateElementData> callback)

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

callback - the call-back executed on response

checkNewWidgetsAvailable

void checkNewWidgetsAvailable(CmsUUID structureId,
                              com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> resultCallback)

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

Parameters:

structureId - the structure id of the content to check.

resultCallback - the callback for the result

createNewElement

void createNewElement(CmsUUID pageStructureId,
                      java.lang.String clientId,
                      java.lang.String resourceType,
                      CmsUUID modelResourceStructureId,
                      java.lang.String locale,
                      com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElement> callback)

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

callback - the call-back executed on response

getElementInfo

void getElementInfo(com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElement> callback)

This method is used for serialization purposes only.

Parameters:

callback - the callback

getElementsData

void getElementsData(CmsUUID pageStructureId,
                     java.lang.String reqParams,
                     java.util.Collection<java.lang.String> clientIds,
                     java.util.Collection<CmsContainer> containers,
                     java.lang.String locale,
                     com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,CmsContainerElementData>> callback)

Requests 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

callback - the call-back executed on response

getElementWithSettings

void 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,
                            com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback)

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

callback - the callback for receiving the element data

getFavoriteList

void getFavoriteList(CmsUUID pageStructureId,
                     java.util.Collection<CmsContainer> containers,
                     java.lang.String locale,
                     com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsContainerElementData>> callback)

Requests 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

callback - the call-back executed on response

getNewElementData

void getNewElementData(CmsUUID pageStructureId,
                       java.lang.String reqParams,
                       java.lang.String resourceType,
                       java.util.Collection<CmsContainer> containers,
                       java.lang.String locale,
                       com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback)

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

callback - the call-back executed on response

getRecentList

void getRecentList(CmsUUID pageStructureId,
                   java.util.Collection<CmsContainer> containers,
                   java.lang.String locale,
                   com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsContainerElementData>> callback)

Requests 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

callback - the call-back executed on response

getRemovedElementStatus

void getRemovedElementStatus(java.lang.String id,
                             com.google.gwt.user.client.rpc.AsyncCallback<CmsRemovedElementStatus> callback)

Gets the status of a removed element.

Parameters:

id - the element's client id

callback - the asynchronous callback to execute with the results

prefetch

void prefetch(com.google.gwt.user.client.rpc.AsyncCallback<CmsCntPageData> callback)

Returns the initialization data.

Parameters:

callback - the async callback

saveContainerpage

void saveContainerpage(CmsUUID pageStructureId,
                       java.util.List<CmsContainer> containers,
                       java.lang.String locale,
                       com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Saves the container-page.

Parameters:

pageStructureId - the container page structure id

containers - the container-page's containers

locale - the content locale

callback - the call-back executed on response

saveFavoriteList

void saveFavoriteList(java.util.List<java.lang.String> clientIds,
                      com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Saves the favorite list.

Parameters:

clientIds - favorite list element id's

callback - the call-back executed on response

saveGroupContainer

void saveGroupContainer(CmsUUID pageStructureId,
                        java.lang.String reqParams,
                        CmsGroupContainer groupContainer,
                        java.util.Collection<CmsContainer> containers,
                        java.lang.String locale,
                        com.google.gwt.user.client.rpc.AsyncCallback<CmsGroupContainerSaveResult> callback)

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

callback - the call-back executed on response

saveInheritanceContainer

void saveInheritanceContainer(CmsUUID pageStructureId,
                              CmsInheritanceContainer inheritanceContainer,
                              java.util.Collection<CmsContainer> containers,
                              java.lang.String locale,
                              com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,CmsContainerElementData>> callback)

Saves an inheritance container.

Parameters:

pageStructureId - the current page's structure id

inheritanceContainer - the inheritance container to save

containers - the containers of the current page

locale - the requested locale

callback - the callback

saveRecentList

void saveRecentList(java.util.List<java.lang.String> clientIds,
                    com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Saves the recent list.

Parameters:

clientIds - recent list element id's

callback - the call-back executed on response

syncSaveContainerpage

@SynchronizedRpcRequest
void syncSaveContainerpage(CmsUUID pageStructureId,
                                                  java.util.List<CmsContainer> containers,
                                                  java.lang.String locale,
                                                  com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Generates request builder to make a synchronized RPC call saving the container-page.

Parameters:

pageStructureId - the container page structure id

containers - the container-page's containers

locale - the content locale

callback - the call-back executed on response