org.kuali.rice.krms.api.repository
Interface BaseAttributeContract

All Superinterfaces:
Identifiable
All Known Implementing Classes:
BaseAttribute, BaseAttribute.Builder

public interface BaseAttributeContract
extends Identifiable

Base interface intended for extension by other AttributeContract interfaces

This contains the common fields shared by all KRMS attributes.

Author:
Kuali Rice Team (rice.collab@kuali.org)

Method Summary
 KrmsAttributeDefinitionContract getAttributeDefinition()
          Returns a KrmsAttributeDefinitionContract.
 String getAttributeDefinitionId()
          Returns the id of the attribute definition.
 String getValue()
          Returns the value of the attribute
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable
getId
 

Method Detail

getAttributeDefinitionId

String getAttributeDefinitionId()
Returns the id of the attribute definition.

The attribute definition contains metadata about the attribute. This is a required field and may not be null or blank. Many attribute instances may share the same attribute definition.

Returns:
the attribute definition id

getValue

String getValue()
Returns the value of the attribute

Returns:
the value of the attribute

getAttributeDefinition

KrmsAttributeDefinitionContract getAttributeDefinition()
Returns a KrmsAttributeDefinitionContract.

This is the object referred to by the attributeDefinitionId. The full object is also kept here for performance purposes. This is because the name of the attribute is referenced often for resolving name / value attribute pairs.

Returns:
the attribute definition


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