Package org.kuali.rice.krms.framework.type

Interface ValidationRuleTypeService

All Superinterfaces:

RemotableAttributeOwner, RuleTypeService

public interface ValidationRuleTypeService
extends RuleTypeService

invalid reference

ValidationRule

Service

Author:

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

See Also:

• invalid reference

  ValidationRule

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VALIDATIONS_RULE_TYPE_CODE_ATTRIBUTE	VALIDATIONS_RULE_TYPE_CODE_ATTRIBUTE - Database krms_attr_defn_t NM value

Method Summary

Modifier and Type	Method	Description
List<org.kuali.rice.core.api.uif.RemotableAttributeField>	getAttributeFields(String krmsTypeId)	get the attributes supported by the type with the given krmsTypeId.
Rule	loadRule(RuleDefinition validationRuleDefinition)	Load the Rule given the RuleDefinition
List<org.kuali.rice.core.api.uif.RemotableAttributeError>	validateAttributes(String krmsTypeId, Map<String,String> attributes)	This method validates the passed in attributes for a krmsTypeId generating a List of RemotableAttributeErrors.
List<org.kuali.rice.core.api.uif.RemotableAttributeError>	validateAttributesAgainstExisting(String krmsTypeId, Map<String,String> newAttributes, Map<String,String> oldAttributes)	This method validates the passed in attributes for a krmsTypeId generating a List of RemotableAttributeErrors.

Field Details

VALIDATIONS_RULE_TYPE_CODE_ATTRIBUTE

static final String VALIDATIONS_RULE_TYPE_CODE_ATTRIBUTE

VALIDATIONS_RULE_TYPE_CODE_ATTRIBUTE - Database krms_attr_defn_t NM value

See Also:

• Constant Field Values

Method Details

loadRule

Rule loadRule(RuleDefinition validationRuleDefinition)

Description copied from interface: RuleTypeService

Load the Rule given the RuleDefinition

Specified by:

loadRule in interface RuleTypeService

Parameters:

validationRuleDefinition - RuleDefinition to create a Rule from

Returns:

Rule created from the given RuleDefinition

getAttributeFields

List<org.kuali.rice.core.api.uif.RemotableAttributeField> getAttributeFields(String krmsTypeId)
                                                                      throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Description copied from interface: RemotableAttributeOwner

get the attributes supported by the type with the given krmsTypeId.

Specified by:

getAttributeFields in interface RemotableAttributeOwner

Parameters:

krmsTypeId - the people flow type identifier. Must not be null or blank.

Returns:

the RemotableAttributeFields that the PeopleFlow type with the given id supports. Will not return null.

Throws:

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

validateAttributesAgainstExisting

List<org.kuali.rice.core.api.uif.RemotableAttributeError> validateAttributesAgainstExisting(String krmsTypeId,
 Map<String,String> newAttributes,
 Map<String,String> oldAttributes)
                                                                                     throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Description copied from interface: RemotableAttributeOwner

This method validates the passed in attributes for a krmsTypeId generating a List of RemotableAttributeErrors. This method used the oldAttributes to aid in validation. This is useful for validating "new" or "updated" attributes.

Specified by:

validateAttributesAgainstExisting in interface RemotableAttributeOwner

Parameters:

krmsTypeId - the people flow type identifier. Must not be null or blank.

newAttributes - the kim type attributes to validate. Cannot be null.

oldAttributes - the old attributes to use for validation. Cannot be null.

Returns:

any errors that are discovered during validation. Will not return null.

Throws:

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

validateAttributes

List<org.kuali.rice.core.api.uif.RemotableAttributeError> validateAttributes(String krmsTypeId,
 Map<String,String> attributes)
                                                                      throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Description copied from interface: RemotableAttributeOwner

This method validates the passed in attributes for a krmsTypeId generating a List of RemotableAttributeErrors.

Specified by:

validateAttributes in interface RemotableAttributeOwner

Parameters:

krmsTypeId - the people flow type identifier. Must not be null or blank.

attributes - the attributes to validate. Cannot be null.

Returns:

any errors that are discovered during validation. Will not return null.

Throws:

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