org.imixs.workflow.jee.faces.workitem

Class DataController

java.lang.Object

org.imixs.workflow.jee.faces.workitem.DataController

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WorkflowController

public class DataController
extends Object
implements Serializable

The DataController can be used in JSF Applications to manage ItemCollections without any workflow functionality. This bean makes uses of the CRUD operations provided by the Imixs EntityService. The default type of a entity created with the DataController is 'workitem'. This property can be changed from a client. The DataController bean is typically used in session scope.

Version:

0.0.1

Author:

rsoika

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataController()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessage(String ressourceBundleName, String messageKey, Object param) This method can be used to add a Error Messege to the Application Context during an actionListener Call.
void	create(javax.faces.event.ActionEvent event) This actionListener method creates an empty workItem with the default type.
void	delete(String uniqueID) This actionListener method removes the current selected workitem from a view.
String	delete(String uniqueID, String action) This action method removes the current selected workitem from a view.
void	deleteChilds(org.imixs.workflow.ItemCollection parent) This actionListener method deletes all child workItems of a workItem - also childs from child workItems will be deleted.
EntityService	getEntityService() returns an instance of the EntityService EJB
String	getID() returns the $uniqueID of the current workitem
String	getType() set the value for the attribute 'type' of a workitem to be generated or search by this controller
org.imixs.workflow.ItemCollection	getWorkitem() Returns the current workItem.
boolean	isNewWorkitem() indicates if a workitem was processed before by the workflowService
void	load(String uniqueID) ActionListener method to load a workItem from the backend.
String	load(String uniqueID, String action) Action method to load a workItem from the backend and returns an action result.
void	reset() Reset current workItem to null
void	reset(javax.faces.event.ActionEvent event) ActionListener to reset the current workItem to null
void	save() This actionListener method saves the current workItem.
String	save(String action) This action method saves the current workItem and returns an action result.
void	setType(String type) defines the type attribute of a workitem to be generated or search by this controller Subclasses may overwrite the type
void	setWorkitem(org.imixs.workflow.ItemCollection workitem) Updates the current worktItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataController

public DataController()

Method Detail

getEntityService

public EntityService getEntityService()

returns an instance of the EntityService EJB

Returns:

getID

public String getID()

returns the $uniqueID of the current workitem

Returns:

getType

public String getType()

set the value for the attribute 'type' of a workitem to be generated or search by this controller

setType

public void setType(String type)

defines the type attribute of a workitem to be generated or search by this controller Subclasses may overwrite the type

Parameters:

type -

getWorkitem

public org.imixs.workflow.ItemCollection getWorkitem()

Returns the current workItem.

Returns:

- current workItem or null if not set

setWorkitem

public void setWorkitem(org.imixs.workflow.ItemCollection workitem)

Updates the current worktItem

Parameters:

workitem - - new reference or null to clear the current workItem.

create

public void create(javax.faces.event.ActionEvent event)

This actionListener method creates an empty workItem with the default type. PropertyActionListener can be used to initialize the new workItem. This method should be overwritten to add additional Business logic here.

save

public void save()
          throws org.imixs.workflow.exceptions.AccessDeniedException

This actionListener method saves the current workItem. Method should be overwritten to add additional Business logic here.

Throws:

org.imixs.workflow.exceptions.AccessDeniedException - - if user has insufficient access rights.

save

public String save(String action)
            throws org.imixs.workflow.exceptions.AccessDeniedException

This action method saves the current workItem and returns an action result. The method expects the result action as a parameter.

Parameters:

action - - defines the action result

Returns:

action result

Throws:

org.imixs.workflow.exceptions.AccessDeniedException - - if user has insufficient access rights.

reset

public void reset()

Reset current workItem to null

reset

public void reset(javax.faces.event.ActionEvent event)

ActionListener to reset the current workItem to null

load

public void load(String uniqueID)

ActionListener method to load a workItem from the backend. The method can be called by dataTables to load a workItem for editing

Parameters:

uniqueID - - $uniqueId of the workItem to be loaded

load

public String load(String uniqueID,
          String action)

Action method to load a workItem from the backend and returns an action result. The method expects the result action as a parameter. The method can be called by dataTables to load a workItem for editing

Parameters:

uniqueID - - $uniqueId of the workItem to be loaded

action - - return action

Returns:

action event

delete

public String delete(String uniqueID,
            String action)
              throws org.imixs.workflow.exceptions.AccessDeniedException

This action method removes the current selected workitem from a view. The Method also deletes also all child workitems recursive

Parameters:

currentSelection - - workitem to be deleted

action - - return action

Returns:

action - action event

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

delete

public void delete(String uniqueID)
            throws org.imixs.workflow.exceptions.AccessDeniedException

This actionListener method removes the current selected workitem from a view. The Method also deletes also all child workitems recursive

Parameters:

currentSelection - - workitem to be deleted

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

deleteChilds

public void deleteChilds(org.imixs.workflow.ItemCollection parent)

This actionListener method deletes all child workItems of a workItem - also childs from child workItems will be deleted.

Parameters:

parent -

isNewWorkitem

public boolean isNewWorkitem()

indicates if a workitem was processed before by the workflowService

Returns:

addMessage

public void addMessage(String ressourceBundleName,
              String messageKey,
              Object param)

This method can be used to add a Error Messege to the Application Context during an actionListener Call. Typical this method is used in the doProcessWrktiem method to display a processing exception to the user. The method expects the Ressoruce bundle name and the message key inside the bundle.

Parameters:

ressourceBundleName -

messageKey -

param -