Package org.kuali.rice.krms.impl.repository

Interface ActionBoService

All Known Implementing Classes:
ActionBoServiceImpl
public interface ActionBoService
This is the interface for accessing KRMS repository Action related business objects.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    org.kuali.rice.krms.api.repository.action.ActionDefinition
    createAction(org.kuali.rice.krms.api.repository.action.ActionDefinition action)
    This will create a ActionDefinition exactly like the parameter passed in.
    org.kuali.rice.krms.api.repository.action.ActionDefinition
    getActionByActionId(String actionId)
    Retrieves an Action from the repository based on the given action id.
    org.kuali.rice.krms.api.repository.action.ActionDefinition
    getActionByNameAndNamespace(String name, String namespace)
    Retrieves an Action from the repository based on the provided action name and namespace.
    org.kuali.rice.krms.api.repository.action.ActionDefinition
    getActionByRuleIdAndSequenceNumber(String ruleId, Integer sequenceNumber)
    Retrieves an specific Action associated with a Rule.
    List<org.kuali.rice.krms.api.repository.action.ActionDefinition>
    getActionsByRuleId(String ruleId)
    Retrieves an ordered List of Actions associated with a RuleDefinition.
    org.kuali.rice.krms.api.repository.action.ActionDefinition
    updateAction(org.kuali.rice.krms.api.repository.action.ActionDefinition action)
    This will update an existing ActionDefinition.

  • Method Details

    • createAction

      @CacheEvict(value={"http://rice.kuali.org/krms/v2_0/ActionType","http://rice.kuali.org/krms/v2_0/RuleType"}, allEntries=true) org.kuali.rice.krms.api.repository.action.ActionDefinition createAction(org.kuali.rice.krms.api.repository.action.ActionDefinition action)
      This will create a ActionDefinition exactly like the parameter passed in.
      Parameters:
      action - The Action to create
      Throws:
      IllegalArgumentException - if the action is null
      IllegalStateException - if the action already exists in the system

    • updateAction

      @CacheEvict(value={"http://rice.kuali.org/krms/v2_0/ActionType","http://rice.kuali.org/krms/v2_0/RuleType"}, allEntries=true) org.kuali.rice.krms.api.repository.action.ActionDefinition updateAction(org.kuali.rice.krms.api.repository.action.ActionDefinition action)
      This will update an existing ActionDefinition.
      Parameters:
      action - The Action to update
      Throws:
      IllegalArgumentException - if the Action is null
      IllegalStateException - if the Action does not exists in the system

    • getActionByActionId

      @Cacheable(value="http://rice.kuali.org/krms/v2_0/ActionType", key="\'actionId=\' + #p0") org.kuali.rice.krms.api.repository.action.ActionDefinition getActionByActionId(String actionId)
      Retrieves an Action from the repository based on the given action id.
      Parameters:
      actionId - the id of the Action to retrieve
      Returns:
      an ActionDefinition identified by the given actionId. A null reference is returned if an invalid or non-existent id is supplied.
      Throws:
      IllegalArgumentException - if the actionId is null or blank.

    • getActionByNameAndNamespace

      @Cacheable(value="http://rice.kuali.org/krms/v2_0/ActionType", key="\'name=\' + #p0 + \'|\' + \'namespace=\' + #p1") org.kuali.rice.krms.api.repository.action.ActionDefinition getActionByNameAndNamespace(String name, String namespace)
      Retrieves an Action from the repository based on the provided action name and namespace.
      Parameters:
      name - the name of the Action to retrieve.
      namespace - the namespace that the action is under.
      Returns:
      an ActionDefinition identified by the given name and namespace. A null reference is returned if an invalid or non-existent name and namespace combination is supplied.
      Throws:
      IllegalArgumentException - if the either the name or the namespace is null or blank.

    • getActionsByRuleId

      @Cacheable(value="http://rice.kuali.org/krms/v2_0/ActionType", key="\'ruleId=\' + #p0") List<org.kuali.rice.krms.api.repository.action.ActionDefinition> getActionsByRuleId(String ruleId)
      Retrieves an ordered List of Actions associated with a RuleDefinition. The order of the list is determined by the sequenceNumber property of the Actions.
      Parameters:
      ruleId - the id of the rule
      Returns:
      a list of ActionDefinition associated with the given rule. A null reference is returned if an invalid or ruleId is supplied.
      Throws:
      IllegalArgumentException - if the ruleId is null or blank.

    • getActionByRuleIdAndSequenceNumber

      @Cacheable(value="http://rice.kuali.org/krms/v2_0/ActionType", key="\'ruleId=\' + #p0 + \'|\' + \'sequenceNumber=\' + #p1") org.kuali.rice.krms.api.repository.action.ActionDefinition getActionByRuleIdAndSequenceNumber(String ruleId, Integer sequenceNumber)
      Retrieves an specific Action associated with a Rule.
      Parameters:
      ruleId - the id of the rule
      sequenceNumber - an Integer that represents the sequence number of the action.
      Returns:
      an ActionDefinition identified associated with the Rule and identified by the given sequenceNumber A null reference is returned if an invalid or non-existent name and namespace combination is supplied.
      Throws:
      IllegalArgumentException - if the ruleId is null or blank. Or if the sequenceNumber is null.