org.kuali.rice.kim.api.type
Interface KimTypeContract

All Superinterfaces:
GloballyUnique, Identifiable, Inactivatable, Versioned
All Known Implementing Classes:
KimType, KimType.Builder

public interface KimTypeContract
extends Versioned, GloballyUnique, Identifiable, Inactivatable

This is the contract for a KimType. A KimType is a metadata wrapper around a kim type service which aides in attribute resolution.


Method Summary
 List<? extends KimTypeAttributeContract> getAttributeDefinitions()
          The list of attribute definitions associated with the kim type.
 String getName()
          The name of the kim type.
 String getNamespaceCode()
          The namespace code that this kim type belongs too.
 String getServiceName()
          The service name used to resolve attribute values.
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned
getVersionNumber
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique
getObjectId
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable
getId
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable
isActive
 

Method Detail

getServiceName

String getServiceName()
The service name used to resolve attribute values.

Returns:
the service name

getNamespaceCode

String getNamespaceCode()
The namespace code that this kim type belongs too.

Returns:
namespace code

getName

String getName()
The name of the kim type.

Returns:
the name

getAttributeDefinitions

List<? extends KimTypeAttributeContract> getAttributeDefinitions()
The list of attribute definitions associated with the kim type. This cannot be null. If no attribute definitions are associated with the kim type then this will return an empty collection.

Returns:
the list of attribute definitions


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