/*

  * Copyright 2007-2008 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.opensource.org/licenses/ecl2.php

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kim.service.support;

 import java.util.List;

 import org.kuali.rice.core.util.KeyLabelPair;

 import org.kuali.rice.kim.bo.types.dto.AttributeDefinitionMap;

 import org.kuali.rice.kim.bo.types.dto.AttributeSet;

 /**

  *  This is the base service interface for handling type-specific behavior.  Types can be attached

  *  to various objects (currently groups and roles) in KIM to add additional attributes and

  *  modify their behavior.

  * 

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

  *

  */

 public interface KimTypeService {

         /**

          * Get the workflow document type which

          * will be used for the role qualifiers when routing objects with this type.

          * 

          * If no special document type is needed, this method must return null.

          */

         String getWorkflowDocumentTypeName();

         /**

          * Perform validation on the attributes of an object.  The resultant map

          * will contain (attributeName,errorMessage) pairs from the validation process.

          * An empty map or null indicates that there were no errors.

          * 

          * This method can be used to perform compound validations across multiple

          * attributes attached to an object.

          */

         AttributeSet validateAttributes(String kimTypeId, AttributeSet attributes);

         AttributeSet validateAttributesAgainstExisting(String kimTypeId, AttributeSet newAttributes, AttributeSet oldAttributes);

         AttributeSet validateUnmodifiableAttributes(String kimTypeId, AttributeSet mainAttributes, AttributeSet delegationAttributes);

         boolean validateUniqueAttributes(String kimTypeId, AttributeSet newAttributes, AttributeSet oldAttributes);

     List<KeyLabelPair> getAttributeValidValues(String kimTypeId, String attributeName);

     AttributeDefinitionMap getAttributeDefinitions(String kimTypeId);

     List<String> getWorkflowRoutingAttributes( String routeLevel );

     List<String> getUniqueAttributes(String kimTypeId);

 }