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

Interface ContextDefinitionContract

All Superinterfaces:

Identifiable, Inactivatable, Versioned

All Known Implementing Classes:

ContextBo, ContextDefinition, ContextDefinition.Builder

public interface ContextDefinitionContract
extends Versioned, Identifiable, Inactivatable

An interface which defines the contract for context definition objects.

A context is a set of related krms entities. A context definition defines information about a context which can be loaded into the rules engine for evaluation. A context definition includes a list of agendas which are valid within the context. Typically, during rule engine execution, one or more of these agendas is selected for execution based on a given set of selection criteria. All KRMS components (agendas, rules, actions, terms, etc.) must be of the same context to work together. It is up to the client implementor to choose how broadly or finely grained the scope of the context is to be.

Author:

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

Method Summary

Modifier and Type	Method and Description
List<? extends AgendaDefinitionContract>	getAgendas() Returns the list of agendas AgendaDefinitionContract contained in the context definition.
Map<String,String>	getAttributes() Returns a map of name/value pairs representing the attributes associated with this 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

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

isActive

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 AgendaDefinitionContract contained in the context definition. This method should never return null. An empty list is returned if no agendas are associated with this context.

Returns:

the list of agendas contained in this context definition

getAttributes

Map<String,String> getAttributes()

Returns a map of name/value pairs representing the attributes associated with this context.

This method should never return null. An empty map is returned if no attributes are associated with the context.

Returns:

a list of Map of name/value String pairs.