Coverage Report - org.kuali.rice.kim.api.type.KimTypeContract
 
Classes in this File Line Coverage Branch Coverage Complexity
KimTypeContract
N/A
N/A
1
 
 1  
 /*
 2  
  * Copyright 2006-2011 The Kuali Foundation
 3  
  *
 4  
  * Licensed under the Educational Community License, Version 2.0 (the "License");
 5  
  * you may not use this file except in compliance with the License.
 6  
  * You may obtain a copy of the License at
 7  
  *
 8  
  * http://www.opensource.org/licenses/ecl2.php
 9  
  *
 10  
  * Unless required by applicable law or agreed to in writing, software
 11  
  * distributed under the License is distributed on an "AS IS" BASIS,
 12  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13  
  * See the License for the specific language governing permissions and
 14  
  * limitations under the License.
 15  
  */
 16  
 
 17  
 package org.kuali.rice.kim.api.type;
 18  
 
 19  
 import org.kuali.rice.core.api.mo.common.GloballyUnique;
 20  
 import org.kuali.rice.core.api.mo.common.Identifiable;
 21  
 import org.kuali.rice.core.api.mo.common.Versioned;
 22  
 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
 23  
 
 24  
 import java.util.List;
 25  
 
 26  
 /**
 27  
  * This is the contract for a KimType.  A KimType is a metadata wrapper around a
 28  
  * kim type service which aides in attribute resolution.
 29  
  */
 30  
 public interface KimTypeContract extends Versioned, GloballyUnique, Identifiable, Inactivatable {
 31  
 
 32  
     /**
 33  
      * The service name used to resolve attribute values.
 34  
      *
 35  
      * @return the service name
 36  
      */
 37  
     String getServiceName();
 38  
 
 39  
     /**
 40  
      * The namespace code that this kim type belongs too.
 41  
      *
 42  
      * @return namespace code
 43  
      */
 44  
     String getNamespaceCode();
 45  
 
 46  
     /**
 47  
      * The name of the kim type.
 48  
      *
 49  
      * @return the name
 50  
      */
 51  
     String getName();
 52  
 
 53  
     /**
 54  
      * The list of attribute definitions associated with the kim type. This cannot be null.  If no
 55  
      * attribute definitions are associated with the kim type then this will return an empty collection.
 56  
      *
 57  
      * @return the list of attribute definitions
 58  
      */
 59  
     List<? extends KimTypeAttributeContract> getAttributeDefinitions();
 60  
 }