Rule Execution Server API

ilog.rules.factory
Class IlrModifyAction

java.lang.Object
  extended by ilog.rules.factory.IlrBaseStatement
      extended by ilog.rules.factory.IlrAction
          extended by ilog.rules.factory.IlrModifyAction
All Implemented Interfaces:
ilog.rules.factory.IlrSourceElement, IlrStatement, Serializable

public class IlrModifyAction
extends IlrAction

This class represents a modify action of the rule language.

Warning: Serialized objects of this class will not be compatible with future releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of IBM Decision Server.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class ilog.rules.factory.IlrAction
flag, statements, value
 
Constructor Summary
IlrModifyAction(IlrValue object)
          Constructs a modify action using an object.
IlrModifyAction(IlrValue object, IlrStatement[] statements)
          Constructs a modify action using an object and initializes the block using the passed statement block.
 
Method Summary
 void addStatement(IlrStatement statement)
          Adds a statement to this action.
 Enumeration enumerateStatements()
          Returns an enumeration to visit all the statements of this action.
 Object exploreStatement(IlrFactoryExplorer explorer)
          Explores this statement using a factory explorer.
 IlrValue getObject()
          Gets the object modified by this action.
 int getStatementCount()
          Gets the number of statements in this action.
 IlrStatement[] getStatements()
          Gets the statements in this action.
 boolean isFlushing()
          Checks the type of modification to the object.
 void removeStatement(IlrStatement statement)
          Removes a statement from the statement list of this action.
 void setFlushing(boolean flag)
          Changes the way the object is modified.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IlrModifyAction

public IlrModifyAction(IlrValue object)
Constructs a modify action using an object. Initially, there are no statements in this action.

Parameters:
object - The object to be modified.

IlrModifyAction

public IlrModifyAction(IlrValue object,
                       IlrStatement[] statements)
Constructs a modify action using an object and initializes the block using the passed statement block.

Parameters:
object - The object to be modified.
statements - The statement block.
Method Detail

getObject

public final IlrValue getObject()
Gets the object modified by this action.

Returns:
The object modified by this action.

setFlushing

public final void setFlushing(boolean flag)
Changes the way the object is modified. The passed parameter is true when a relational modification is requested.

Parameters:
flag - The flag which controls the type of modification.

isFlushing

public final boolean isFlushing()
Checks the type of modification to the object.

Returns:
true when the modification is relational, and false when the modification is the default one.

addStatement

public final void addStatement(IlrStatement statement)
Adds a statement to this action.

Parameters:
statement - The statement to be added.

removeStatement

public final void removeStatement(IlrStatement statement)
Removes a statement from the statement list of this action.

Parameters:
statement - The statement to be removed.

getStatementCount

public final int getStatementCount()
Gets the number of statements in this action.

Returns:
The number of statements in this action.

getStatements

public final IlrStatement[] getStatements()
Gets the statements in this action.

Returns:
An array of statements. The array can be of length 0.

enumerateStatements

public final Enumeration enumerateStatements()
Returns an enumeration to visit all the statements of this action.

Returns:
An enumeration of the statements.

exploreStatement

public Object exploreStatement(IlrFactoryExplorer explorer)
Explores this statement using a factory explorer.

Parameters:
explorer - The factory explorer.
Returns:
An object, the result of the exploration, or null if the method does not return a value.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013