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

CmsPublishData	getInitData() Returns the initial publish data.
java.util.List<CmsProjectBean>	getProjects() Gets a list of projects from the server.
java.util.List<CmsPublishGroup>	getPublishGroups(CmsPublishOptions options) Retrieves the publish list, subdivided into groups based on the time of their last change.
CmsPublishOptions	getPublishOptions() Retrieves the publish options.
java.util.List<CmsPublishResource>	publishResources(java.util.List<CmsUUID> toPublish, java.util.List<CmsUUID> toRemove, boolean force) Tries to publish a list of resources.

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

getPublishGroups

java.util.List<CmsPublishGroup> getPublishGroups(CmsPublishOptions options)
                                                 throws CmsRpcException

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

Parameters:

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

Returns:

the publish list groups

Throws:

CmsRpcException - if something goes wrong

getPublishOptions

CmsPublishOptions getPublishOptions()
                                    throws CmsRpcException

Retrieves the publish options.

Returns:

the publish options last used

Throws:

CmsRpcException - if something goes wrong

publishResources

java.util.List<CmsPublishResource> publishResources(java.util.List<CmsUUID> toPublish,
                                                    java.util.List<CmsUUID> toRemove,
                                                    boolean force)
                                                    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

force - if true, ignore "broken link" problems

Returns:

the resources with problems

Throws:

CmsRpcException - if something goes wrong