Interface I_CmsGalleryService
-
- All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
- All Known Implementing Classes:
CmsGalleryService
public interface I_CmsGalleryService extends com.google.gwt.user.client.rpc.RemoteService
Handles all RPC services related to the gallery dialog.- Since:
- 8.0.0
- See Also:
CmsGalleryService
,I_CmsGalleryService
,I_CmsGalleryServiceAsync
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deleteResource(java.lang.String resourcePath)
Deletes the given resource.CmsGalleryConfiguration
getAdeViewModeConfiguration()
Loads the gallery configuration for the adeView mode.java.util.List<CmsGalleryFolderBean>
getGalleries(java.util.List<java.lang.String> resourceTypes)
Returns the available galleries depending on the given resource types.CmsGalleryActionInfo
getGalleryActionInfo(java.lang.String sitePath)
Gets the gallery upload action information for the given path.CmsResultItemBean
getInfoForResource(java.lang.String path, java.lang.String locale)
Returns the resource info for a single resource.CmsGalleryDataBean
getInitialSettings(CmsGalleryConfiguration conf)
Returns the initial data for the given gallery mode.CmsGallerySearchBean
getSearch(CmsGalleryDataBean data)
Performs an initial search based on the given data bean and the available parameters of the request.CmsGallerySearchBean
getSearch(CmsGallerySearchBean searchObj)
Returns the gallery search object containing search results and the currant search parameter.java.util.List<CmsSitemapEntryBean>
getSubEntries(java.lang.String rootPath, boolean isRoot, java.lang.String filter)
Returns the sub entries to the given sitemap path.java.util.List<CmsVfsEntryBean>
getSubFolders(java.lang.String path)
Gets the sub-folders of a folder.CmsVfsEntryBean
loadVfsEntryBean(java.lang.String path, java.lang.String filter)
Loads the root VFS entry bean for the given site root.void
saveResultViewType(java.lang.String resultViewType)
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)
Saves the tree open state for a tree tab.void
updateIndex()
Updates the offline indices.
-
-
-
Method Detail
-
deleteResource
void deleteResource(java.lang.String resourcePath) throws CmsRpcException
Deletes the given resource.- Parameters:
resourcePath
- the resource path of the resource to delete- Throws:
CmsRpcException
- if something goes wrong
-
getAdeViewModeConfiguration
CmsGalleryConfiguration getAdeViewModeConfiguration()
Loads the gallery configuration for the adeView mode.- Returns:
- the gallery configuration
-
getGalleries
java.util.List<CmsGalleryFolderBean> getGalleries(java.util.List<java.lang.String> resourceTypes) throws CmsRpcException
Returns the available galleries depending on the given resource types.- Parameters:
resourceTypes
- the resource types- Returns:
- the galleries
- Throws:
CmsRpcException
- if something goes wrong
-
getGalleryActionInfo
CmsGalleryActionInfo getGalleryActionInfo(java.lang.String sitePath) throws CmsRpcException
Gets the gallery upload action information for the given path.- Parameters:
sitePath
- the path of a gallery folder- Returns:
- the gallery upload action information for that folder (may be null if no folder is found)
- Throws:
CmsRpcException
- if something goes wrong
-
getInfoForResource
CmsResultItemBean getInfoForResource(java.lang.String path, java.lang.String locale) throws CmsRpcException
Returns the resource info for a single resource.- Parameters:
path
- the resource pathlocale
- the content locale- Returns:
- the resource info
- Throws:
CmsRpcException
- if something goes wrong
-
getInitialSettings
CmsGalleryDataBean getInitialSettings(CmsGalleryConfiguration conf) throws CmsRpcException
Returns the initial data for the given gallery mode.- Parameters:
conf
- the gallery configuration- Returns:
- the data bean
- Throws:
CmsRpcException
- if something goes wrong
-
getSearch
CmsGallerySearchBean getSearch(CmsGalleryDataBean data) throws CmsRpcException
Performs an initial search based on the given data bean and the available parameters of the request.- Parameters:
data
- the data bean- Returns:
- the search result
- Throws:
CmsRpcException
- if something goes wrong
-
getSearch
CmsGallerySearchBean getSearch(CmsGallerySearchBean searchObj) throws CmsRpcException
Returns the gallery search object containing search results and the currant search parameter.- Parameters:
searchObj
- the current search object- Returns:
- the search object containing search results
- Throws:
CmsRpcException
- is something goes wrong
-
getSubEntries
java.util.List<CmsSitemapEntryBean> getSubEntries(java.lang.String rootPath, boolean isRoot, java.lang.String filter) throws CmsRpcException
Returns the sub entries to the given sitemap path.- Parameters:
rootPath
- the root pathisRoot
-true
if the requested entry is the root entryfilter
- the search filter string- Returns:
- the sub entries
- Throws:
CmsRpcException
- if something goes wrong
-
getSubFolders
java.util.List<CmsVfsEntryBean> getSubFolders(java.lang.String path) throws CmsRpcException
Gets the sub-folders of a folder.- Parameters:
path
- the path of a folder- Returns:
- beans representing the sub-folders of the folder
- Throws:
CmsRpcException
- if something goes wrong
-
loadVfsEntryBean
CmsVfsEntryBean loadVfsEntryBean(java.lang.String path, java.lang.String filter) throws CmsRpcException
Loads the root VFS entry bean for the given site root.- Parameters:
path
- the site rootfilter
- the filter string- Returns:
- the root VFS entry bean for the given site root
- Throws:
CmsRpcException
- if something goes wrong
-
saveResultViewType
void saveResultViewType(java.lang.String resultViewType)
Stores the result view type with the user.- Parameters:
resultViewType
- the result view type
-
saveTreeOpenState
void saveTreeOpenState(java.lang.String treeName, java.lang.String treeToken, java.lang.String siteRoot, java.util.Set<CmsUUID> openItems) throws CmsRpcException
Saves the tree open state for a tree tab.- Parameters:
treeName
- the tree name for which to save the tree statetreeToken
- the tree token for which to save the tree statesiteRoot
- the site rootopenItems
- the set of structure ids of open tree items- Throws:
CmsRpcException
- if something goes wrong
-
updateIndex
void updateIndex() throws CmsRpcException
Updates the offline indices.- Throws:
CmsRpcException
- if something goes wrong
-
-