org.kuali.rice.krms.framework.type

Interface ValidationActionService

public interface ValidationActionService

Service for ValidationActions

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
ActionDefinition	createValidation(ActionDefinition validation) Create a Validation Action
ActionDefinition	getValidation(String validationId) Return the ActionDefinition given the validationId
ActionDefinition	getValidationByName(String namespaceCode, String name) Return the ActionDefinition given the namespaceCode and name
ActionDefinition	updateValidation(ActionDefinition validation) Update a Validation Action

Method Detail

getValidation

ActionDefinition getValidation(String validationId)
                        throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Return the ActionDefinition given the validationId

Parameters:

validationId - of the ActionDefinition to return

Returns:

ActionDefinition whose value is of the given validationId

Throws:

{@link - RiceIllegalArgumentException}

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

getValidationByName

ActionDefinition getValidationByName(String namespaceCode,
                                     String name)
                              throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Return the ActionDefinition given the namespaceCode and name

Parameters:

namespaceCode - of the ActionDefinition to return

name - of the ActionDefinition to return

Returns:

ActionDefinition whose namespaceCode and name are of those given

Throws:

{@link - RiceIllegalArgumentException}

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

createValidation

ActionDefinition createValidation(ActionDefinition validation)
                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

Create a Validation Action

Parameters:

validation - ActionDefinition to create

Returns:

ActionDefinition created

Throws:

{@link - RiceIllegalArgumentException} if the given Validation definition is null

{@link - RiceIllegalArgumentException} if the given Validation definition has a non-null id. When creating a new Validation definition, the ID will be generated.

{@link - RiceIllegalStateException} if a Validation with the given namespace code and name already exists

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

org.kuali.rice.core.api.exception.RiceIllegalStateException

updateValidation

ActionDefinition updateValidation(ActionDefinition validation)
                           throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                  org.kuali.rice.core.api.exception.RiceIllegalStateException

Update a Validation Action

Parameters:

validation - ActionDefinition to create

Returns:

ActionDefinition updated

Throws:

{@link - RiceIllegalArgumentException} if the given Validation definition is null

{@link - RiceIllegalStateException} if the Validation does not exist in the system under the given validationId

org.kuali.rice.core.api.exception.RiceIllegalArgumentException

org.kuali.rice.core.api.exception.RiceIllegalStateException