com.day.cq.workflow.collection

Interface ResourceCollection

@ProviderType
public interface ResourceCollection

The ResourceCollection represents a collection of jcr resources (nodes) which can be added/removed. The collection is also able to listen to (jcr) modifications undertaken by a certain user. this modifications respectively the modified resource is added to the list as well.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NN_FILTER Name of the node containing filter definitions' items
static java.lang.String	PN_FILTER_ROOT Property name of a filter's item root path

Method Summary

Modifier and Type	Method and Description
void	add(Node node) Add member to the collection
java.lang.String	getPath() Returns collection path
boolean	hasNode(java.lang.String path)
java.util.List<Node>	list(java.lang.String[] allowedNodesTypes) All collection members are retourned
void	remove(Node node) Remove member
void	startRecording(java.lang.String userId, java.lang.String rootPath, java.lang.String[] nodeTypes) Starts the recording.
void	stopRecording(java.lang.String userId) Stops the recording.

Field Detail

NN_FILTER

static final java.lang.String NN_FILTER

Name of the node containing filter definitions' items

See Also:

Constant Field Values

PN_FILTER_ROOT

static final java.lang.String PN_FILTER_ROOT

Property name of a filter's item root path

See Also:

Constant Field Values

Method Detail

list

java.util.List<Node> list(java.lang.String[] allowedNodesTypes)
                   throws RepositoryException

All collection members are retourned

Parameters:

allowedNodesTypes - list of node types to be considered

Returns:

a list of all members

Throws:

RepositoryException - in case an error occurs while fetching the list.

add

void add(Node node)

Add member to the collection

Parameters:

node - to add

remove

void remove(Node node)

Remove member

Parameters:

node - node to remove

startRecording

void startRecording(java.lang.String userId,
                    java.lang.String rootPath,
                    java.lang.String[] nodeTypes)

Starts the recording.

Parameters:

userId - user id

rootPath - root path to nodes

nodeTypes - nodes to be removed

stopRecording

void stopRecording(java.lang.String userId)

Stops the recording.

Parameters:

userId - user id

getPath

java.lang.String getPath()

Returns collection path

Returns:

collection path

hasNode

boolean hasNode(java.lang.String path)

Parameters:

path - path to be find

Returns:

true if member exist, false otherwise