Kbase 18178: Apptivity - Updated doc for abServerRequest member of abEnv
| Autor |
Progress Software Corporation - Progress |
| Acesso |
Público |
| Publicação |
8/12/1998 |
|
Apptivity - Updated doc for abServerRequest member of abEnv
(This updated documentation will be included in the next release of
Apptivity after version 2.1. This information applies to version
2.1 of Apptivity.)
serverRequest member of abEnv
Communicates with the application's abServerEvents.serverRequest
event handler method. For more information, see "Customizing the
Apptivity Server" and abServerEvents.serverRequest.
public
abVector serverRequest(int reqType, String id, abVector arg)
public
abVector serverRequest(int reqType, String id, abVector arg,
boolean force)
Return Value
Returns a list of objects that the abServerEvents.serverRequest
event handler method provides as a return value. If there is no
abServerEvents class defined for the application, a null is
provided. However, if a class has been provided, but no
override of the abServerEvents.serverRequest method has
been provided, a null value is also returned.
Parameters
reqType
A user-defined value to define the request type.
NOTE: Use only positive values for the reqType, negative values are
reserved for internal requests.
id
A user-defined string value, or the ID of a related abDataSource. If
the ID is of a data source, then the abServerEvents.serverRequest
event on the server side will receive a corresponding abQuery object
as one of the event parameters.
arg
A list of objects to send along with the server request. This object,
and any contained objects, must implement the abStreamable
interface. If its interface is not implemented, an exception is
thrown.
force
Force the request through to the server even if the initialization
phase may not be complete. false If server initialization is not
complete, the current thread is put into a sleep/wait loop which
periodically checks for initialzation complete. If the initialzation
is not complete within 15 seconds, a abException with an error
code of abConst.SERVER_LINK_NOTREADY is thrown.
true
No initialization check is performed, the request is routed
immediately to the server. The request handler at the server
must be able to respond to the request even if the initialization
phase is not complete.
Exceptions
abException
Generated when there is no link to the server. The client might
not have been able to connect to the server or the connection
initialization might not be complete. The exception can also be
thrown from the abServerEvents.serverRequest event handler
method. An exception can also be thrown if any of the objects
in the arg parameter do not implement the abStreamable
interface.
UTF 8/12/98 Apptivity 2.1