| java.lang.Object
 hero.session.UserSessionBean
| UserSessionBean | | public class UserSessionBean implements SessionBean,EventConstants(Code) | | The User Session Bean, is an stateless session bean that provides the user API to get information on
Todo list and started activities and to produce events on activities (start, terminate, cancel).
This Session Bean is based on Engine Session Bean: a recursive implementation that manage the previous execution operations
and propagates the activity state changes to the activities that are connected to this one.
The User Session Bean API provides information about user projects and activites (project list,
todo list and activity list) and also useful information about project instances or user
preferences. With this API users can performs his task/activities by using start, terminate and
cancel methods and also terminates workflow processes.
The following lines shows a sample code to use this API in your application:
First of all you have to import the User Session files:
import hero.interfaces.UserSessionLocalHome;
import hero.interfaces.UserSessionLocal;
import hero.interfaces.UserSessionHome;
import hero.interfaces.UserSession;
import hero.interfaces.UserSessionUtil;
Now, it is time to create the User Session instance:
Like this if you want to use local interfaces:
UserSessionLocalHome userh = (UserSessionLocalHome)hero.interfaces.UserSessionUtil.getLocalHome();
UserSessionLocal usersession = userh.create();
or like this if you use remote interfaces:
UserSessionHome userh = (UserSessionHome)hero.interfaces.UserSessionUtil.getHome();
UserSession usersession = userh.create();
Now you can call all User Sessions methods...
author:
Miguel Valdes |
| Method Summary | |
| public void | cancelActivity(String projectName, String nodeName)
| | public void | deleteUserProperty(String key)
| | public void | ejbActivate()
Internal Enterprise Java Beans method. | | public void | ejbCreate()
Creates the User Session Bean. | | public void | ejbPassivate()
Internal Enterprise Java Beans method. | | public void | ejbRemove()
Internal Enterprise Java Beans method. | | public Collection | getActivityList(String projectName)
| | public Collection | getActivityListAllInstances()
| | public Collection | getActivityListAllInstancesAsPK()
| | public Collection | getActivityListAllInstancesByPK(Collection list, int offset, int numrows)
| | public Collection | getActivityListAsPK(String projectName)
| | public Collection | getActivityListByPK(String projectName, Collection list, int offset, int numrows)
| | public Collection | getActivityListByProperty(String key, String value)
| | public Collection | getActivityListByPropertyAsPK(String key, String value)
| | public Collection | getActivityListByPropertyByPK(String key, String value, Collection list, int offset, int numrows)
| | public Collection | getCooperativeList()
Get user cooperative projects list. | | public Collection | getCooperativeList(int offset, int numrows)
Get user cooperative projects list. | | public Collection | getInstanceNodes(String instanceName, String userName)
| | public Collection | getInstancesActivityTerminated(String projectName, String nodeName)
| | public Collection | getInstancesActivityTerminatedAsPK(String projectName, String nodeName)
| | public Collection | getInstancesActivityTerminatedByPK(String projectName, String nodeName, Collection list, int offset, int numrows)
| | public Collection | getInstancesActivityTodoList(String projectName, String nodeName)
| | public Collection | getInstancesActivityTodoListAsPK(String projectName, String nodeName)
| | public Collection | getInstancesActivityTodoListByPK(String projectName, String nodeName, Collection list, int offset, int numrows)
| | public Collection | getInstancesByProperty(String key, String value)
| | public Collection | getInstancesByPropertyAsPK(String key, String value)
| | public Collection | getInstancesByPropertyByPK(String key, String value, Collection list, int offset, int numrows)
| | public Collection | getInstancesByPropertyNames(String key, String value)
| | public Collection | getInstancesByPropertyNamesAsPK(String key, String value)
| | public Collection | getInstancesByPropertyNamesByPK(String key, String value, Collection list, int offset, int numrows)
| | public Collection | getInstancesList()
Get user instances list. | | public Collection | getInstancesList(int offset, int numrows)
Get user instances list. | | public Collection | getInstancesListNames()
Get instances list names for this user. | | public Collection | getInstancesListNames(int offset, int numrows)
Get instances list names for this user. | | public Collection | getModelInstancesTerminated(String projectName)
| | public Collection | getModelInstancesTerminated(String projectName, int offset, int numrows)
| | public Collection | getModelInstancesTodoList(String projectName)
| | public Collection | getModelInstancesTodoList(String projectName, int offset, int numrows)
| | public Collection | getModelList()
Get user model list. | | public Collection | getModelList(int offset, int numrows)
| | public Collection | getModels()
Get available workflow models. | | public Collection | getModelsAsPK()
Get available workflow models. | | public Collection | getModelsByPK(Collection list, int offset, int numrows)
Get available workflow models. | | public Collection | getModelsLight()
Get available workflow models. | | public Collection | getModelsLightAll()
Get available workflow models. | | public Collection | getModelsLightAsPK()
Get available workflow models. | | public Collection | getModelsLightByPK(Collection list, int offset, int numrows)
Get available workflow models. | | public BnNodeValue | getNode(String projectName, String nodeName)
| | public Collection | getProjectInstances(String projectName, String version)
| | public Collection | getProjectInstances(String projectName)
| | public Collection | getProjectInstancesAsPK(String projectName, String version)
| | public Collection | getProjectInstancesAsPK(String projectName)
| | public Collection | getProjectInstancesByPK(String projectName, Collection list, int offset, int numrows)
| | public Collection | getProjectInstancesNames(String projectName, String version)
| | public Collection | getProjectInstancesNames(String projectName)
| | public Collection | getProjectInstancesNamesAsPK(String projectName, String version)
| | public Collection | getProjectInstancesNamesAsPK(String projectName)
| | public Collection | getProjectInstancesNamesByPK(String projectName, Collection list, int offset, int numrows)
| | public Collection | getProjectList()
Get user project list. | | public Collection | getProjectListNames()
| | public Collection | getProjectsByProperty(String key, String value)
| | public Collection | getProjectsByPropertyAsPK(String key, String value)
| | public Collection | getProjectsByPropertyByPK(String key, String value, Collection list, int offset, int numrows)
| | public Collection | getProjectsByPropertyNames(String key, String value)
| | public Collection | getProjectsByPropertyNamesAsPK(String key, String value)
| | public Collection | getProjectsByPropertyNamesByPK(String key, String value, Collection list, int offset, int numrows)
| | public Collection | getTerminatedListAllInstances()
Obtain terminated user activities for all instances/cooperative projects. | | public Collection | getTerminatedListAllInstancesAsPK()
Obtain a subset of the terminated user activities for all instances/cooperative projects. | | public Collection | getTerminatedListAllInstancesByPK(Collection list, int offset, int numrows)
Obtain a subset of the terminated user activities for all instances/cooperative projects. | | public Collection | getToDoList(String projectName)
| | public Collection | getToDoListAllInstances()
| | public Collection | getToDoListAllInstancesAsPK()
| | public Collection | getToDoListAllInstancesByPK(Collection list, int offset, int numrows)
| | public Collection | getToDoListAsPK(String projectName)
| | public Collection | getToDoListByActivityProperty(String key, String value)
| | public Collection | getToDoListByActivityPropertyAsPK(String key, String value)
| | public Collection | getToDoListByActivityPropertyByPK(String key, String value, Collection list, int offset, int numrows)
| | public Collection | getToDoListByPK(String projectName, Collection list, int offset, int numrows)
| | public Collection | getToDoListByProperties(int operation, Hashtable properties)
Obtain todo user activities matching with project properties (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to property value. | | public Collection | getToDoListByPropertiesAsPK(int operation, Hashtable properties)
Obtain todo user activities matching with project properties (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to property value. | | public Collection | getToDoListByPropertiesByPK(int operation, Hashtable properties, Collection list, int offset, int numrows)
Obtain todo user activities matching with project properties (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to property value. | | public Collection | getToDoListByProperty(String key, String value)
| | public Collection | getToDoListByPropertyAsPK(String key, String value)
| | public Collection | getToDoListByPropertyByPK(String key, String value, Collection list, int offset, int numrows)
| | public String | getUser()
| | public Collection | getUserInstancesProject()
| | public Collection | getUserInstancesProject(int offset, int numrows)
| | public Collection | getUserInstancesProjectNodes(String projectName)
| | public Collection | getUserInstancesProjectNodesAsPK(String projectName)
| | public Collection | getUserInstancesProjectNodesByPK(String projectName, Collection list, int offset, int numrows)
| | public String | getUserJabber()
| | public BnUserLightValue | getUserLightValue()
| | public String | getUserMail()
Get the mail of this user from Bonita database. | | public String | getUserModelVersion(String proj)
| | public String | getUserPassword()
| | public Collection | getUserProperties()
| | public Collection | getUserRealInstancesProject()
| | public void | removeInstance(String instName)
| | public void | removeProject(String projectName)
| | public void | removeProject(String projectName, String version)
| | public void | setSessionContext(javax.ejb.SessionContext context)
Internal Enterprise Java Beans method. | | public void | setUserMail(String userName, String mail)
Set the mail of this user into Bonita database. | | public void | setUserProperty(String key, String value)
| | public void | startActivity(String projectName, String nodeName)
| | public void | terminate(String projectName)
| | public void | terminateActivity(String projectName, String nodeName)
|
| cancelActivity | | public void cancelActivity(String projectName, String nodeName) throws HeroException(Code) | | Tries to cancel an activity (when activity is executing or anticipating)
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node |
| deleteUserProperty | | public void deleteUserProperty(String key) throws HeroException(Code) | | Delete a property of a user
Parameters:
key - the key of the property |
| ejbActivate | | public void ejbActivate()(Code) | | Internal Enterprise Java Beans method.
|
| ejbCreate | | public void ejbCreate() throws CreateException(Code) | | Creates the User Session Bean. This method is the first one to invoke in order to
use UserSession API. If the user is not authorized this method throws an exception.
throws:
CreateException - |
| ejbPassivate | | public void ejbPassivate()(Code) | | Internal Enterprise Java Beans method.
|
| ejbRemove | | public void ejbRemove()(Code) | | Internal Enterprise Java Beans method.
|
| getActivityList | | public Collection getActivityList(String projectName) throws HeroException(Code) | | Obtain all user activities from specific project (executing and anticipating state)
Parameters:
projectName - the name of the project a String Collectio - the list of active activities of the user for a project
throws:
HeroException - |
| getActivityListAllInstances | | public Collection getActivityListAllInstances() throws HeroException(Code) | | Obtain executing user activities for all instances/cooperative projects (executing and anticipating state)
a BnNodeValue Collection - the list of executing activities ot the user for all instances
throws:
HeroException - |
| getActivityListAllInstancesAsPK | | public Collection getActivityListAllInstancesAsPK() throws HeroException(Code) | | Obtain executing user activities for all instances/cooperative projects (executing and anticipating state)
a BnNodeValue Collection - the list of executing activities ot the user for all instances
throws:
HeroException - |
| getActivityListAllInstancesByPK | | public Collection getActivityListAllInstancesByPK(Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain executing user activities for all instances/cooperative projects (executing and anticipating state)
a BnNodeValue Collection - the list of executing activities ot the user for all instances
throws:
HeroException - |
| getActivityListAsPK | | public Collection getActivityListAsPK(String projectName) throws HeroException(Code) | | Obtain all user activities from specific project (executing and anticipating state)
Parameters:
projectName - the name of the project a String Collectio - the list of active activities of the user for a project
throws:
HeroException - |
| getActivityListByPK | | public Collection getActivityListByPK(String projectName, Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain all user activities from specific project (executing and anticipating state)
Parameters:
projectName - the name of the project a String Collectio - the list of active activities of the user for a project
throws:
HeroException - |
| getActivityListByProperty | | public Collection getActivityListByProperty(String key, String value) throws HeroException(Code) | | Obtain executing user activities matching with property value (executing and anticipating state activities)
a BnNodeValue Collection - the list of executing activities matching to property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getActivityListByPropertyAsPK | | public Collection getActivityListByPropertyAsPK(String key, String value) throws HeroException(Code) | | Obtain executing user activities matching with property value (executing and anticipating state activities)
a BnNodeValue Collection - the list of executing activities matching to property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getActivityListByPropertyByPK | | public Collection getActivityListByPropertyByPK(String key, String value, Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain executing user activities matching with property value (executing and anticipating state activities)
a BnNodeValue Collection - the list of executing activities matching to property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getCooperativeList | | public Collection getCooperativeList() throws HeroException(Code) | | Get user cooperative projects list. This method is equivalent to getProjectList but
it only returns the current cooperative projects of the user.
a Collection of BnProjectLightValue objects - the cooperative projects list of the user
throws:
HeroException - |
| getCooperativeList | | public Collection getCooperativeList(int offset, int numrows) throws HeroException(Code) | | Get user cooperative projects list. This method is equivalent to getProjectList but
it only returns the current cooperative projects of the user.
a Collection of BnProjectLightValue objects - the cooperative projects list of the user
throws:
HeroException - |
| getInstanceNodes | | public Collection getInstanceNodes(String instanceName, String userName) throws HeroException(Code) | | Get ready and executing activities for a user instance
Parameters:
instanceName - the project name
Parameters:
userName - the caller's name a String Collection - the names of activities
throws:
HeroException - |
| getInstancesActivityTerminated | | public Collection getInstancesActivityTerminated(String projectName, String nodeName) throws HeroException(Code) | | Get activities model instances terminated by this user
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node a BnNodeLightValue Collection - the values
throws:
HeroException - |
| getInstancesActivityTerminatedAsPK | | public Collection getInstancesActivityTerminatedAsPK(String projectName, String nodeName) throws HeroException(Code) | | Get subset of activities model instances terminated by this user
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node a BnNodeLightValue Collection - the values
throws:
HeroException - |
| getInstancesActivityTerminatedByPK | | public Collection getInstancesActivityTerminatedByPK(String projectName, String nodeName, Collection list, int offset, int numrows) throws HeroException(Code) | | Get subset of activities model instances terminated by this user
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node a BnNodeLightValue Collection - the values
throws:
HeroException - |
| getInstancesActivityTodoList | | public Collection getInstancesActivityTodoList(String projectName, String nodeName) throws HeroException(Code) | | Get activities model instances assigned to this user
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node a BnNodeLightValue Collection - the values
throws:
HeroException - |
| getInstancesActivityTodoListAsPK | | public Collection getInstancesActivityTodoListAsPK(String projectName, String nodeName) throws HeroException(Code) | | Get subset of activities model instances assigned to this user
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node a BnNodeLightValue Collection - the values
throws:
HeroException - |
| getInstancesActivityTodoListByPK | | public Collection getInstancesActivityTodoListByPK(String projectName, String nodeName, Collection list, int offset, int numrows) throws HeroException(Code) | | Get subset of activities model instances assigned to this user
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node a BnNodeLightValue Collection - the values
throws:
HeroException - |
| getInstancesByProperty | | public Collection getInstancesByProperty(String key, String value) throws HeroException(Code) | | Get Workflow instances from a property
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project |
| getInstancesByPropertyAsPK | | public Collection getInstancesByPropertyAsPK(String key, String value) throws HeroException(Code) | | Get Workflow instances from a property
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project |
| getInstancesByPropertyByPK | | public Collection getInstancesByPropertyByPK(String key, String value, Collection list, int offset, int numrows) throws HeroException(Code) | | Get Workflow instances from a property
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project |
| getInstancesByPropertyNames | | public Collection getInstancesByPropertyNames(String key, String value) throws HeroException(Code) | | Get Workflow instances from a property
a String Collection - list of project instances
Parameters:
projectName - the name of the project |
| getInstancesByPropertyNamesAsPK | | public Collection getInstancesByPropertyNamesAsPK(String key, String value) throws HeroException(Code) | | Get Workflow instances from a property
a String Collection - list of project instances
Parameters:
projectName - the name of the project |
| getInstancesByPropertyNamesByPK | | public Collection getInstancesByPropertyNamesByPK(String key, String value, Collection list, int offset, int numrows) throws HeroException(Code) | | Get Workflow instances from a property
a String Collection - list of project instances
Parameters:
projectName - the name of the project |
| getInstancesList | | public Collection getInstancesList() throws HeroException(Code) | | Get user instances list. This method is equivalent to getProjectList but
it only returns the current instances of the user.
a Collection of BnProjectLightValue objects - the projects list of the user
throws:
HeroException - |
| getInstancesList | | public Collection getInstancesList(int offset, int numrows) throws HeroException(Code) | | Get user instances list. This method is equivalent to getProjectList but
it only returns the current instances of the user.
a Collection of BnProjectLightValue objects - the projects list of the user
throws:
HeroException - |
| getInstancesListNames | | public Collection getInstancesListNames() throws HeroException(Code) | | Get instances list names for this user. This method is equivalent to getProjectListNames but
it only returns the current instances of the user.
a String Collection - the projects list names of the user
throws:
HeroException - |
| getInstancesListNames | | public Collection getInstancesListNames(int offset, int numrows) throws HeroException(Code) | | Get instances list names for this user. This method is equivalent to getProjectListNames but
it only returns the current instances of the user.
a String Collection - the projects list names of the user
throws:
HeroException - |
| getModelInstancesTerminated | | public Collection getModelInstancesTerminated(String projectName) throws HeroException(Code) | | Get activities names of the model instances terminated by this user
Parameters:
projectName - the name of the project a String Collection - the names of activities
throws:
HeroException - |
| getModelInstancesTerminated | | public Collection getModelInstancesTerminated(String projectName, int offset, int numrows) throws HeroException(Code) | | Get activities names of the model instances terminated by this user
Parameters:
projectName - the name of the project a String Collection - the names of activities
throws:
HeroException - |
| getModelInstancesTodoList | | public Collection getModelInstancesTodoList(String projectName) throws HeroException(Code) | | Get activities names of the model instances assigned to this user
Parameters:
projectName - the name of the project a String Collection - the names of activities
throws:
HeroException - |
| getModelInstancesTodoList | | public Collection getModelInstancesTodoList(String projectName, int offset, int numrows) throws HeroException(Code) | | Get activities names of the model instances assigned to this user
Parameters:
projectName - the name of the project a String Collection - the names of activities
throws:
HeroException - |
| getModelList | | public Collection getModelList() throws HeroException(Code) | | Get user model list. This method is equivalent to getProjectList but
it only returns the current models of the user.
a Collection of BnProjectLightValue objects - the model list of the user
throws:
HeroException - |
| getModels | | public Collection getModels() throws HeroException(Code) | | Get available workflow models. This method will be improved with users restrictions
a Collection of BnProjectLightValue objects - the model list to be instantiated
throws:
HeroException - |
| getModelsAsPK | | public Collection getModelsAsPK() throws HeroException(Code) | | Get available workflow models. This method will be improved with users restrictions
a Collection of BnProjectLightValue objects - the model list to be instantiated
throws:
HeroException - |
| getModelsByPK | | public Collection getModelsByPK(Collection list, int offset, int numrows) throws HeroException(Code) | | Get available workflow models. This method will be improved with users restrictions
a Collection of BnProjectLightValue objects - the model list to be instantiated
throws:
HeroException - |
| getModelsLight | | public Collection getModelsLight() throws HeroException(Code) | | Get available workflow models. This method is like getModels()
except that no initiatorMapper check is performed.
a Collection of BnProjectLightValue objects - the model list
throws:
HeroException - |
| getModelsLightAll | | public Collection getModelsLightAll() throws HeroException(Code) | | Get available workflow models. This method is like getModels()
except that no initiatorMapper check is performed.
a Collection of BnProjectLightValue objects - the model list
throws:
HeroException - |
| getModelsLightAsPK | | public Collection getModelsLightAsPK() throws HeroException(Code) | | Get available workflow models. This method is like getModels()
except that no initiatorMapper check is performed.
a Collection of BnProjectLightValue objects - the model list
throws:
HeroException - |
| getModelsLightByPK | | public Collection getModelsLightByPK(Collection list, int offset, int numrows) throws HeroException(Code) | | Get available workflow models. This method is like getModels()
except that no initiatorMapper check is performed.
a Collection of BnProjectLightValue objects - the model list
throws:
HeroException - |
| getNode | | public BnNodeValue getNode(String projectName, String nodeName) throws HeroException(Code) | | Get Node Value from a specific project
a NodeValue object - get node information
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node |
| getProjectInstances | | public Collection getProjectInstances(String projectName, String version) throws HeroException(Code) | | Get Workflow instances of this project
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project
Parameters:
version - the name of the version |
| getProjectInstances | | public Collection getProjectInstances(String projectName) throws HeroException(Code) | | Get Workflow instances of this project
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project |
| getProjectInstancesAsPK | | public Collection getProjectInstancesAsPK(String projectName, String version) throws HeroException(Code) | | Get Workflow instances of this project
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project
Parameters:
version - the name of the version |
| getProjectInstancesAsPK | | public Collection getProjectInstancesAsPK(String projectName) throws HeroException(Code) | | Get Workflow instances of this project
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project |
| getProjectInstancesByPK | | public Collection getProjectInstancesByPK(String projectName, Collection list, int offset, int numrows) throws HeroException(Code) | | Get Workflow instances of this project
a BnProjectValue Collection - list of project instances
Parameters:
projectName - the name of the project |
| getProjectInstancesNames | | public Collection getProjectInstancesNames(String projectName, String version) throws HeroException(Code) | | Get workflow instances names of this project
Parameters:
projectName - the name of the project
Parameters:
version - the name of the version a String Collection - the names of project instances
throws:
HeroException - |
| getProjectInstancesNames | | public Collection getProjectInstancesNames(String projectName) throws HeroException(Code) | | Get workflow instances names of this project
Parameters:
projectName - the name of the project a String Collection - the names of project instances
throws:
HeroException - |
| getProjectInstancesNamesAsPK | | public Collection getProjectInstancesNamesAsPK(String projectName, String version) throws HeroException(Code) | | Get workflow instances names of this project
Parameters:
projectName - the name of the project
Parameters:
version - the name of the version a String Collection - the names of project instances
throws:
HeroException - |
| getProjectInstancesNamesAsPK | | public Collection getProjectInstancesNamesAsPK(String projectName) throws HeroException(Code) | | Get workflow instances names of this project
Parameters:
projectName - the name of the project a String Collection - the names of project instances
throws:
HeroException - |
| getProjectInstancesNamesByPK | | public Collection getProjectInstancesNamesByPK(String projectName, Collection list, int offset, int numrows) throws HeroException(Code) | | Get workflow instances names of this project
Parameters:
projectName - the name of the project a String Collection - the names of project instances
throws:
HeroException - |
| getProjectList | | public Collection getProjectList() throws HeroException(Code) | | Get user project list. Workflow processes associated to this user (models/cooperative/instances)
a Collection of BnProjectLightValue objects - the projects list of the user
throws:
HeroException - |
| getProjectListNames | | public Collection getProjectListNames() throws HeroException(Code) | | Get project list names for this user (models/cooperative/instances)
a String Collection - the projects list names of the user
throws:
HeroException - |
| getProjectsByProperty | | public Collection getProjectsByProperty(String key, String value) throws HeroException(Code) | | Get Workflow projects from a property
a BnProjectValue Collection - list of projects
Parameters:
projectName - the name of the project |
| getProjectsByPropertyAsPK | | public Collection getProjectsByPropertyAsPK(String key, String value) throws HeroException(Code) | | Get Workflow projects from a property
a BnProjectValue Collection - list of projects
Parameters:
projectName - the name of the project |
| getProjectsByPropertyByPK | | public Collection getProjectsByPropertyByPK(String key, String value, Collection list, int offset, int numrows) throws HeroException(Code) | | Get Workflow projects from a property
a BnProjectValue Collection - list of projects
Parameters:
projectName - the name of the project |
| getProjectsByPropertyNames | | public Collection getProjectsByPropertyNames(String key, String value) throws HeroException(Code) | | Get Workflow projects from a property
a String Collection - list of project names
Parameters:
projectName - the name of the project |
| getProjectsByPropertyNamesAsPK | | public Collection getProjectsByPropertyNamesAsPK(String key, String value) throws HeroException(Code) | | Get Workflow projects from a property
a String Collection - list of project names
Parameters:
projectName - the name of the project |
| getProjectsByPropertyNamesByPK | | public Collection getProjectsByPropertyNamesByPK(String key, String value, Collection list, int offset, int numrows) throws HeroException(Code) | | Get Workflow projects from a property
a String Collection - list of project names
Parameters:
projectName - the name of the project |
| getTerminatedListAllInstances | | public Collection getTerminatedListAllInstances() throws HeroException(Code) | | Obtain terminated user activities for all instances/cooperative projects.
a BnNodeValue Collection - the list of terminated activities ot the user for all instances
throws:
HeroException - |
| getTerminatedListAllInstancesAsPK | | public Collection getTerminatedListAllInstancesAsPK() throws HeroException(Code) | | Obtain a subset of the terminated user activities for all instances/cooperative projects.
a BnNodeValue Collection - the list of terminated activities ot the user for all instances
throws:
HeroException - |
| getTerminatedListAllInstancesByPK | | public Collection getTerminatedListAllInstancesByPK(Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain a subset of the terminated user activities for all instances/cooperative projects.
a BnNodeValue Collection - the list of terminated activities ot the user for all instances
throws:
HeroException - |
| getToDoList | | public Collection getToDoList(String projectName) throws HeroException(Code) | | Obtain all user activities from specific project (ready and anticipable state)
Parameters:
projectName - the name of the project a String Collection - the list of todo activities of the user for a project
throws:
HeroException - |
| getToDoListAllInstances | | public Collection getToDoListAllInstances() throws HeroException(Code) | | Obtain todo user activities for all instances/cooperative projects (ready and anticipable state)
a BnNodeValue Collection - the list of todo activities of the user for all instances
throws:
HeroException - |
| getToDoListAllInstancesAsPK | | public Collection getToDoListAllInstancesAsPK() throws HeroException(Code) | | Obtain todo user activities for all instances/cooperative projects (ready and anticipable state)
a BnNodeValue Collection - the list of todo activities of the user for all instances
throws:
HeroException - |
| getToDoListAllInstancesByPK | | public Collection getToDoListAllInstancesByPK(Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain todo user activities for all instances/cooperative projects (ready and anticipable state)
a BnNodeValue Collection - the list of todo activities of the user for all instances
throws:
HeroException - |
| getToDoListAsPK | | public Collection getToDoListAsPK(String projectName) throws HeroException(Code) | | Obtain all user activities from specific project (ready and anticipable state)
Parameters:
projectName - the name of the project a String Collection - the list of todo activities of the user for a project
throws:
HeroException - |
| getToDoListByActivityProperty | | public Collection getToDoListByActivityProperty(String key, String value) throws HeroException(Code) | | Obtain todo user activities matching with activity property value (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to activity property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getToDoListByActivityPropertyAsPK | | public Collection getToDoListByActivityPropertyAsPK(String key, String value) throws HeroException(Code) | | Obtain todo user activities matching with activity property value (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to activity property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getToDoListByActivityPropertyByPK | | public Collection getToDoListByActivityPropertyByPK(String key, String value, Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain todo user activities matching with activity property value (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to activity property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getToDoListByPK | | public Collection getToDoListByPK(String projectName, Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain all user activities from specific project (ready and anticipable state)
Parameters:
projectName - the name of the project a String Collection - the list of todo activities of the user for a project
throws:
HeroException - |
| getToDoListByProperties | | public Collection getToDoListByProperties(int operation, Hashtable properties) throws HeroException(Code) | | Obtain todo user activities matching with project properties (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to property value. This methodis oriented to administrative workflow (workflow instances) and supports one, two or three properties (key/value pairs).Operation constants values: hero.interfaces.Constants.AND, hero.interfaces.Constants.OR
Parameters:
operation - AND/OR operations are allowed.
Parameters:
properties - Hashtable containing the key/value elements
throws:
HeroException - |
| getToDoListByPropertiesAsPK | | public Collection getToDoListByPropertiesAsPK(int operation, Hashtable properties) throws HeroException(Code) | | Obtain todo user activities matching with project properties (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to property value. This methodis oriented to administrative workflow (workflow instances) and supports one, two or three properties (key/value pairs).Operation constants values: hero.interfaces.Constants.AND, hero.interfaces.Constants.OR
Parameters:
operation - AND/OR operations are allowed.
Parameters:
properties - Hashtable containing the key/value elements
throws:
HeroException - |
| getToDoListByPropertiesByPK | | public Collection getToDoListByPropertiesByPK(int operation, Hashtable properties, Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain todo user activities matching with project properties (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to property value. This methodis oriented to administrative workflow (workflow instances) and supports one, two or three properties (key/value pairs).Operation constants values: hero.interfaces.Constants.AND, hero.interfaces.Constants.OR
Parameters:
operation - AND/OR operations are allowed.
Parameters:
properties - Hashtable containing the key/value elements
throws:
HeroException - |
| getToDoListByProperty | | public Collection getToDoListByProperty(String key, String value) throws HeroException(Code) | | Obtain todo user activities matching with project property value (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to project property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getToDoListByPropertyAsPK | | public Collection getToDoListByPropertyAsPK(String key, String value) throws HeroException(Code) | | Obtain todo user activities matching with project property value (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to project property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getToDoListByPropertyByPK | | public Collection getToDoListByPropertyByPK(String key, String value, Collection list, int offset, int numrows) throws HeroException(Code) | | Obtain todo user activities matching with project property value (ready and anticipable state activities)
a BnNodeValue Collection - the list of todo activities matching to project property value
Parameters:
key - the key of the property
Parameters:
value - the value of the property
throws:
HeroException - |
| getUser | | public String getUser()(Code) | | Get the user name
a String - get user name |
| getUserInstancesProject | | public Collection getUserInstancesProject() throws HeroException(Code) | | Get models names which have ongoing instances for this user
a String Collection - the names of workflow models
throws:
HeroException - |
| getUserInstancesProject | | public Collection getUserInstancesProject(int offset, int numrows) throws HeroException(Code) | | Get models names which have ongoing instances for this user
a String Collection - the names of workflow models
throws:
HeroException - |
| getUserInstancesProjectNodes | | public Collection getUserInstancesProjectNodes(String projectName) throws HeroException(Code) | | Get ready, anticipable and executing activities for current user instances
Parameters:
projectName - the project name a String Collection - the names of activities
throws:
HeroException - |
| getUserInstancesProjectNodesAsPK | | public Collection getUserInstancesProjectNodesAsPK(String projectName) throws HeroException(Code) | | Get a subset of the ready, anticipable and executing activities for current user instances
Parameters:
projectName - the project name a String Collection - the names of activities
throws:
HeroException - |
| getUserInstancesProjectNodesByPK | | public Collection getUserInstancesProjectNodesByPK(String projectName, Collection list, int offset, int numrows) throws HeroException(Code) | | Get a subset of the ready, anticipable and executing activities for current user instances
Parameters:
projectName - the project name a String Collection - the names of activities
throws:
HeroException - |
| getUserJabber | | public String getUserJabber() throws HeroException(Code) | | Get the user jabber address
a String - get user jabber address |
| getUserLightValue | | public BnUserLightValue getUserLightValue() throws HeroException(Code) | | Get the user light value
a BnUserLightValue object - get user information |
| getUserProperties | | public Collection getUserProperties() throws HeroException(Code) | | Get User properties
a BnUserPropertyValue Collection - list of user properties |
| getUserRealInstancesProject | | public Collection getUserRealInstancesProject() throws HeroException(Code) | | Get instance names for this user
a String Collection - the names of workflow instances
throws:
HeroException - |
| setSessionContext | | public void setSessionContext(javax.ejb.SessionContext context)(Code) | | Internal Enterprise Java Beans method.
|
| setUserMail | | public void setUserMail(String userName, String mail) throws HeroException(Code) | | Set the mail of this user into Bonita database.
Parameters:
userName - the name of the user
Parameters:
userName - the mail of the user
throws:
HeroException - |
| setUserProperty | | public void setUserProperty(String key, String value) throws HeroException(Code) | | Set a property of a user
Parameters:
key - the key of the property
Parameters:
value - the name of the property |
| startActivity | | public void startActivity(String projectName, String nodeName) throws HeroException(Code) | | Tries to start an activity (when activity state is ready or anticipable)
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node |
| terminate | | public void terminate(String projectName) throws HeroException(Code) | | Tries to terminate a project (only when all project activities are terminated)
Parameters:
projectName - the name of the project
Parameters:
version - the name of the instance
throws:
HeroException - |
| terminateActivity | | public void terminateActivity(String projectName, String nodeName) throws HeroException(Code) | | Tries to terminate an activity (when activity state is executing or anticipating)
Parameters:
projectName - the name of the project
Parameters:
nodeName - the name of the node |
|
|