ContextDefinition

Name ContextDefinition
Usage RuleRepositoryService ContextBoService
selectContext createContext updateContext getContextByContextId getContextByNameAndNamespace
Type Complex

Description

An immutable representation of a context definition. 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.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Id String The unique identifier for an object. This can be null.     One No  
namespace Namespace String 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.		 Required   One No  
name Name String 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.		 Required   One No  
typeId Type Id String Returns the type id for the context definition. If the type id is null, that means
this context definition is of the default type.		     One No  
description Description String Returns the description of the context definition.     One No  
active Active boolean The active indicator for an object.     One No  
agendas Agendas AgendaDefinitionList Returns the list of agendas {@link 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.		     Many No  
attributes Attributes Map 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.

     One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.		     One No