TableConstraint Class Reference

Abstract class representing a constraint on a table. More...

Inherited by PrimaryKeyConstraint, and UniqueConstraint.

List of all members.

Public Member Functions

virtual TableConstraintClone () const =0
 Retrieve a clone of this constraint.
virtual const
PrimaryKeyConstraint
GetAsPrimaryKeyConstraint () const
 Return this constraint as a PrimaryKeyConstraint object.
virtual const UniqueConstraintGetAsUniqueConstraint () const
 Return this constraint as a UniqueConstraint object.
ConstraintType GetConstraintType () const
 Get the type of this constraint.
virtual ~TableConstraint ()
 Destructor.

Protected Member Functions

 TableConstraint (ConstraintType in_constraintType)
 Constructor.

Detailed Description

Abstract class representing a constraint on a table.

Constraints are used during table creation. The engine does not perform any validation on constraints, it just passes them directly to the DSII via a TableSpecification to the CreateTable() method on the DSIExtSqlDataEngine.


Constructor & Destructor Documentation

virtual ~TableConstraint (  )  [virtual]

Destructor.

TableConstraint ( ConstraintType  in_constraintType  )  [explicit, protected]

Constructor.

Parameters:
in_constraintType The type of constraint.

Member Function Documentation

virtual TableConstraint* Clone (  )  const [pure virtual]

Retrieve a clone of this constraint.

Returns:
A clone of the constraint. (OWN)

Implemented in PrimaryKeyConstraint, and UniqueConstraint.

virtual const PrimaryKeyConstraint* GetAsPrimaryKeyConstraint (  )  const [virtual]

Return this constraint as a PrimaryKeyConstraint object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this is not an PrimaryKeyConstraint object.
Returns:
This constraint as a PrimaryKeyConstraint. (NOT OWN)

Reimplemented in PrimaryKeyConstraint.

virtual const UniqueConstraint* GetAsUniqueConstraint (  )  const [virtual]

Return this constraint as a UniqueConstraint object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this is not an UniqueConstraint object.
Returns:
This constraint as a UniqueConstraint. (NOT OWN)

Reimplemented in UniqueConstraint.

ConstraintType GetConstraintType (  )  const

Get the type of this constraint.

Returns:
The type of constraint.

The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba