Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.jbpm.workflow.organisation
Interface OrganisationComponent  view OrganisationComponent download OrganisationComponent.java


public interface OrganisationComponent

is this component's interface that is used by the process execution component for obtaining organisational information such as Users, Groups and Memberships.

The implementation of this component can be customized so that organisational data is fetched from whatever IT-system. Therefor the organisation-component is only accessed by the other components through this local interface, never directly to the database. This design makes it easier to change the implementation of this component so that it is coupled to e.g. an LDAP server instead of the default jBpm-database-tables.

This interface is kept minimal so providing a custom implementation is easy. An organisation can extend this interface easily to make the added functionality available to Interactions and other delegation classes.


Method Summary
 Group createGroup(java.lang.String groupName, java.util.Collection userNames)
          allows to create groups on the fly to assign an activity to the group of users that are selected for a specific activity.
 Group createGroup(java.lang.String groupName, java.util.Collection userNames, org.jbpm.util.client.Relations relations)
           
 Actor findActorById(java.lang.String actorId)
           
 Actor findActorById(java.lang.String actorId, org.jbpm.util.client.Relations relations)
           
 java.util.Collection findAllUsers()
           
 java.util.Collection findAllUsers(org.jbpm.util.client.Relations relations)
           
 Group findGroupById(java.lang.String groupId)
           
 Group findGroupById(java.lang.String groupId, org.jbpm.util.client.Relations relations)
           
 Group findGroupByMembership(java.lang.String userName, java.lang.String membershipType)
           
 Group findGroupByMembership(java.lang.String userName, java.lang.String membershipType, org.jbpm.util.client.Relations relations)
           
 java.util.Collection findMembershipsByUserAndGroup(java.lang.String userName, java.lang.String groupName)
           
 java.util.Collection findMembershipsByUserAndGroup(java.lang.String userName, java.lang.String groupName, org.jbpm.util.client.Relations relations)
           
 User findUserById(java.lang.String userId)
           
 User findUserById(java.lang.String userId, org.jbpm.util.client.Relations relations)
           
 java.util.Collection findUsersByGroupAndRole(java.lang.String groupName, java.lang.String role)
           
 java.util.Collection findUsersByGroupAndRole(java.lang.String groupName, java.lang.String role, org.jbpm.util.client.Relations relations)
           
 

Method Detail

findActorById

public Actor findActorById(java.lang.String actorId)

findActorById

public Actor findActorById(java.lang.String actorId,
                           org.jbpm.util.client.Relations relations)

findUserById

public User findUserById(java.lang.String userId)

findUserById

public User findUserById(java.lang.String userId,
                         org.jbpm.util.client.Relations relations)

findGroupById

public Group findGroupById(java.lang.String groupId)

findGroupById

public Group findGroupById(java.lang.String groupId,
                           org.jbpm.util.client.Relations relations)

findAllUsers

public java.util.Collection findAllUsers()

findAllUsers

public java.util.Collection findAllUsers(org.jbpm.util.client.Relations relations)

findUsersByGroupAndRole

public java.util.Collection findUsersByGroupAndRole(java.lang.String groupName,
                                                    java.lang.String role)

findUsersByGroupAndRole

public java.util.Collection findUsersByGroupAndRole(java.lang.String groupName,
                                                    java.lang.String role,
                                                    org.jbpm.util.client.Relations relations)

findMembershipsByUserAndGroup

public java.util.Collection findMembershipsByUserAndGroup(java.lang.String userName,
                                                          java.lang.String groupName)

findMembershipsByUserAndGroup

public java.util.Collection findMembershipsByUserAndGroup(java.lang.String userName,
                                                          java.lang.String groupName,
                                                          org.jbpm.util.client.Relations relations)

findGroupByMembership

public Group findGroupByMembership(java.lang.String userName,
                                   java.lang.String membershipType)

findGroupByMembership

public Group findGroupByMembership(java.lang.String userName,
                                   java.lang.String membershipType,
                                   org.jbpm.util.client.Relations relations)

createGroup

public Group createGroup(java.lang.String groupName,
                         java.util.Collection userNames)
allows to create groups on the fly to assign an activity to the group of users that are selected for a specific activity. (feature under construction)


createGroup

public Group createGroup(java.lang.String groupName,
                         java.util.Collection userNames,
                         org.jbpm.util.client.Relations relations)