com.progress.open4gl.javaproxy

Class OpenProcObject

java.lang.Object

com.progress.open4gl.javaproxy.OpenProcObject

public class OpenProcObject
extends java.lang.Object

For accessing an ABL persistent procedure using the OpenAPI.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.progress.open4gl.javaproxy.OpenProcObjectImpl	m_DynPOImpl

Constructor Summary

Constructors

Constructor and Description
OpenProcObject(ProObject appObj, java.lang.String procName, int statelessMode)
OpenProcObject(ProObject appObj, java.lang.String procName, ParamArray paramArray)

Method Summary

Modifier and Type	Method and Description
void	_cancelAllRequests() Stops or cancels any outstanding requests to the AppServer by this object or one that shares its connection.
java.lang.Object	_getConnectionId() Returns a string containing a unique identifier for this connection.
java.lang.Object	_getProcId() Provides the Remote Procedure Id.
java.lang.String	_getProcReturnString() Returns the current value of the AppServer RETURN-VALUE function.
java.lang.Object	_getRequestId() Returns a unique string identifying the request most recently run.
java.lang.Object	_getSSLSubjectName() Provides the SSL server's subject name that is obtained from its validated digital certificate.
boolean	_isStreaming() Returns true if currently streaming an output result set.
void	_release() Makes this object unavailable for further use.
ProcedureType	getProcedureType()
void	runProc(java.lang.String procName, ParamArray paramArray) Runs the internal procedure or user-defined function on the OpenProcObject.
void	setProcedureType(ProcedureType procType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_DynPOImpl

protected com.progress.open4gl.javaproxy.OpenProcObjectImpl m_DynPOImpl

Constructor Detail

OpenProcObject

public OpenProcObject(ProObject appObj,
                      java.lang.String procName,
                      ParamArray paramArray)
               throws Open4GLException,
                      RunTime4GLException,
                      SystemErrorException

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

OpenProcObject

public OpenProcObject(ProObject appObj,
                      java.lang.String procName,
                      int statelessMode)
               throws Open4GLException,
                      RunTime4GLException,
                      SystemErrorException

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

Method Detail

_release

public void _release()
              throws Open4GLException,
                     SystemErrorException

Makes this object unavailable for further use.

Throws:

Open4GLException

SystemErrorException

_getConnectionId

public java.lang.Object _getConnectionId()
                                  throws Open4GLException

Returns a string containing a unique identifier for this connection.

Throws:

Open4GLException

_getRequestId

public java.lang.Object _getRequestId()
                               throws Open4GLException

Returns a unique string identifying the request most recently run.

Throws:

Open4GLException

_getSSLSubjectName

public java.lang.Object _getSSLSubjectName()
                                    throws Open4GLException

Provides the SSL server's subject name that is obtained from its validated digital certificate.

Throws:

Open4GLException

_getProcId

public java.lang.Object _getProcId()
                            throws Open4GLException

Provides the Remote Procedure Id.

Throws:

Open4GLException

_isStreaming

public boolean _isStreaming()
                     throws Open4GLException

Returns true if currently streaming an output result set.

Throws:

Open4GLException

_cancelAllRequests

public void _cancelAllRequests()
                        throws Open4GLException

Stops or cancels any outstanding requests to the AppServer by this object or one that shares its connection.

Throws:

Open4GLException

_getProcReturnString

public java.lang.String _getProcReturnString()
                                      throws Open4GLException

Returns the current value of the AppServer RETURN-VALUE function.

Throws:

Open4GLException

runProc

public void runProc(java.lang.String procName,
                    ParamArray paramArray)
             throws Open4GLException,
                    RunTime4GLException,
                    SystemErrorException

Runs the internal procedure or user-defined function on the OpenProcObject.

Parameters:

procName - Name of internal procedure or user-defined function on the OpenProcObject.

paramArray - Holds the parameters for internal procedure or user-defined function

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

setProcedureType

public void setProcedureType(ProcedureType procType)

getProcedureType

public ProcedureType getProcedureType()