oracle.rules.rl

Interface Rule

All Superinterfaces:

java.io.Serializable

public interface Rule
extends java.io.Serializable

Field Summary

Fields

Modifier and Type	Field and Description
static int	EDFORM_DATE Specifies that the effective date properties should be interpreted as date only.
static int	EDFORM_DATETIME Specifies that the effective date properties should be interpreted as date and time.
static int	EDFORM_TIME Specifies that the effective date properties should be interpreted as time only.

Method Summary

Modifier and Type	Method and Description
int	getEffectiveDateForm() Returns the current form in use for the effective date properties.
java.util.Calendar	getEffectiveEndDate() Returns the effective end date or null if a end date has not been specified for the rule.
java.util.Calendar	getEffectiveStartDate() Returns the effective start date or null if a start date has not been specified for the rule.
java.lang.String	getName() Returns the name of the rule.
int	getPriority() Returns the rule priority.
Ruleset	getRuleset() Returns the Ruleset instance for the ruleset this rule is defined in.
boolean	isActive() Returns true if the rule is active.
boolean	isAutoFocus() Returns the value of this rule's autofocus property.
boolean	isLoop() Returns the value of this rule's loop property.
void	setActive(boolean active) Sets the rule to be active (true) or inactive (false).
void	setEffectiveDateForm(int newForm) Sets the form to use for handling the effective date properties.
void	setEffectiveEndDate(java.util.Calendar endDate) Sets the effective end date for the rule.
void	setEffectiveStartDate(java.util.Calendar startDate) Sets the effective start date for the rule.

Field Detail

EDFORM_DATETIME

static final int EDFORM_DATETIME

Specifies that the effective date properties should be interpreted as date and time. This form is valid to use with effective dates where either the date or date and time have been specified. This is the default.

See Also:

Constant Field Values

EDFORM_DATE

static final int EDFORM_DATE

Specifies that the effective date properties should be interpreted as date only.

See Also:

Constant Field Values

EDFORM_TIME

static final int EDFORM_TIME

Specifies that the effective date properties should be interpreted as time only.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of the rule.

Returns:

the name of the rule.

getRuleset

Ruleset getRuleset()

Returns the Ruleset instance for the ruleset this rule is defined in.

Returns:

the Ruleset instance for the ruleset this rule is defined in.

getPriority

int getPriority()
         throws RLException

Returns the rule priority.

Returns:

the rule priority

Throws:

RLException

isAutoFocus

boolean isAutoFocus()
             throws RLException

Returns the value of this rule's autofocus property.

Returns:

the autofocus value.

Throws:

RLException

isLoop

boolean isLoop()
        throws RLException

Returns the value of this rule's loop property.

Returns:

the loop value.

Throws:

RLException

isActive

boolean isActive()
          throws RLException

Returns true if the rule is active.

Returns:

true if the rule is active.

Throws:

RLException

setActive

void setActive(boolean active)
        throws RLException

Sets the rule to be active (true) or inactive (false).

Parameters:

active - sets the rule to be active (true) or inactive (false).

Throws:

RLException

getEffectiveStartDate

java.util.Calendar getEffectiveStartDate()
                                  throws RLException

Returns the effective start date or null if a start date has not been specified for the rule.

Returns:

the effective start date.

Throws:

RLException

setEffectiveStartDate

void setEffectiveStartDate(java.util.Calendar startDate)
                    throws RLException

Sets the effective start date for the rule. A value of null unsets the effective start date.

Parameters:

startDate - the new effective start date.

Throws:

RLException

getEffectiveEndDate

java.util.Calendar getEffectiveEndDate()
                                throws RLException

Returns the effective end date or null if a end date has not been specified for the rule.

Returns:

the effective end date.

Throws:

RLException

setEffectiveEndDate

void setEffectiveEndDate(java.util.Calendar endDate)
                  throws RLException

Sets the effective end date for the rule. A value of null unsets the effective end date.

Parameters:

endDate - the new effective end date.

Throws:

RLException

getEffectiveDateForm

int getEffectiveDateForm()
                  throws RLException

Returns the current form in use for the effective date properties.

Returns:

the effective date form.

Throws:

RLException

setEffectiveDateForm

void setEffectiveDateForm(int newForm)
                   throws RLException

Sets the form to use for handling the effective date properties. This must be set before either the effective start date or the effective end date are set. If they have been set previously, then setting them to null will allow the form to be set. If the form is set to EDFORM_DATE or EDFORM_TIME the date stored by setEffectiveStartDate and setEffectiveEndDate is made to conform to the selected form.

Parameters:

newForm - the effective date form.

Throws:

RLException