org.exoplatform.services.wcm.extensions.publication

Interface PublicationManager

public interface PublicationManager

Manages lifecycle and context of the publication.

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
void	addContext(org.exoplatform.container.component.ComponentPlugin plugin) Adds definitions of a context to the publication plugin.
void	addLifecycle(org.exoplatform.container.component.ComponentPlugin plugin) Adds definitions of a lifecycle to the publication plugin.
List<javax.jcr.Node>	getContents(String fromstate, String tostate, String date, String user, String lang, String workspace) Gets all content nodes.
org.exoplatform.services.wcm.extensions.publication.context.impl.ContextConfig.Context	getContext(String name) Gets a context by a given name.
List<org.exoplatform.services.wcm.extensions.publication.context.impl.ContextConfig.Context>	getContexts() Gets all contexts.
org.exoplatform.services.wcm.extensions.publication.lifecycle.impl.LifecyclesConfig.Lifecycle	getLifecycle(String name) Gets a lifecycle by a given name.
List<org.exoplatform.services.wcm.extensions.publication.lifecycle.impl.LifecyclesConfig.Lifecycle>	getLifecycles() Gets all lifecycles.
List<org.exoplatform.services.wcm.extensions.publication.lifecycle.impl.LifecyclesConfig.Lifecycle>	getLifecyclesFromUser(String remoteUser, String state) Gets all lifecycles of a user by a specified state.
void	removeContext(org.exoplatform.container.component.ComponentPlugin plugin) Removes definitions of a context from the publication plugin.
void	removeLifecycle(org.exoplatform.container.component.ComponentPlugin plugin) Removes definitions of a lifecycle from the publication plugin.

Method Detail

addLifecycle

void addLifecycle(org.exoplatform.container.component.ComponentPlugin plugin)

Adds definitions of a lifecycle to the publication plugin.

Parameters:

plugin - The component plugin that defines the lifecycle.

removeLifecycle

void removeLifecycle(org.exoplatform.container.component.ComponentPlugin plugin)

Removes definitions of a lifecycle from the publication plugin.

Parameters:

plugin - The component plugin that defines the lifecycle.

addContext

void addContext(org.exoplatform.container.component.ComponentPlugin plugin)

Adds definitions of a context to the publication plugin.

Parameters:

plugin - The component plugin that defines the context.

removeContext

void removeContext(org.exoplatform.container.component.ComponentPlugin plugin)

Removes definitions of a context from the publication plugin.

Parameters:

plugin - The component plugin that defines the context.

getLifecycles

List<org.exoplatform.services.wcm.extensions.publication.lifecycle.impl.LifecyclesConfig.Lifecycle> getLifecycles()

Gets all lifecycles.

Returns:

The list of lifecycles.

getContexts

List<org.exoplatform.services.wcm.extensions.publication.context.impl.ContextConfig.Context> getContexts()

Gets all contexts.

Returns:

The list of contexts.

getContext

org.exoplatform.services.wcm.extensions.publication.context.impl.ContextConfig.Context getContext(String name)

Gets a context by a given name.

Parameters:

name - Name of the context.

Returns:

The context.

getLifecycle

org.exoplatform.services.wcm.extensions.publication.lifecycle.impl.LifecyclesConfig.Lifecycle getLifecycle(String name)

Gets a lifecycle by a given name.

Returns:

The lifecycle.

getLifecyclesFromUser

List<org.exoplatform.services.wcm.extensions.publication.lifecycle.impl.LifecyclesConfig.Lifecycle> getLifecyclesFromUser(String remoteUser,
                                                                                                                        String state)

Gets all lifecycles of a user by a specified state.

Parameters:

remoteUser - The given user.

state - The specified state by which all lifecycles are got.

Returns:

The list of lifecycles.

getContents

List<javax.jcr.Node> getContents(String fromstate,
                               String tostate,
                               String date,
                               String user,
                               String lang,
                               String workspace)
                                 throws Exception

Gets all content nodes.

Parameters:

fromstate - The current state of the content.

tostate - The state by which lifecycles are retrieved from a user.

date - Any given date. The publication dates of returned content nodes are smaller than this given date.

user - The last user who changes the state.

lang - Language of the content nodes.

workspace - The workspace where content nodes are got.

Returns:

The list of content nodes.

Throws:

Exception