org.kuali.rice.krms.framework.type
Interface RemotableAttributeOwner

All Known Subinterfaces:
ActionTypeService, AgendaTypeService, RuleTypeService, ValidationActionTypeService, ValidationRuleTypeService
All Known Implementing Classes:
ActionTypeServiceBase, AgendaTypeServiceBase, AgendaTypeServiceImpl, CampusAgendaTypeService, KrmsTypeServiceBase, PeopleFlowActionTypeService, RuleTypeServiceBase, ValidationActionTypeServiceImpl, ValidationRuleTypeServiceImpl

public interface RemotableAttributeOwner

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


Method Summary
 List<RemotableAttributeField> getAttributeFields(String krmsTypeId)
          get the attributes supported by the people flow type with the given krmsTypeId.
 List<RemotableAttributeError> validateAttributes(String krmsTypeId, Map<String,String> attributes)
          This method validates the passed in attributes for a krmsTypeId generating a List of RemotableAttributeErrors.
 List<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<RemotableAttributeField> getAttributeFields(String krmsTypeId)
                                                 throws RiceIllegalArgumentException

get the attributes supported by the people flow 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:
RiceIllegalArgumentException

validateAttributes

List<RemotableAttributeError> validateAttributes(String krmsTypeId,
                                                 Map<String,String> attributes)
                                                 throws 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:
RiceIllegalArgumentException

validateAttributesAgainstExisting

List<RemotableAttributeError> validateAttributesAgainstExisting(String krmsTypeId,
                                                                Map<String,String> newAttributes,
                                                                Map<String,String> oldAttributes)
                                                                throws 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:
RiceIllegalArgumentException


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.