com.aquafold.openapi.rdbms

Interface AQServerObject

All Known Subinterfaces:

AQArrayType, AQAssembly, AQAsymmetricKey, AQCertificate, AQCluster, AQConstraint, AQConstraintColumn, AQDatabase, AQDatabaseLink, AQDataType, AQDefault, AQDimension, AQEvent, AQFileFormat, AQForeignKeyRefColumn, AQFunction, AQIndex, AQIndexColumn, AQJavaResource, AQJavaSource, AQLanguage, AQMatView, AQMatViewLog, AQNickname, AQObjectPermission, AQObjectType, AQPackage, AQPackageBody, AQPartition, AQPipe, AQProcedure, AQProjection, AQQueue, AQRefreshGroup, AQRole, AQRule, AQSchema, AQSchemaObject, AQSegment, AQSequence, AQStage, AQSubscription, AQSymmetricKey, AQSynonym, AQTable, AQTableColumn, AQTableType, AQTrigger, AQUser, AQView, AQXmlSchemaCollection

public interface AQServerObject

Base interface for a server object which can be scripted.

Method Summary

Modifier and Type	Method and Description
javax.swing.ImageIcon	getIcon() Returns the icon corresponding to the object type.
java.lang.String	getName() To get a human-readable database object name.
AQServerConnection	getServerConnection() To get information on the server connection.
java.lang.String	getTypeName() To get the database object's type name.
java.lang.String	scriptCREATE() Generates a CREATE script for the server object.
java.lang.String	scriptCREATE(AQScriptOptions options) Generates a CREATE script for the server object.
java.lang.String	scriptDROP() Generates a DROP script for the server object.

Method Detail

getName

java.lang.String getName()

To get a human-readable database object name.

Returns:

The name of the database object.

getTypeName

java.lang.String getTypeName()

To get the database object's type name.

Returns:

The name of the object type.

getIcon

javax.swing.ImageIcon getIcon()

Returns the icon corresponding to the object type.

Returns:

the icon

getServerConnection

AQServerConnection getServerConnection()

To get information on the server connection. This information is represented by an AQServerConnection object.

Returns:

An AQServerConnection object.

scriptCREATE

java.lang.String scriptCREATE()
                       throws AQException

Generates a CREATE script for the server object.

Returns:

The CREATE script of the server object.

Throws:

AQException - Throws an AQException if the server object does not support a CREATE script operation.

scriptCREATE

java.lang.String scriptCREATE(AQScriptOptions options)
                       throws AQException

Generates a CREATE script for the server object.

Parameters:

options - the script options

Returns:

The CREATE script of the server object.

Throws:

AQException - Throws an AQException if the server object does not support a CREATE script operation.

scriptDROP

java.lang.String scriptDROP()
                     throws AQException

Generates a DROP script for the server object.

Returns:

The DROP script for the server object.

Throws:

AQException - Throws an AQException if the server object does not support a DROP script operation.