Package 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 Details

    • addToFavoriteList

      void addToFavoriteList(CmsContainerPageRpcContext context, String clientId, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Adds an element specified by it's id to the favorite list.

      Parameters:
      context - the rpc context
      clientId - the element id
      callback - the call-back executed on response

    • addToRecentList

      void addToRecentList(CmsContainerPageRpcContext context, String clientId, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Adds an element specified by it's id to the recent list.

      Parameters:
      context - the rpc context
      clientId - the element id
      callback - the call-back executed on response

    • checkContainerpageOrElementsChanged

      void checkContainerpageOrElementsChanged(CmsUUID structureId, CmsUUID detailContentId, String contentLocale, com.google.gwt.user.client.rpc.AsyncCallback<Boolean> callback)
      Check if a page or its elements have been changed.

      Parameters:
      structureId - the id of the container page
      detailContentId - the structure id of the detail content (may be null)
      contentLocale - the content locale
      callback - the callback for the result

    • checkCreateNewElement

      void checkCreateNewElement(CmsUUID pageStructureId, CmsUUID detailContentId, String clientId, String resourceType, CmsContainer container, 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
      detailContentId - the detail content 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
      callback - the call-back executed on response

    • checkNewWidgetsAvailable

      void checkNewWidgetsAvailable(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<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

    • copyElement

      void copyElement(CmsUUID pageId, CmsUUID originalElementId, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsUUID> resultCallback)
      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
      resultCallback - the callback for the result

    • createNewElement

      void createNewElement(CmsUUID pageStructureId, CmsUUID detailContentId, String clientId, String resourceType, CmsUUID modelResourceStructureId, 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
      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
      callback - the call-back executed on response

    • getContainerInfo

      void getContainerInfo(com.google.gwt.user.client.rpc.AsyncCallback<CmsContainer> callback)
      This method is used for serialization purposes only.

      Parameters:
      callback - the callback

    • getDeleteOptions

      void getDeleteOptions(String clientId, CmsUUID pageStructureId, String requestParams, com.google.gwt.user.client.rpc.AsyncCallback<CmsDialogOptionsAndInfo> callback)
      Returns the delete options.

      Parameters:
      clientId - the client element id
      pageStructureId - the current page structure id
      requestParams - optional request parameters
      callback - the async callback

    • getEditOptions

      void getEditOptions(String clientId, CmsUUID pageStructureId, String requestParams, boolean isListElement, com.google.gwt.user.client.rpc.AsyncCallback<CmsDialogOptionsAndInfo> callback)
      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
      callback - the async callback

    • 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(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, Collection<String> clientIds, Collection<CmsContainer> containers, boolean alwaysCopy, String dndSource, String locale, com.google.gwt.user.client.rpc.AsyncCallback<Map<String,CmsContainerElementData>> callback)
      Requests 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 - in the DND case, the id of the origin container from which the element is dragged
      locale - the content locale
      callback - the call-back executed on response

    • getElementSettingsConfig

      void getElementSettingsConfig(CmsContainerPageRpcContext context, String clientId, String containerId, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsElementSettingsConfig> callback)
      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
      callback - the call-back executed on response

    • getElementsLockedForPublishing

      void getElementsLockedForPublishing(Set<CmsUUID> idsToCheck, com.google.gwt.user.client.rpc.AsyncCallback<Set<CmsUUID>> callback)
      Checks which structure ids of a given set belong to resources locked for publishing by the current user, and then returns those.
      Parameters:
      idsToCheck - the set of ids to check
      callback - the callback to call with the result

    • getElementWithSettings

      void getElementWithSettings(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, String clientId, Map<String,String> settings, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback)
      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
      callback - the callback for receiving the element data

    • getFavoriteList

      void getFavoriteList(CmsUUID pageStructureId, CmsUUID detailContentId, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<List<CmsContainerElementData>> callback)
      Requests 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
      callback - the call-back executed on response

    • getGalleryDataForPage

      void getGalleryDataForPage(List<CmsContainer> containers, CmsUUID elementView, String uri, CmsUUID detailContentId, String locale, CmsTemplateContextInfo contextInfo, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerPageGalleryData> callback)
      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
      detailContentId - the detail content id
      locale - the content locale
      contextInfo - the template context information
      callback - the call-back executed on response

    • getListElementCreationOptions

      void getListElementCreationOptions(CmsUUID structureId, String jsonListAddData, com.google.gwt.user.client.rpc.AsyncCallback<CmsListElementCreationDialogData> callback)
      Loads the data for the list element creation dialog.
      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
      callback - the callback for the result

    • getNewElementData

      void getNewElementData(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, String resourceType, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback)
      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
      callback - the call-back executed on response

    • getNewOptions

      void getNewOptions(String clientId, CmsUUID pageStructureId, String requestParams, com.google.gwt.user.client.rpc.AsyncCallback<CmsDialogOptionsAndInfo> callback)
      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
      callback - the callback to call when done

    • getRecentList

      void getRecentList(CmsUUID pageStructureId, CmsUUID detailContentId, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<List<CmsContainerElementData>> callback)
      Requests 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
      callback - the call-back executed on response

    • getRemovedElementStatus

      void getRemovedElementStatus(String id, CmsUUID containerpageId, com.google.gwt.user.client.rpc.AsyncCallback<CmsRemovedElementStatus> callback)
      Gets the status of a removed element.

      Parameters:
      id - the element's client id
      containerpageId - the id of the container page which should be excluded from the relation check, or null if no page should be excluded
      callback - the asynchronous callback to execute with the results

    • getReuseInfo

      void getReuseInfo(CmsUUID pageId, CmsUUID detailId, CmsUUID elementId, com.google.gwt.user.client.rpc.AsyncCallback<CmsReuseInfo> callback)
      Loads reuse information for a container element.
      Parameters:
      pageId - the id of the current page
      detailId - the detail id for the current page
      elementId - the id of the container element
      callback - the callback to call with the result

    • handleDelete

      void handleDelete(String clientId, String deleteOption, CmsUUID pageStructureId, String requestParams, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      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
      callback - the asynchronous callback to execute with the results

    • loadClipboardTab

      void loadClipboardTab(com.google.gwt.user.client.rpc.AsyncCallback<Integer> resultCallback)
      Loads the clipboard tab to initially select.

      Parameters:
      resultCallback - the result callback

    • prefetch

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

      Parameters:
      callback - the async callback

    • prepareForEdit

      void prepareForEdit(String clientId, String editOption, CmsUUID pageStructureId, String requestParams, com.google.gwt.user.client.rpc.AsyncCallback<CmsUUID> callback)
      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
      callback - the async callback

    • replaceElement

      void replaceElement(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, String clientId, String replaceId, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback)
      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
      callback - the async callback

    • saveClipboardTab

      void saveClipboardTab(int tabIndex, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Saves the selected clipboard tab.

      Parameters:
      tabIndex - the index of the selected clipboard tab
      callback - the result callback

    • saveContainerpage

      void saveContainerpage(CmsUUID pageStructureId, List<CmsContainer> containers, com.google.gwt.user.client.rpc.AsyncCallback<Long> callback)
      Saves the container-page. Returning the save time stamp.

      Parameters:
      pageStructureId - the container page structure id
      containers - the container-page's containers
      callback - the call-back executed on response

    • saveDetailContainers

      void saveDetailContainers(CmsUUID detailId, String detailContainerResource, List<CmsContainer> containers, com.google.gwt.user.client.rpc.AsyncCallback<Long> callback)
      Saves the detail containers. Returning the save time stamp.

      Parameters:
      detailId - the detail content id
      detailContainerResource - the detail container resource path
      containers - the container-page's containers
      callback - the call-back executed on response

    • saveElementSettings

      void saveElementSettings(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, String clientId, Map<String,String> settings, List<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsContainerElementData> callback)
      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
      callback - the callback for receiving the element data

    • saveFavoriteList

      void saveFavoriteList(List<String> clientIds, String uri, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Saves the favorite list.

      Parameters:
      clientIds - favorite list element id's
      uri - the container page URI
      callback - the call-back executed on response

    • saveGroupContainer

      void saveGroupContainer(CmsContainerPageRpcContext context, CmsUUID detailContentId, String reqParams, CmsGroupContainer groupContainer, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsGroupContainerSaveResult> callback)
      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
      callback - the call-back executed on response

    • saveInheritanceContainer

      void saveInheritanceContainer(CmsUUID pageStructureId, CmsUUID detailContentId, CmsInheritanceContainer inheritanceContainer, Collection<CmsContainer> containers, String locale, com.google.gwt.user.client.rpc.AsyncCallback<Map<String,CmsContainerElementData>> callback)
      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
      callback - the callback

    • saveRecentList

      void saveRecentList(List<String> clientIds, String uri, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Saves the recent list.

      Parameters:
      clientIds - recent list element id's
      uri - the container page URI
      callback - the call-back executed on response

    • setEditSmallElements

      void setEditSmallElements(boolean editSmallElements, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Saves the default value for small element editability on page load.

      Parameters:
      editSmallElements - the default value
      callback - the callback for the response

    • setElementView

      void setElementView(CmsUUID elementView, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Sets the element view.

      Parameters:
      elementView - the element view
      callback - the call-back executed on response

    • setLastPage

      void setLastPage(CmsUUID pageId, CmsUUID detailId, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Stores information about the container page last edited.

      Parameters:
      pageId - the page id
      detailId - the detail content id
      callback - the callback