org.exoplatform.services.wcm.publication
Interface WCMComposer

All Known Implementing Classes:

WCMComposerImpl

public interface WCMComposer

This class is responsible of getting contents inside the WCM product. We shouldn't access directly contents from the jcr on front side. In a general manner, this service stands between publication and cache.

Version:

1.0

Author:

Benjamin Paillereau - benjamin.paillereau@exoplatform.com

Field Summary

static java.lang.String	BASE_VERSION The Constant for base version.
static java.lang.String	FILTER_MODE Filter parameter to filter results by target mode.
static java.lang.String	FILTER_ORDER_BY Filter parameter to order results.
static java.lang.String	FILTER_ORDER_TYPE Filter parameter to order results in ascendant order or descendant order.
static java.lang.String	FILTER_PRIMARY_TYPE Filter parameter to filter results by primary type.
static java.lang.String	FILTER_RECURSIVE Filter parameter to search recursively or not.
static java.lang.String	FILTER_REMOTE_USER Filter parameter to filter results by user.
static java.lang.String	FILTER_SITE_NAME Filter parameter to filter results by site.
static java.lang.String	FILTER_STATE Filter parameter to filter results by state.
static java.lang.String	FILTER_VERSION Filter parameter to filter result by a decicated version.
static java.lang.String	IS_RECURSIVE The Constant IS_RECURSIVE.
static java.lang.String	MODE_EDIT The Constant MODE_EDIT.
static java.lang.String	MODE_LIVE The Constant MODE_LIVE.

Method Summary

java.util.List<java.lang.String>	getAllowedStates(java.lang.String mode) returns allowed states for a specified mode.
javax.jcr.Node	getContent(java.lang.String repository, java.lang.String workspace, java.lang.String nodeIdentifier, java.util.HashMap<java.lang.String,java.lang.String> filters, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) returns content at the specified path based on filters.
java.util.List<javax.jcr.Node>	getContents(java.lang.String repository, java.lang.String workspace, java.lang.String path, java.util.HashMap<java.lang.String,java.lang.String> filters, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) returns contents at the specified path based on filters.
boolean	updateContent(java.lang.String repository, java.lang.String workspace, java.lang.String nodeIdentifier, java.util.HashMap<java.lang.String,java.lang.String> filters) Update content.
boolean	updateContents(java.lang.String repository, java.lang.String workspace, java.lang.String path, java.util.HashMap<java.lang.String,java.lang.String> filters) Update contents.

Field Detail

FILTER_STATE

static final java.lang.String FILTER_STATE

Filter parameter to filter results by state. ex : draft, staged, published

See Also:

Constant Field Values

FILTER_PRIMARY_TYPE

static final java.lang.String FILTER_PRIMARY_TYPE

Filter parameter to filter results by primary type. ex: exo:article, exo:webContent

See Also:

Constant Field Values

FILTER_ORDER_BY

static final java.lang.String FILTER_ORDER_BY

Filter parameter to order results. ex: exo:title, dc:title

See Also:

Constant Field Values

FILTER_ORDER_TYPE

static final java.lang.String FILTER_ORDER_TYPE

Filter parameter to order results in ascendant order or descendant order. values : ASC, DESC

See Also:

Constant Field Values

FILTER_MODE

static final java.lang.String FILTER_MODE

Filter parameter to filter results by target mode. ex: editing, approving, live

See Also:

Constant Field Values

FILTER_RECURSIVE

static final java.lang.String FILTER_RECURSIVE

Filter parameter to search recursively or not. ex: recursive

See Also:

Constant Field Values

FILTER_VERSION

static final java.lang.String FILTER_VERSION

Filter parameter to filter result by a decicated version. ex: base, 1, 2, 3, etc

See Also:

Constant Field Values

FILTER_SITE_NAME

static final java.lang.String FILTER_SITE_NAME

Filter parameter to filter results by site. ex: classic

See Also:

Constant Field Values

FILTER_REMOTE_USER

static final java.lang.String FILTER_REMOTE_USER

Filter parameter to filter results by user. We will return only contents authored by this user. ex:

See Also:

Constant Field Values

MODE_EDIT

static final java.lang.String MODE_EDIT

The Constant MODE_EDIT.

See Also:

Constant Field Values

MODE_LIVE

static final java.lang.String MODE_LIVE

The Constant MODE_LIVE.

See Also:

Constant Field Values

IS_RECURSIVE

static final java.lang.String IS_RECURSIVE

The Constant IS_RECURSIVE.

See Also:

Constant Field Values

BASE_VERSION

static final java.lang.String BASE_VERSION

The Constant for base version.

See Also:

Constant Field Values

Method Detail

getContent

javax.jcr.Node getContent(java.lang.String repository,
                          java.lang.String workspace,
                          java.lang.String nodeIdentifier,
                          java.util.HashMap<java.lang.String,java.lang.String> filters,
                          org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                          throws java.lang.Exception

returns content at the specified path based on filters.

Parameters:

repository - the repository

workspace - the workspace

path - the path

filters - the filters

sessionProvider - the session provider

Returns:

a jcr node

Throws:

java.lang.Exception - the exception

getContents

java.util.List<javax.jcr.Node> getContents(java.lang.String repository,
                                           java.lang.String workspace,
                                           java.lang.String path,
                                           java.util.HashMap<java.lang.String,java.lang.String> filters,
                                           org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                                           throws java.lang.Exception

returns contents at the specified path based on filters.

Parameters:

repository - the repository

workspace - the workspace

path - the path

filters - the filters

sessionProvider - the session provider

Returns:

a jcr node

Throws:

java.lang.Exception - the exception

updateContent

boolean updateContent(java.lang.String repository,
                      java.lang.String workspace,
                      java.lang.String nodeIdentifier,
                      java.util.HashMap<java.lang.String,java.lang.String> filters)
                      throws java.lang.Exception

Update content.

Parameters:

repository - the repository

workspace - the workspace

path - the path

filters - the filters

Returns:

true, if successful

Throws:

java.lang.Exception

updateContents

boolean updateContents(java.lang.String repository,
                       java.lang.String workspace,
                       java.lang.String path,
                       java.util.HashMap<java.lang.String,java.lang.String> filters)
                       throws java.lang.Exception

Update contents.

Parameters:

repository - the repository

workspace - the workspace

path - the path

filters - the filters

Returns:

true, if successful

Throws:

java.lang.Exception

getAllowedStates

java.util.List<java.lang.String> getAllowedStates(java.lang.String mode)
                                                  throws java.lang.Exception

returns allowed states for a specified mode.

Parameters:

mode - the mode

Returns:

a jcr node

Throws:

java.lang.Exception - the exception