org.opencms.ade.galleries
Class CmsGalleryService

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
              com.google.gwt.user.server.rpc.RemoteServiceServlet
                  org.opencms.gwt.CmsGwtService
                      org.opencms.ade.galleries.CmsGalleryService

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, I_CmsGalleryService

public class CmsGalleryService
extends CmsGwtService
implements I_CmsGalleryService

Handles all RPC services related to the gallery dialog.

Since:

8.0.0

See Also:

CmsGalleryService, I_CmsGalleryService, I_CmsGalleryServiceAsync, Serialized Form

Nested Class Summary

protected class

CmsGalleryService.CmsGalleryTypeInfo Gallery info object.

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Constructor Summary

CmsGalleryService()

Method Summary

void	deleteResource(java.lang.String resourcePath) Deletes the given resource.
java.util.List<CmsGalleryFolderBean>	getGalleries(java.util.List<java.lang.String> resourceTypes) Returns the available galleries depending on the given resource types.
CmsGalleryDataBean	getInitialSettings() 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<CmsVfsEntryBean>	getSubFolders(java.lang.String path) Gets the sub-folders of a folder.
static CmsGalleryService	newInstance(javax.servlet.http.HttpServletRequest request, I_CmsGalleryProviderConstants.GalleryMode galleryMode) Returns a new configured service instance.

Methods inherited from class org.opencms.gwt.CmsGwtService

checkPermissions, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, log, log, logError, service, setCms, setContext, setRequest, tryUnlock

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsGalleryService

public CmsGalleryService()

Method Detail

newInstance

public static CmsGalleryService newInstance(javax.servlet.http.HttpServletRequest request,
                                            I_CmsGalleryProviderConstants.GalleryMode galleryMode)

Returns a new configured service instance.

Parameters:

request - the current request

galleryMode - the gallery mode

Returns:

a new service instance

deleteResource

public void deleteResource(java.lang.String resourcePath)
                    throws CmsRpcException

Description copied from interface: I_CmsGalleryService

Deletes the given resource.

Specified by:

deleteResource in interface I_CmsGalleryService

Parameters:

resourcePath - the resource path of the resource to delete

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsGalleryService.deleteResource(java.lang.String)

getGalleries

public java.util.List<CmsGalleryFolderBean> getGalleries(java.util.List<java.lang.String> resourceTypes)

Description copied from interface: I_CmsGalleryService

Returns the available galleries depending on the given resource types.

Specified by:

getGalleries in interface I_CmsGalleryService

Parameters:

resourceTypes - the resource types

Returns:

the galleries

See Also:

I_CmsGalleryService.getGalleries(java.util.List)

getInitialSettings

public CmsGalleryDataBean getInitialSettings()
                                      throws CmsRpcException

Description copied from interface: I_CmsGalleryService

Returns the initial data for the given gallery mode.

Specified by:

getInitialSettings in interface I_CmsGalleryService

Returns:

the data bean

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsGalleryService.getInitialSettings()

getSearch

public CmsGallerySearchBean getSearch(CmsGalleryDataBean data)

Description copied from interface: I_CmsGalleryService

Performs an initial search based on the given data bean and the available parameters of the request.

Specified by:

getSearch in interface I_CmsGalleryService

Parameters:

data - the data bean

Returns:

the search result

See Also:

I_CmsGalleryService.getSearch(org.opencms.ade.galleries.shared.CmsGalleryDataBean)

getSearch

public CmsGallerySearchBean getSearch(CmsGallerySearchBean searchObj)
                               throws CmsRpcException

Description copied from interface: I_CmsGalleryService

Returns the gallery search object containing search results and the currant search parameter.

Specified by:

getSearch in interface I_CmsGalleryService

Parameters:

searchObj - the current search object

Returns:

the search object containing search results

Throws:

CmsRpcException - is something goes wrong

See Also:

I_CmsGalleryService.getSearch(CmsGallerySearchBean)

getSubFolders

public java.util.List<CmsVfsEntryBean> getSubFolders(java.lang.String path)
                                              throws CmsRpcException

Description copied from interface: I_CmsGalleryService

Gets the sub-folders of a folder.

Specified by:

getSubFolders in interface I_CmsGalleryService

Parameters:

path - the path of a folder

Returns:

beans representing the sub-folders of the folder

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsGalleryService.getSubFolders(java.lang.String)