Package org.kuali.rice.kew.impl.peopleflow

Class PeopleFlowRouteModule

java.lang.Object
org.kuali.rice.kew.impl.peopleflow.PeopleFlowRouteModule
All Implemented Interfaces:
RouteModule
public class PeopleFlowRouteModule extends Object implements RouteModule

  • Field Details

  • Constructor Details

    • PeopleFlowRouteModule

      public PeopleFlowRouteModule()

  • Method Details

    • findActionRequests

      public List<ActionRequestValue> findActionRequests(RouteContext context) throws Exception
      Description copied from interface: RouteModule
      Generate action requests for the given RouteContext.

      The list of requests returned should only contain root action requests (those with no parent).

      Specified by:
      findActionRequests in interface RouteModule
      Returns:
      A List of the generated ActionRequestValue objects.
      Throws:
      Exception

    • isMoreRequestsAvailable

      public boolean isMoreRequestsAvailable(RouteContext context)
      Description copied from interface: RouteModule
      Returns true if this RouteModule has more requests available which it can generate. This method will only be called after the first set of action requests returned by the first invocation of findActionRequests have been fully activated. If this method returns true, findActionRequests will be invoked again and those requests will all be activated before the cycle continues until this method returns false;
      Specified by:
      isMoreRequestsAvailable in interface RouteModule
      Parameters:
      context - the route context
      Returns:
      true if this route module has more requests it can generate, false otherwise

    • resolveResponsibilityId

      public ResponsibleParty resolveResponsibilityId(String responsibilityId) throws WorkflowException
      Description copied from interface: RouteModule
      The route module will re-resolve the given responsibilityId and return an object that contains the key to either a user, group, or role. The original responsibility associated with the given id will then be swapped with the new ResponsibleParty when routing is resolved.

      This method is intended to allow for the calling code to be able to "switch-out" one responsibility for another (in the case of a change to an assigned reponsibility).

      Returning null from this method will indicate that the original responsibile party should remain unchanged. This is typically the recommended default for implementation of this method and covers most use cases.

      Specified by:
      resolveResponsibilityId in interface RouteModule
      Parameters:
      responsibilityId - the id of the responsibility to be resolved
      Returns:
      the responsibility party with which to replace the original responsibility, or null if the responsibility should remain unchanged.
      Throws:
      WorkflowException

    • parsePeopleFlowConfiguration

      protected List<org.kuali.rice.kew.impl.peopleflow.PeopleFlowRouteModule.PeopleFlowConfig> parsePeopleFlowConfiguration(RouteContext context)

    • loadPeopleFlow

      protected PeopleFlowDefinition loadPeopleFlow(org.kuali.rice.kew.impl.peopleflow.PeopleFlowRouteModule.PeopleFlowConfig configuration)

    • getPeopleFlowService

      public PeopleFlowService getPeopleFlowService()

    • setPeopleFlowService

      public void setPeopleFlowService(PeopleFlowService peopleFlowService)

    • getPeopleFlowRequestGenerator

      public PeopleFlowRequestGenerator getPeopleFlowRequestGenerator()

    • setPeopleFlowRequestGenerator

      public void setPeopleFlowRequestGenerator(PeopleFlowRequestGenerator peopleFlowRequestGenerator)