com.modeliosoft.modelio.cms.api.contrib

Interface ICmsContributorHolder

public interface ICmsContributorHolder

PEM contributors holder.

This service registers PEM contributors and the order in which they are called.

Since:

3.5

Author:

cma

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICmsContributorHolder.Action Contributor hooks enumeration.

Method Summary

Modifier and Type	Method and Description
void	addContributor(ICmsContributor contributor) Add a new contributor
ICmsContributor	getContributor(java.lang.String id) Get the PEM contributor from its identifier.
java.util.List<ICmsContributor>	getPostContributors(ICmsContributorHolder.Action a) Get the contributors sorted for a given operation post process.
java.util.List<java.lang.String>	getPostOrder(ICmsContributorHolder.Action a) Get the contributors sorted for a given operation post process.
java.util.List<ICmsContributor>	getPreContributors(ICmsContributorHolder.Action a) Get the contributors sorted for a given operation pre process.
java.util.List<java.lang.String>	getPreOrder(ICmsContributorHolder.Action a) Get the contributors id sorted for a given operation pre process.
void	loadFrom(java.util.Map<java.lang.String,java.lang.String> properties) Load the configuration from the given properties.
void	removeContributor(ICmsContributor contrib) Remove a contributor to the process model.
void	saveTo(java.util.Map<java.lang.String,java.lang.String> properties) Save the holder configuration to the given property map.
void	setPostOrder(ICmsContributorHolder.Action a, java.util.List<java.lang.String> ids) Set the post process contributors order for an action by using a list of contributor identifiers.
void	setPreOrder(ICmsContributorHolder.Action a, java.util.List<java.lang.String> ids) Set the pre process contributors order for an action by using a list of contributor identifiers.

Method Detail

addContributor

void addContributor(ICmsContributor contributor)

Add a new contributor

Parameters:

contributor - the contributor.

setPreOrder

void setPreOrder(ICmsContributorHolder.Action a,
                 java.util.List<java.lang.String> ids)

Set the pre process contributors order for an action by using a list of contributor identifiers.

Parameters:

a - an operation type

ids - the sorted pre process identifiers.

removeContributor

void removeContributor(ICmsContributor contrib)

Remove a contributor to the process model.

Parameters:

contrib - the contributor to remove

getContributor

ICmsContributor getContributor(java.lang.String id)

Get the PEM contributor from its identifier.

Parameters:

id - an identifier

Returns:

the contributor or null.

loadFrom

void loadFrom(java.util.Map<java.lang.String,java.lang.String> properties)

Load the configuration from the given properties.

Parameters:

properties - the saved configuration

saveTo

void saveTo(java.util.Map<java.lang.String,java.lang.String> properties)

Save the holder configuration to the given property map.

Parameters:

properties - the save destination.

getPreOrder

java.util.List<java.lang.String> getPreOrder(ICmsContributorHolder.Action a)

Get the contributors id sorted for a given operation pre process.

Parameters:

a - the operation type

Returns:

the sorted pre process contributors id list.

getPreContributors

java.util.List<ICmsContributor> getPreContributors(ICmsContributorHolder.Action a)

Get the contributors sorted for a given operation pre process.

Parameters:

a - the operation type

Returns:

the sorted pre process contributors list.

getPostContributors

java.util.List<ICmsContributor> getPostContributors(ICmsContributorHolder.Action a)

Get the contributors sorted for a given operation post process.

Parameters:

a - the operation type

Returns:

the sorted post process contributors list.

setPostOrder

void setPostOrder(ICmsContributorHolder.Action a,
                  java.util.List<java.lang.String> ids)

Set the post process contributors order for an action by using a list of contributor identifiers.

Parameters:

a - an operation type

ids - the sorted post process identifiers.

getPostOrder

java.util.List<java.lang.String> getPostOrder(ICmsContributorHolder.Action a)

Get the contributors sorted for a given operation post process.

Parameters:

a - the operation type

Returns:

the sorted post process contributors id list.