com.ibm.etools.iseries.edit.sql
Interface ISQLSignature

All Known Implementing Classes:

SQLRPGLESignature

public interface ISQLSignature

This interface is used to implement signatures for SQL Statements

Since:

7.0

Method Summary

String	addSignature(String statementText) Called by the SQL formatter to add the signature to the formatted SQL statement
boolean	isSignatureOnAllLines() Indicates whether or not the signature should be applied to every line of the SQL statement
boolean	isSignatureOnFirstLineOnly() Indicates whether the signature should be applied to only the first line of the SQL statement
boolean	isSignatureOnLastLineOnly() Indicates whether or not the signature should be applied to the last line of the SQL Statement
boolean	isSignatureOnlyOnExecSQL() Indicates whether or not the signature is only allowed on the EXEC SQL line
boolean	needsSignature() Indicates whether or not a signature is needed

Method Detail

addSignature

String addSignature(String statementText)

Called by the SQL formatter to add the signature to the formatted SQL statement

Parameters:

statementText - a line in the formatted SQL statement

Returns:

the SQL line with the signature added

isSignatureOnAllLines

boolean isSignatureOnAllLines()

Indicates whether or not the signature should be applied to every line of the SQL statement

Returns:

true if the signature should be added to each line of the SQL statement

isSignatureOnFirstLineOnly

boolean isSignatureOnFirstLineOnly()

Indicates whether the signature should be applied to only the first line of the SQL statement

Returns:

true if the signature should be added only to the first line, false otherwise

isSignatureOnLastLineOnly

boolean isSignatureOnLastLineOnly()

Indicates whether or not the signature should be applied to the last line of the SQL Statement

Returns:

true if the signature should be added only to the last line, false otherwise

isSignatureOnlyOnExecSQL

boolean isSignatureOnlyOnExecSQL()

Indicates whether or not the signature is only allowed on the EXEC SQL line

Returns:

true if the signature is only allowed on the EXEC SQL line, false otherwise

needsSignature

boolean needsSignature()

Indicates whether or not a signature is needed

Returns:

true if a signature is needed, false otherwise