ActionBoService

Name ActionBo
Version
Included Services  
Java Package org.kuali.rice.krms.impl.repository

This is the interface for accessing KRMS repository Action related
business objects.

Operations
Main Message Structures

Method createAction
Description This will create a {@link ActionDefinition} exactly like the parameter passed in.
Parameters ActionDefinition action The Action to create
Return ActionDefinition ???
Errors NONE No Errors

Back to Operations

Method updateAction
Description This will update an existing {@link ActionDefinition}.
Parameters ActionDefinition action The Action to update
Return void ???
Errors NONE No Errors

Back to Operations

Method getActionByActionId
Description Retrieves an Action from the repository based on the given action id.
Parameters String actionId the id of the Action to retrieve
Return ActionDefinition an {@link ActionDefinition} identified by the given actionId.
A null reference is returned if an invalid or non-existent id is supplied.
Errors NONE No Errors

Back to Operations

Method getActionByNameAndNamespace
Description Retrieves an Action from the repository based on the provided action name
and namespace.
Parameters String name the name of the Action to retrieve.
String namespace the namespace that the action is under.
Return ActionDefinition an {@link 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.
Errors NONE No Errors

Back to Operations

Method getActionsByRuleId
Description Retrieves an ordered List of Actions associated with a
{@link org.kuali.rice.krms.api.repository.rule.RuleDefinition}.
The order of the list is determined by the sequenceNumber property
of the Actions.
Parameters String ruleId the id of the rule
Return ActionDefinitionList a list of {@link ActionDefinition} associated with the given rule.
A null reference is returned if an invalid or ruleId is supplied.
Errors NONE No Errors

Back to Operations

Method getActionByRuleIdAndSequenceNumber
Description Retrieves an specific Action associated with a Rule.
Parameters String ruleId the id of the rule
Integer sequenceNumber an Integer that represents the sequence number of the action.
Return ActionDefinition an {@link 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.
Errors NONE No Errors

Back to Operations