org.kuali.rice.krms.api.repository.context
Interface ContextDefinitionContract

All Superinterfaces:

Identifiable, Versioned

All Known Implementing Classes:

ContextDefinition, ContextDefinition.Builder

public interface ContextDefinitionContract
extends Versioned, Identifiable

An interface which defines the contract for context definition objects.

Author:

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

Method Summary

List<? extends AgendaDefinitionContract>	getAgendas() Returns the list of agendas contained within the context definition.
Map<String,String>	getAttributes() This method returns a list of attributes associated with the a context.
String	getDescription() Returns the description of the context definition.
String	getName() Returns the name of the context definition.
String	getNamespace() Returns the namespace of the context definition.
String	getTypeId() Returns the type id for the context definition.

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

getVersionNumber

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

getId

Method Detail

getNamespace

String getNamespace()

Returns the namespace of the context definition. The combination of namespace and name represent a unique business key for the context definition. The namespace should never be null or blank.

Returns:

the namespace of the context definition, should never be null or blank

getName

String getName()

Returns the name of the context definition. The combination of name and namespaceCode represent a unique business key for the context definition. The name should never be null or blank.

Returns:

the name of the context definition, should never be null or blank

getTypeId

String getTypeId()

Returns the type id for the context definition. If the type id is null, that means this context definition is of the default type.

Returns:

the type id for the context definition, or null if this context definition is of the default type

getDescription

String getDescription()

Returns the description of the context definition.

Returns:

the description of the context definition. May be null.

getAgendas

List<? extends AgendaDefinitionContract> getAgendas()

Returns the list of agendas contained within the context definition. This method should never return null but can return null.

Returns:

the set of agendas on the context definition

getAttributes

Map<String,String> getAttributes()

This method returns a list of attributes associated with the a context.

Returns:

a list of AgendaAttribute objects.