com.silverpeas.workflow.api.model
Interface DataFolder

All Known Implementing Classes:

DataFolderImpl

public interface DataFolder

Interface describing a representation of the <dataFolder> element of a Process Model.

Method Summary

void	addItem(Item item) Add an item to the collection
Item	createItem() Create an Item
Item	getItem(String strRoleName) Get item contained in the DataFolder by role name
Item[]	getItems() Get the items
Iterator<Item>	iterateItem() Iterate through the Item objects
void	removeItem(String strItemName) Remove an item from the collection
RecordTemplate	toRecordTemplate(String role, String lang, boolean disabled) Converts this object in a RecordTemplate object

Method Detail

getItems

Item[] getItems()

Get the items

Returns:

the items as a Vector

toRecordTemplate

RecordTemplate toRecordTemplate(String role,
                                String lang,
                                boolean disabled)
                                throws WorkflowException

Converts this object in a RecordTemplate object

Parameters:

role -

lang -

disabled -

Returns:

the resulting RecordTemplate

Throws:

WorkflowException

getItem

Item getItem(String strRoleName)

Get item contained in the DataFolder by role name

Parameters:

strRoleName - to search with

Returns:

an object implementing the Item interface

iterateItem

Iterator<Item> iterateItem()

Iterate through the Item objects

Returns:

an iterator

createItem

Item createItem()

Create an Item

Returns:

an object implementing Item

addItem

void addItem(Item item)

Add an item to the collection

Parameters:

item - to be added

removeItem

void removeItem(String strItemName)
                throws WorkflowException

Remove an item from the collection

Parameters:

strItemName - the name of the item to be removed.

Throws:

WorkflowException - when the item could not be found