Package org.opencms.ade.galleries.shared.rpc

Interface I_CmsGalleryServiceAsync

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void deleteResource​(java.lang.String resourcePath, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
      Deletes the given resource.
      void getAdeViewModeConfiguration​(com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryConfiguration> callback)
      Loads the gallery configuration for the adeView mode.
      void getGalleries​(java.lang.String context, java.util.List<java.lang.String> resourceTypes, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsGalleryFolderBean>> callback)
      Returns the available galleries depending on the given resource types.
      void getGalleryActionInfo​(java.lang.String sitePath, com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryActionInfo> info)
      Gets gallery upload information.
      void getInfoForResource​(java.lang.String path, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsResultItemBean> callback)
      Returns the resource info for a single resource.
      void getInitialSettings​(CmsGalleryConfiguration conf, com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryDataBean> callback)
      Returns the initial data for the given gallery mode.
      void getSearch​(CmsGalleryDataBean data, com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback)
      Performs an initial search based on the given data bean and the available parameters of the request.
      void getSearch​(CmsGallerySearchBean searchObj, com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback)
      Returns the gallery search object containing search results and the currant search parameter.
      void getSubEntries​(java.lang.String rootPath, boolean isRoot, java.lang.String filter, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsSitemapEntryBean>> callback)
      Returns the sub entries to the given sitemap path.
      void getSubFolders​(java.lang.String path, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsVfsEntryBean>> callback)
      Gets the sub-folders of a folder.
      void loadVfsEntryBean​(java.lang.String path, java.lang.String filter, com.google.gwt.user.client.rpc.AsyncCallback<CmsVfsEntryBean> resultCallback)
      Loads the root VFS entry bean for the given site root.
      void saveResultViewType​(java.lang.String resultViewType, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
      Stores the result view type with the user.
      void saveTreeOpenState​(java.lang.String treeName, java.lang.String treeToken, java.lang.String siteRoot, java.util.Set<CmsUUID> openItems, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
      Saves the tree open state.
      void updateIndex​(com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
      Updates the offline indices.

    • Method Detail

      • getGalleryActionInfo

        void getGalleryActionInfo​(java.lang.String sitePath,
                          com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryActionInfo> info)
        Gets gallery upload information.
        Parameters:
        sitePath - the site path of a folder
        info - the gallery upload information, or null if no folder with that path is found

      • deleteResource

        void deleteResource​(java.lang.String resourcePath,
                    com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
        Deletes the given resource.

        Parameters:
        resourcePath - the resource path of the resource to delete
        callback - the callback

      • getAdeViewModeConfiguration

        void getAdeViewModeConfiguration​(com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryConfiguration> callback)
        Loads the gallery configuration for the adeView mode.

        Parameters:
        callback - the callback for the result

      • getGalleries

        void getGalleries​(java.lang.String context,
                  java.util.List<java.lang.String> resourceTypes,
                  com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsGalleryFolderBean>> callback)
        Returns the available galleries depending on the given resource types.

        Parameters:
        context - the current subsite
        resourceTypes - the resource types
        callback - the callback

      • getInfoForResource

        void getInfoForResource​(java.lang.String path,
                        java.lang.String locale,
                        com.google.gwt.user.client.rpc.AsyncCallback<CmsResultItemBean> callback)
        Returns the resource info for a single resource.

        Parameters:
        path - the resource path
        locale - the content locale
        callback - the callback

      • getSearch

        void getSearch​(CmsGalleryDataBean data,
               com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback)
        Performs an initial search based on the given data bean and the available parameters of the request.

        Parameters:
        data - the data bean
        callback - the callback

      • getSearch

        void getSearch​(CmsGallerySearchBean searchObj,
               com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback)
        Returns the gallery search object containing search results and the currant search parameter.

        Parameters:
        searchObj - the current search object
        callback - the callback

      • getSubEntries

        void getSubEntries​(java.lang.String rootPath,
                   boolean isRoot,
                   java.lang.String filter,
                   com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsSitemapEntryBean>> callback)
        Returns the sub entries to the given sitemap path.

        Parameters:
        rootPath - the root path
        isRoot - true if the requested entry is the root entry
        filter - the search filter, only relevant when isRoot is true
        callback - the asynchronous callback

      • getSubFolders

        void getSubFolders​(java.lang.String path,
                   com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsVfsEntryBean>> callback)
        Gets the sub-folders of a folder.

        Parameters:
        path - the path of a folder
        callback - the asynchronous callback

      • loadVfsEntryBean

        void loadVfsEntryBean​(java.lang.String path,
                      java.lang.String filter,
                      com.google.gwt.user.client.rpc.AsyncCallback<CmsVfsEntryBean> resultCallback)
        Loads the root VFS entry bean for the given site root.

        Parameters:
        path - the site root
        filter - the search filter
        resultCallback - the callback for the result

      • saveResultViewType

        void saveResultViewType​(java.lang.String resultViewType,
                        com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
        Stores the result view type with the user.

        Parameters:
        resultViewType - the result view type
        callback - the callback

      • saveTreeOpenState

        void saveTreeOpenState​(java.lang.String treeName,
                       java.lang.String treeToken,
                       java.lang.String siteRoot,
                       java.util.Set<CmsUUID> openItems,
                       com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
        Saves the tree open state.

        Parameters:
        treeName - the tree name
        treeToken - the tree token
        siteRoot - the site root
        openItems - the open items
        callback - the result callback

      • updateIndex

        void updateIndex​(com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
        Updates the offline indices.

        Parameters:
        callback - the callback