org.kuali.rice.krms.api.engine

Class SelectionCriteria

java.lang.Object

org.kuali.rice.krms.api.engine.SelectionCriteria

public final class SelectionCriteria
extends Object

SelectionCritera are used to to select an Agenda to execute.

Author:

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

Method Summary

Modifier and Type	Method and Description
static SelectionCriteria	createCriteria(org.joda.time.DateTime effectiveExecutionTime, Map<String,String> contextQualifiers, Map<String,String> agendaQualifiers) This static factory method creates a SelectionCriteria used to select an Agenda to execute.
Map<String,String>	getAgendaQualifiers()
Map<String,String>	getContextQualifiers()
Long	getEffectiveExecutionTime() This method gets the effective date/time in epoch time, suitable for converting to a Date via Date.Date(long)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createCriteria

public static SelectionCriteria createCriteria(org.joda.time.DateTime effectiveExecutionTime,
                                               Map<String,String> contextQualifiers,
                                               Map<String,String> agendaQualifiers)

This static factory method creates a SelectionCriteria used to select an Agenda to execute.

Parameters:

effectiveExecutionTime - the time that the rule is being executed at. If null, the time of engine execution will be used.

contextQualifiers - qualifiers used to select the context

agendaQualifiers - qualifiers used to select the agenda from the context

Returns:

the SelectionCriteria

getEffectiveExecutionTime

public Long getEffectiveExecutionTime()

This method gets the effective date/time in epoch time, suitable for converting to a Date via Date.Date(long)

Returns:

the epoch time for effective execution, or null (which defers to the Engine but implies that the actual time when execution begins will be used).

getContextQualifiers

public Map<String,String> getContextQualifiers()

Returns:

the map of context qualifiers. May be empty, will never be null.

getAgendaQualifiers

public Map<String,String> getAgendaQualifiers()

Returns:

the map of agenda qualifiers. May be empty, will never be null.