org.kuali.rice.krms.api.repository.type

Interface KrmsTypeAttributeContract

All Superinterfaces:

Identifiable, Inactivatable, Versioned

All Known Implementing Classes:

KrmsTypeAttribute, KrmsTypeAttribute.Builder

public interface KrmsTypeAttributeContract
extends Identifiable, Inactivatable, Versioned

This is the contract for a KrmsTypeAttribute.

A KrmsTypeAttribute associates a KrmsTypeDefinition with an individual attribute KrmsAttributeDefinition associated with a the KrmsTypeDefinition.

See Also:

KrmsTypeAttributeContract

Method Summary

Modifier and Type	Method and Description
String	getAttributeDefinitionId() Returns the id of the KrmsAttributeDefinition of the attribute.
Integer	getSequenceNumber() Returns the sequence number of the attribute within the KrmsTypeDefinition collection.
String	getTypeId() Returns the id of the KrmsTypeDefinition to which the attribute applies

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

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Method Detail

getTypeId

String getTypeId()

Returns the id of the KrmsTypeDefinition to which the attribute applies

A KRMS type definition has zero or more attributes associated with it. The id field indicates which type definition this attribute is associated with. It is the id of a KrmsTypeDefinition related to the attribute. This required field may not be null or blank.

Returns:

id for KrmsTypeDefinition related to the attribute.

getAttributeDefinitionId

String getAttributeDefinitionId()

Returns the id of the KrmsAttributeDefinition of the attribute.

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

Returns:

the attribute definition id

getSequenceNumber

Integer getSequenceNumber()

Returns the sequence number of the attribute within the KrmsTypeDefinition collection.

The list of attributes is an ordered list. This value represents the position in the list and cannot be null.

Returns:

the sequence number of the attribute