org.kuali.rice.krms.framework.type

Interface RemotableAttributeOwner

All Known Subinterfaces:

ActionTypeService, AgendaTypeService, RuleTypeService, ValidationActionTypeService, ValidationRuleTypeService

public interface RemotableAttributeOwner

Interface to be extended by type services that have remotable attributes that will need to be rendered and validated

Method Summary

Modifier and Type	Method and Description
List<org.kuali.rice.core.api.uif.RemotableAttributeField>	getAttributeFields(String krmsTypeId) get the attributes supported by the type with the given krmsTypeId.
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.

Method Detail

getAttributeFields

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

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

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

validateAttributes

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

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

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

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

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.

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