OpenAPI 1.0

com.aquafold.openapi.rdbms.schema
Interface AQConstraint

All Superinterfaces:
AQSchemaObject, AQServerObject

public interface AQConstraint
extends AQSchemaObject

This interface represents a database constraint.


Method Summary
 String extractCheckCondition()
          To get the check condition for a check constraint.
 AQConstraintColumn[] extractColumns()
          To get a list of columns associated with the constraint.
 AQForeignKeyRefColumn[] extractForeignKeyRefColumns()
          To get the referenced column(s) for a foreign key constraint.
 boolean isCheckConstraint()
          To check if this is a check constraint.
 boolean isForeignKeyConstraint()
          To check if this is a foreign key constraint.
 boolean isPrimaryKeyConstraint()
          To check if this is a primary key constraint.
 boolean isUniqueConstraint()
          To check if this is a unique constraint.
 
Methods inherited from interface com.aquafold.openapi.rdbms.AQSchemaObject
getDatabaseName, getSchemaName
 
Methods inherited from interface com.aquafold.openapi.rdbms.AQServerObject
getIcon, getName, getServerConnection, getTypeName, scriptCREATE, scriptCREATE, scriptDROP
 

Method Detail

extractColumns

AQConstraintColumn[] extractColumns()
To get a list of columns associated with the constraint.

Returns:
An array of AQConstraintColumn objects; empty array if no columns exist.

isPrimaryKeyConstraint

boolean isPrimaryKeyConstraint()
To check if this is a primary key constraint.

Returns:
true if this is a primary key constraint; false otherwise.

isForeignKeyConstraint

boolean isForeignKeyConstraint()
To check if this is a foreign key constraint.

Returns:
true if this is a foreign key constraint; false otherwise.

isCheckConstraint

boolean isCheckConstraint()
To check if this is a check constraint.

Returns:
true if this is a check constraint; false otherwise.

isUniqueConstraint

boolean isUniqueConstraint()
To check if this is a unique constraint.

Returns:
true if this is a unique constraint; false otherwise.

extractForeignKeyRefColumns

AQForeignKeyRefColumn[] extractForeignKeyRefColumns()
To get the referenced column(s) for a foreign key constraint.

Returns:
An array of AQForeignKeyRefColumn objects if this is a foreign key constraint; empty array otherwise.

extractCheckCondition

String extractCheckCondition()
To get the check condition for a check constraint.

Returns:
The check condition if this is a check constraint; null otherwise.

OpenAPI 1.0


Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.