oracle.mail.sdk.rule
Class ConditionType

java.lang.Object
  |
  +--oracle.xml.classgen.CGXSDElement
        |
        +--oracle.mail.sdk.rule.RuleElement
              |
              +--oracle.mail.sdk.rule.ConditionType

public class ConditionType

extends RuleElement

This class represents a condition object. There are 4 types of conditions:

• Simple: a simple condition consists of a message attribute, an operator and optionally some operands to compare with.
• Compound: a compound condition consists of one or more sub conditions of class ConditionType. The sub conditions are evaluated together using logical operations such as AND or OR.
• External: an external condition is a user-defined PL/SQL function call.
• Sectional: this is a special kind of condition that searches for patterns in a section of a message. Sectional searches can be used to search within the message body or search in a particular message header.

A condition object has two attributes:

• Junction: how are sub conditions connected together. The values are "AND" or "OR".
• Negation: whether to apply a NOT in front of the whole condition to negate its value. The values choices are "yes" and "no".

Since:

9.0

Version:

$Header: ConditionType.java 30-jun-2002.13:52:46 haye Exp $

See Also:

AttributeType, OperatorType, InSectionType

Constructor Summary

ConditionType()

Method Summary

void	addAttribute(AttributeType theattribute) Adds an attribute object.
void	addAttribute(java.lang.String theattribute) Adds the attribute string if the attribute does not require any parameters.
void	addCondition(ConditionType thecondition) Adds a subcondition if this is a compound condition.
void	addInSection(InSectionType theinSection) Adds the insection type condition object if this is a sectional search condition.
void	addOperand(java.lang.String theoperand) Adds an operand.
void	addOperator(OperatorType theoperator) Adds the operator object.
void	addOperator(java.lang.String theoperator) Adds the operator string if it is a simple operation.
void	addProcCall(java.lang.String theprocCall) Adds an external condition if this is an user-defined PL/SQL function call.
AttributeType	getAttribute() Gets the message attribute if it is a simple condition
java.lang.String	getConditionType() Gets the type of the condition.
InSectionType	getInSection() Gets the InSectionType object that contains sectional search condition information.
java.lang.String	getJunction() Gets the value of the Junction attribute
java.lang.String	getNegation() Gets the value of the Negation attribute
java.lang.String	getOperand() Gets the first operand string
java.util.Vector	getOperands() Gets all operands in a vector
OperatorType	getOperator() Gets tje operator object if it is a simple condition
java.lang.String	getProcCall() Gets the external condition PL/SQL function name
java.util.Vector	getSubConditions() Gets all sub conditions in a vector if this is a compound condition
void	print(oracle.xml.parser.v2.XMLOutputStream out) Prints in XML format of this object.
void	setConditions(java.util.Vector conditions) Sets the sub-conditions for this parent condition.
void	setJunction(java.lang.String thejunction) Sets the value of Junction attribute
void	setNegation(java.lang.String thenegation) Sets the value of Negation attribute
void	setOperands(java.util.Vector operands) Sets operands to the condition.

Methods inherited from class oracle.mail.sdk.rule.RuleElement

getParent, getType, printAttributes, removeAll, removeAt

Methods inherited from class oracle.xml.classgen.CGXSDElement

getAttributes, getChildElements, getNodeValue, printAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionType

public ConditionType()

Method Detail

setJunction

public void setJunction(java.lang.String thejunction)
                 throws java.lang.IllegalArgumentException,
                        oracle.xml.classgen.InvalidContentException

Sets the value of Junction attribute

Parameters:

thejunction - the value to which the attribute is set

Throws:

java.lang.IllegalArgumentException - if the attribute is not valid.

getJunction

public java.lang.String getJunction()

Gets the value of the Junction attribute

Returns:

the value of the Junction attribute

setNegation

public void setNegation(java.lang.String thenegation)
                 throws java.lang.IllegalArgumentException,
                        oracle.xml.classgen.InvalidContentException

Sets the value of Negation attribute

Parameters:

thenegation - the value to which the attribute is set

Throws:

java.lang.IllegalArgumentException - if the attribute is not valid.

getNegation

public java.lang.String getNegation()

Gets the value of the Negation attribute

Returns:

the value of the Negation attribute

getConditionType

public java.lang.String getConditionType()

Gets the type of the condition. The 4 possible return values are "Simple", "Compound", "Sectional" and "External".

Returns:

a string describing the condition type

getAttribute

public AttributeType getAttribute()

Gets the message attribute if it is a simple condition

Returns:

an AttributeType object if the condition is simple

getOperator

public OperatorType getOperator()

Gets tje operator object if it is a simple condition

Returns:

an OperatorType object is the condition is simple

getOperand

public java.lang.String getOperand()

Gets the first operand string

Returns:

the first operandan AttributeType object

getOperands

public java.util.Vector getOperands()

Gets all operands in a vector

Returns:

an vector of operand strings

setOperands

public void setOperands(java.util.Vector operands)
                 throws oracle.xml.classgen.InvalidContentException

Sets operands to the condition.

Parameters:

operands - the vector of operands

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

getProcCall

public java.lang.String getProcCall()

Gets the external condition PL/SQL function name

Returns:

the external condition PL/SQL function string

getInSection

public InSectionType getInSection()

Gets the InSectionType object that contains sectional search condition information.

Returns:

an InSectionType object

See Also:

InSectionType

getSubConditions

public java.util.Vector getSubConditions()

Gets all sub conditions in a vector if this is a compound condition

Returns:

a vector of subconditions

setConditions

public void setConditions(java.util.Vector conditions)
                   throws oracle.xml.classgen.InvalidContentException

Sets the sub-conditions for this parent condition.

Parameters:

conditions - the vector of conditions

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

addAttribute

public void addAttribute(AttributeType theattribute)
                  throws oracle.xml.classgen.InvalidContentException

Adds an attribute object. An Attribute object may contain attribute parameters. A simple condition can contain only one attribute object. Subsequent calls to this method overrides the previous attribute.

Parameters:

theattribute - the attribute object

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

See Also:

AttributeType

addAttribute

public void addAttribute(java.lang.String theattribute)
                  throws oracle.xml.classgen.InvalidContentException

Adds the attribute string if the attribute does not require any parameters.

Parameters:

theattribute - the attribute string

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

addOperator

public void addOperator(OperatorType theoperator)
                 throws oracle.xml.classgen.InvalidContentException

Adds the operator object. There can be only one operator object, subsequent calls to this method overrides the previous operator.

Parameters:

theoperator - the operator object

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

See Also:

OperatorType

addOperator

public void addOperator(java.lang.String theoperator)
                 throws oracle.xml.classgen.InvalidContentException

Adds the operator string if it is a simple operation.

Parameters:

theoperator - the operator string

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

addOperand

public void addOperand(java.lang.String theoperand)
                throws oracle.xml.classgen.InvalidContentException

Adds an operand.

Parameters:

theoperand - the operand string

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

addCondition

public void addCondition(ConditionType thecondition)
                  throws oracle.xml.classgen.InvalidContentException

Adds a subcondition if this is a compound condition.

Parameters:

thecondition - the condition object

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

addProcCall

public void addProcCall(java.lang.String theprocCall)
                 throws oracle.xml.classgen.InvalidContentException

Adds an external condition if this is an user-defined PL/SQL function call.

Parameters:

theprocCall - the external condition PL/SQL function string

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

addInSection

public void addInSection(InSectionType theinSection)
                  throws oracle.xml.classgen.InvalidContentException

Adds the insection type condition object if this is a sectional search condition.

Parameters:

theinSection - the InSectionType object

Throws:

oracle.xml.classgen.InvalidContentException - if the element is not valid.

See Also:

InSectionType

print

public void print(oracle.xml.parser.v2.XMLOutputStream out)
           throws java.io.IOException

Prints in XML format of this object. The output is a fragment of an XML document.

Overrides:

print in class oracle.xml.classgen.CGXSDElement

Parameters:

out - the Output Stream

Throws:

java.io.IOException - if there is an error in writing the output

See Also:

XMLOutputStream