org.opencms.ade.publish.shared.rpc
Interface I_CmsPublishService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

CmsPublishService

public interface I_CmsPublishService
extends com.google.gwt.user.client.rpc.RemoteService

The synchronous publish list interface.

Since:

8.0.0

Method Summary

CmsWorkflowResponse	executeAction(java.util.List<CmsUUID> toPublish, java.util.List<CmsUUID> toRemove, CmsWorkflowAction action) Tries to publish a list of resources.
CmsPublishData	getInitData() Returns the initial publish data.
java.util.List<CmsProjectBean>	getProjects() Gets a list of projects from the server.
java.util.List<CmsPublishGroup>	getResourceGroups(CmsWorkflow workflow, CmsPublishOptions options) Retrieves the publish list, subdivided into groups based on the time of their last change.
CmsPublishOptions	getResourceOptions() Retrieves the publish options.

Method Detail

getInitData

CmsPublishData getInitData()
                           throws CmsRpcException

Returns the initial publish data.

Returns:

the initial publish data

Throws:

CmsRpcException - if something goes wrong

getProjects

java.util.List<CmsProjectBean> getProjects()
                                           throws CmsRpcException

Gets a list of projects from the server.

Returns:

a list of projects

Throws:

CmsRpcException - if something goes wrong

getResourceGroups

java.util.List<CmsPublishGroup> getResourceGroups(CmsWorkflow workflow,
                                                  CmsPublishOptions options)
                                                  throws CmsRpcException

Retrieves the publish list, subdivided into groups based on the time of their last change.

Parameters:

workflow - the selected workflow

options - the publish options for which the publish list should be fetched

Returns:

the publish list groups

Throws:

CmsRpcException - if something goes wrong

getResourceOptions

CmsPublishOptions getResourceOptions()
                                     throws CmsRpcException

Retrieves the publish options.

Returns:

the publish options last used

Throws:

CmsRpcException - if something goes wrong

executeAction

CmsWorkflowResponse executeAction(java.util.List<CmsUUID> toPublish,
                                  java.util.List<CmsUUID> toRemove,
                                  CmsWorkflowAction action)
                                  throws CmsRpcException

Tries to publish a list of resources.

Parameters:

toPublish - list of IDs of resources to publish

toRemove - list of IDs of resources to remove from the publish list

action - the work flow action

Returns:

the workflow response

Throws:

CmsRpcException - if something goes wrong