com.aquafold.openapi.rdbms
Interface AQServerObject

All Known Subinterfaces:

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

public interface AQServerObject

Base interface for a server object which can be scripted.

Method Summary

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

Method Detail

getName

String getName()

To get a human-readable database object name.

Returns:

The name of the database object.

getTypeName

String getTypeName()

To get the database object's type name.

Returns:

The name of the object type.

getIcon

ImageIcon getIcon()

Returns the icon corresponding to the object type.

getServerConnection

AQServerConnection getServerConnection()

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

Returns:

An AQServerConnection object.

scriptCREATE

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

String scriptCREATE(AQScriptOptions options)
                    throws AQException

Generates a CREATE script for the server object.

Parameters:

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

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.