org.exoplatform.services.workflow
Interface WorkflowFileDefinitionService

public interface WorkflowFileDefinitionService

This interface specifies the contract of the Service which manages File Definitions. A File Definition contains among other things Forms definitions. It is required to persist File definitions somewhere as Forms need to be retrieved if eXo is restarted. It was decided to define a Service to do that, which makes it possible to allow various types of storage (eg: File System, ECM). This interface is currently part of the Bonita package as jBPM has a built-in facility to manage File Definition. It may however be a good idea to move it to the api package to make things common. Created by Bull R&D

Author:

Brice Revenant Feb 27, 2005

Method Summary

void	remove(java.lang.String processId) Remove a File Definition
void	removeFromCache(java.lang.String processId) If the implementation features a cache to increase performances, removes the File Definition corresponding to the specified Process identifier.
FileDefinition	retrieve(java.lang.String processId) Retrieves a File Definition
void	store(FileDefinition fileDefinition, java.lang.String processId) Stores a File Definition

Method Detail

remove

void remove(java.lang.String processId)

Remove a File Definition

Parameters:

processId - identifies the File Definition to remove

removeFromCache

void removeFromCache(java.lang.String processId)

If the implementation features a cache to increase performances, removes the File Definition corresponding to the specified Process identifier. This method is notably used while reloading a File Definition.

Parameters:

processId - identifies the Process to be removed from the cache

retrieve

FileDefinition retrieve(java.lang.String processId)

Retrieves a File Definition

Parameters:

processId - identifies the File Definition to retrieve

Returns:

the requested File Definition or null if not found

store

void store(FileDefinition fileDefinition,
           java.lang.String processId)

Stores a File Definition

Parameters:

fileDefinition - the File Definition to store

processId - identifies the File Definition to store