org.exoplatform.wcm.connector.authoring

Class LifecycleConnector

java.lang.Object

org.exoplatform.wcm.connector.authoring.LifecycleConnector

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class LifecycleConnector
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Returns a list of content during a given state range of the publication lifecycle.

eXo level API

Provisional

eXo anchor for generated doc on REST API

LifecycleConnector

Constructor Summary

Constructors

Constructor and Description
LifecycleConnector()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	byDate(String fromstate, String date, String lang, String workspace, String json) Returns a list of content from the given beginning state to the published state and before the given date.
javax.ws.rs.core.Response	byState(String fromstate, String user, String lang, String workspace, String json) Returns a list of content from the beginning state.
javax.ws.rs.core.Response	toState(String fromstate, String tostate, String user, String lang, String workspace, String json) Returns a list of content from the beginning state to the last state.

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecycleConnector

public LifecycleConnector()

Method Detail

byState

public javax.ws.rs.core.Response byState(String fromstate,
                                         String user,
                                         String lang,
                                         String workspace,
                                         String json)
                                  throws Exception

Returns a list of content from the beginning state. For example: http://localhost:8080/portal/rest/authoring/bystate/?fromstate =draft&user=root&lang=en&workspace=collaboration

Parameters:

fromstate - The beginning state of the content.

user - The author of the content.

lang - The language of the content.

workspace - The workspace name which contains the content.

json - The format of the returned data.

Returns:

List of content.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

LifecycleConnector.byState

toState

public javax.ws.rs.core.Response toState(String fromstate,
                                         String tostate,
                                         String user,
                                         String lang,
                                         String workspace,
                                         String json)
                                  throws Exception

Returns a list of content from the beginning state to the last state. For example: http://localhost:8080/portal/rest/authoring/tostate/?fromstate =draft&tostate=pending&user=root&lang=en&workspace=collaboration

Parameters:

fromstate - The beginning state of the content.

tostate - The destination state of the content.

user - The author of the content.

lang - The language of the content.

workspace - The workspace name which contains the content.

json - The format of the returned data.

Returns:

List of content.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

LifecycleConnector.toState

byDate

public javax.ws.rs.core.Response byDate(String fromstate,
                                        String date,
                                        String lang,
                                        String workspace,
                                        String json)
                                 throws Exception

Returns a list of content from the given beginning state to the published state and before the given date. For example: http://localhost:8080/portal/rest/authoring/bydate/?fromstate =staged&date=2&lang=en&workspace=collaboration

Parameters:

fromstate - The beginning state of the content.

date - The date before when the content is published.

workspace - The workspace name which contains the content.

lang - The language of the content.

json - The format of the returned data.

Returns:

List of content.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

LifecycleConnector.byDate