NzaeBase Interface reference

The base interface for data connection APIs.

Public member functions

void close()
Closes the AE and releases its resources.
int getApiType()
Returns the API Constant for this interface.
NzaeEnvironment getEnvironment()
Gets the environment information for the AE.
NzaeLibrary getLibrary()
Gets the library information for the AE.
ArrayList<String> getParameters()
Gets the SQL parameters used to invoke this AE.
NzaeRuntime getRuntime()
Gets runtime information for the AE, including information about the Netezza system.
void log(int logLevel, String message)
Logs the specified message at the specified log level.
void userError(String message)
Indicates this AE has encountered an error condition.

Public member function documentation

void close()
Closes the AE and releases its resources.
int getApiType()
Returns the API Constant for this interface.
Returns

The values defined in NzaeApi.

NzaeEnvironment getEnvironment()
Gets the environment information for the AE.
Returns

NzaeEnvironment

The instance of NzaeEnvironment.

NzaeLibrary getLibrary()
Gets the library information for the AE.
Returns

NzaeLibrary

The instance of NzaeLibrary.

ArrayList<String> getParameters()
Gets the SQL parameters used to invoke this AE.

@ list of parameter strings.

NzaeRuntime getRuntime()
Gets runtime information for the AE, including information about the Netezza system.
Returns

NzaeRuntime

The instance of NzaeRuntime.

void log(int logLevel, String message)
Logs the specified message at the specified log level.
Parameters
  • logLevel

    The log level constant.

  • message

    The message to log.

void userError(String message)
Indicates this AE has encountered an error condition.
Parameters
  • message

    The message to send back to the Netezza system.

    Implies NzaeDone.