Interface OsidRuleApplicatorCondition

All Superinterfaces:

Extensible, OsidCondition, OsidEnablerCondition, Suppliable

public interface OsidRuleApplicatorCondition
extends OsidEnablerCondition

The OsidApplicatorCondition is used to input conditions into an OsidApplicator evaluation.

Method Summary

Modifier and Type	Method	Description
void	setResource(Id resourceId)	Sets the resource for the evaluation.
void	setTimePeriod(Id timePeriodId)	Sets the time period for the evaluation.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Method Details

setTimePeriod

void setTimePeriod(Id timePeriodId)

Sets the time period for the evaluation. Dates and TimePeriods are often independent dimensions. Although a TimePeriod spans dates, it also serves as the reporting time period in which something may pertain. For example, an OsidRule that is in effect for Q3FY2015 is in effect for transactions that pertain to Q3FY2015 although they may be submitted before or after the time period. OsidRuleApplicators may be active for a TimePeriod , or they may apply to a TimePeriod , or both. This input may be superseded by other data. For example, a supplied request via an OsidEnablerConditionRecord may contain the applicable time period.

Parameters:

timePeriodId - the time period Id

Throws:

NullArgumentException - timePeriodId is null

Compliance:

mandatory - This method must be implemented.

setResource

void setResource(Id resourceId)

Sets the resource for the evaluation. OsidRuleApplicators may apply to resource demographic rules. This Resource is the individual to evaluate against these groups. If not supplied but required in the OsidRuleApplicator evaluation, an anonymous Resource may be used. This input may be superseded by other data. For example, a supplied request via an OsidRuleApplicatorConditionRecord may contain the identity of the person of thing to which the OsidRuleApplicator is evaluated.

Parameters:

resourceId - the resource Id

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.