org.exoplatform.services.wcm.publication

Interface WCMComposer

public interface WCMComposer

Gets content inside WCM. In general, this service stands between publication and cache, so you should not access content directly from the JCR on the front side.

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_VERSION The constant for base version.
static String	FILTER_LANGUAGE Filter parameter to filter results by language.
static String	FILTER_LIMIT Filter parameter to limit the result size.
static String	FILTER_MODE Filter parameter to filter results by target mode.
static String	FILTER_OFFSET Filter parameter to return results with an offset delimiter.
static String	FILTER_ORDER_BY Filter parameter to order results.
static String	FILTER_ORDER_TYPE Filter parameter to order results in ascending or descending order.
static String	FILTER_PRIMARY_TYPE Filter parameter to filter results by primary type.
static String	FILTER_QUERY Filter parameter to add a parameter to the executed query.
static String	FILTER_QUERY_FULL Filter parameter to execute a specific query.
static String	FILTER_RECURSIVE Filter parameter to search recursively or not.
static String	FILTER_REMOTE_USER Filter parameter to filter results by user.
static String	FILTER_SITE_NAME Filter parameter to filter results by site.
static String	FILTER_STATE Filter parameter to filter results by state.
static String	FILTER_TOTAL Total number of content.
static String	FILTER_VERSION Filter parameter to filter results by a dedicated version.
static String	FILTER_VISIBILITY Filter parameter to filter results by visibility.
static String	IS_RECURSIVE The constant IS_RECURSIVE.
static String	MODE_EDIT The constant MODE_EDIT.
static String	MODE_LIVE The constant MODE_LIVE.
static String	PORTLET_MODE Mode of portlet.
static String	VISIBILITY_PUBLIC The constant VISIBILITY PUBLIC.
static String	VISIBILITY_USER The constant VISIBILITY USER.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanTemplates() Resets the template filters.
List<String>	getAllowedStates(String mode) Gets the allowed states for a given mode.
javax.jcr.Node	getContent(String workspace, String nodeIdentifier, HashMap<String,String> filters, SessionProvider sessionProvider) Gets a content node at a specified path based on given filters.
List<javax.jcr.Node>	getContents(String workspace, String path, HashMap<String,String> filters, SessionProvider sessionProvider) Gets content nodes at a specified path based on given filters.
org.exoplatform.services.wcm.publication.Result	getPaginatedContents(org.exoplatform.services.wcm.core.NodeLocation nodeLocation, HashMap<String,String> filters, SessionProvider sessionProvider) Gets content nodes that are paginated at a specified path based on given filters.
String	updateTemplatesSQLFilter() Updates the SQL filter of templates.

Field Detail

FILTER_STATE

static final String FILTER_STATE

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

See Also:

Constant Field Values

FILTER_PRIMARY_TYPE

static final String FILTER_PRIMARY_TYPE

Filter parameter to filter results by primary type. For example: exo:webContent.

See Also:

Constant Field Values

FILTER_ORDER_BY

static final String FILTER_ORDER_BY

Filter parameter to order results. For example: exo:title, dc:title.

See Also:

Constant Field Values

FILTER_ORDER_TYPE

static final String FILTER_ORDER_TYPE

Filter parameter to order results in ascending or descending order. Its values are: ASC and DESC.

See Also:

Constant Field Values

FILTER_MODE

static final String FILTER_MODE

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

See Also:

Constant Field Values

FILTER_RECURSIVE

static final String FILTER_RECURSIVE

Filter parameter to search recursively or not. For example: recursive.

See Also:

Constant Field Values

FILTER_VERSION

static final String FILTER_VERSION

Filter parameter to filter results by a dedicated version. For example: base, 1, 2, 3, and more.

See Also:

Constant Field Values

FILTER_SITE_NAME

static final String FILTER_SITE_NAME

Filter parameter to filter results by site. For example: ACME.

See Also:

Constant Field Values

FILTER_REMOTE_USER

static final String FILTER_REMOTE_USER

Filter parameter to filter results by user. This means only content authored by this user is returned.

See Also:

Constant Field Values

FILTER_LANGUAGE

static final String FILTER_LANGUAGE

Filter parameter to filter results by language. This means only content in this language is returned. For example: fr, en, de.

See Also:

Constant Field Values

FILTER_QUERY

static final String FILTER_QUERY

Filter parameter to add a parameter to the executed query. For example: "AND exo:myproperty like 'cat1%'".

See Also:

Constant Field Values

FILTER_QUERY_FULL

static final String FILTER_QUERY_FULL

Filter parameter to execute a specific query. For example: "SELECT * from nt:base".

See Also:

Constant Field Values

FILTER_LIMIT

static final String FILTER_LIMIT

Filter parameter to limit the result size.

See Also:

Constant Field Values

FILTER_OFFSET

static final String FILTER_OFFSET

Filter parameter to return results with an offset delimiter.

See Also:

Constant Field Values

FILTER_TOTAL

static final String FILTER_TOTAL

Total number of content.

See Also:

Constant Field Values

FILTER_VISIBILITY

static final String FILTER_VISIBILITY

Filter parameter to filter results by visibility. For example: public, user.

See Also:

Constant Field Values

PORTLET_MODE

static final String PORTLET_MODE

Mode of portlet.

See Also:

Constant Field Values

MODE_EDIT

static final String MODE_EDIT

The constant MODE_EDIT.

See Also:

Constant Field Values

MODE_LIVE

static final String MODE_LIVE

The constant MODE_LIVE.

See Also:

Constant Field Values

IS_RECURSIVE

static final String IS_RECURSIVE

The constant IS_RECURSIVE.

See Also:

Constant Field Values

BASE_VERSION

static final String BASE_VERSION

The constant for base version.

See Also:

Constant Field Values

VISIBILITY_PUBLIC

static final String VISIBILITY_PUBLIC

The constant VISIBILITY PUBLIC.

See Also:

Constant Field Values

VISIBILITY_USER

static final String VISIBILITY_USER

The constant VISIBILITY USER.

See Also:

Constant Field Values

Method Detail

getContent

javax.jcr.Node getContent(String workspace,
                        String nodeIdentifier,
                        HashMap<String,String> filters,
                        SessionProvider sessionProvider)
                          throws Exception

Gets a content node at a specified path based on given filters.

Parameters:

workspace - The workspace that includes the content node.

nodeIdentifier - Identifier of the content node.

filters - The given filters.

sessionProvider - The session provider.

Returns:

The content node.

Throws:

Exception - The exception

getContents

List<javax.jcr.Node> getContents(String workspace,
                               String path,
                               HashMap<String,String> filters,
                               SessionProvider sessionProvider)
                                 throws Exception

Gets content nodes at a specified path based on given filters.

Parameters:

workspace - The workspace that includes the content nodes.

path - The path.

filters - The given filters.

sessionProvider - The session provider.

Returns:

The list of content nodes.

Throws:

Exception - The exception

getPaginatedContents

org.exoplatform.services.wcm.publication.Result getPaginatedContents(org.exoplatform.services.wcm.core.NodeLocation nodeLocation,
                                                                   HashMap<String,String> filters,
                                                                   SessionProvider sessionProvider)
                                                                     throws Exception

Gets content nodes that are paginated at a specified path based on given filters.

Parameters:

nodeLocation - Location of the content nodes.

filters - The given filters.

sessionProvider - The session provider.

Returns:

The list of content nodes.

Throws:

Exception - The exception

getAllowedStates

List<String> getAllowedStates(String mode)
                              throws Exception

Gets the allowed states for a given mode.

Parameters:

mode - The given mode.

Returns:

The list of states.

Throws:

Exception - The exception

cleanTemplates

void cleanTemplates()
                    throws Exception

Resets the template filters.

Throws:

Exception - the exception

updateTemplatesSQLFilter

String updateTemplatesSQLFilter()
                                throws Exception

Updates the SQL filter of templates.

Returns:

A part of the query that allows to search all document nodes and taxonomy links. It returns "null" if there is any exception.

Throws:

Exception - the exception