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

Modifier and Type	Method and Description
CmsWorkflowResponse	executeAction(CmsWorkflowAction action, CmsWorkflowActionParams params) Tries to publish a list of resources.
CmsPublishData	getInitData(java.util.HashMap<java.lang.String,java.lang.String> params) Returns the initial publish data.
CmsPublishGroupList	getResourceGroups(CmsWorkflow workflow, CmsPublishOptions options, boolean projectChanged) Retrieves the publish list, subdivided into groups based on the time of their last change.
CmsPublishOptions	getResourceOptions() Retrieves the publish options.

Method Detail

executeAction

CmsWorkflowResponse executeAction(CmsWorkflowAction action,
                                  CmsWorkflowActionParams params)
                           throws CmsRpcException

Tries to publish a list of resources.

Parameters:

action - the work flow action

params - the data on which to perform the workflow action

Returns:

the workflow response

Throws:

CmsRpcException - if something goes wrong

getInitData

CmsPublishData getInitData(java.util.HashMap<java.lang.String,java.lang.String> params)
                    throws CmsRpcException

Returns the initial publish data.

Parameters:

params - a map of additional publish parameters

Returns:

the initial publish data

Throws:

CmsRpcException - if something goes wrong

getResourceGroups

CmsPublishGroupList getResourceGroups(CmsWorkflow workflow,
                                      CmsPublishOptions options,
                                      boolean projectChanged)
                               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

projectChanged - indicates whether the reason we get the resource groups is because the user changed the project

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