wt.fc.batch
Class AbstractBatchSpec

java.lang.Object
  extended by wt.fc.batch.AbstractBatchSpec
All Implemented Interfaces:
Externalizable, Serializable
Direct Known Subclasses:
DeleteBatchSpec, UpdateBatchSpec

public abstract class AbstractBatchSpec
extends Object
implements Externalizable

This class specifies the contract for processing multiple row update and delete operations.

Supported API: true

Extendable: false

See Also:
Serialized Form

Method Summary
 void appendWhere(WhereExpression a_where, LogicalOperator a_logicalOperator)
          Appends the WhereExpression to the WHERE clause.
 void appendWhere(WTCollection a_objects, boolean a_checkUpdateCount, LogicalOperator a_logicalOperator)
          This method appends a WhereEpression to include the specified objects by object ID.
 ClassTableExpression getTarget()
          Gets the value of the attribute: target; The target of the operation.
 WhereExpression getWhere()
          Gets the value of the attribute: where; Criteria to use for the operation.
 void setTarget(ClassTableExpression a_Target)
          Sets the value of the attribute: target; The target of the operation.
 void setWhere(WhereExpression a_Where)
          Sets the value of the attribute: where; Criteria to use for the operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getTarget

public ClassTableExpression getTarget()
Gets the value of the attribute: target; The target of the operation.

Supported API: true

Returns:
ClassTableExpression

setTarget

public void setTarget(ClassTableExpression a_Target)
               throws WTPropertyVetoException
Sets the value of the attribute: target; The target of the operation.

Supported API: true

Parameters:
a_Target -
Throws:
WTPropertyVetoException

getWhere

public WhereExpression getWhere()
Gets the value of the attribute: where; Criteria to use for the operation.

Supported API: true

Returns:
WhereExpression

setWhere

public void setWhere(WhereExpression a_Where)
              throws WTPropertyVetoException
Sets the value of the attribute: where; Criteria to use for the operation.

Supported API: true

Parameters:
a_Where -
Throws:
WTPropertyVetoException

appendWhere

public void appendWhere(WhereExpression a_where,
                        LogicalOperator a_logicalOperator)
                 throws WTPropertyVetoException
Appends the WhereExpression to the WHERE clause.

Supported API: true

Parameters:
a_where - The WhereExpression to append.
a_logicalOperator - The logical operator to use when appending, if there is an existing Where expression.
Throws:
WTPropertyVetoException

appendWhere

public void appendWhere(WTCollection a_objects,
                        boolean a_checkUpdateCount,
                        LogicalOperator a_logicalOperator)
                 throws WTException,
                        WTPropertyVetoException
This method appends a WhereEpression to include the specified objects by object ID.

Supported API: true

Parameters:
a_objects - Objects to build expression for
a_checkUpdateCount - If true, then the update counts of the objects are included in the criteria.
a_logicalOperator - The logical operator to use when appending, if there is an existing Where expression.
Throws:
WTException
WTPropertyVetoException