Session Methods
| Method | Description |
|---|---|
| getBWSession | Returns a session ID generated by the system.
The user is validated before generating the session ID. This call also notifies the server that any call that returns an array of data should not return a null record as the last record of the array. |
| getSession | Returns a session ID generated by the system.
The user is validated before generating the session ID. |
| closeSession | Removes a session ID from the database. |
| deleteExpiredSessionIds | Removes a session ID that has expired.
A session is considered expired if the last activity time is longer than the timeout parameter set in the web.xml file. The user calling this method must have UpdateSessionRight or AdministratorRight without being assigned to a department. |
| deleteSessionId | Removes the specified session ID from the database.
The user calling this method must have UpdateSessionRight or AdministratorRight without being assigned to a department. |
| getExpiredSessionIds | Returns all expired sessions as any array of session objects.
The last element of the array is null. If no sessions expire, a single element is returned with a value of null. A session is considered expired if the last activity time is longer than the timeout parameter set in the web.xml file. The user calling this method must have ViewSessionRight, UpdateSessionRight, or AdministratorRight. |
| listActiveSessionIds | Returns all sessions not expired as any array of session objects.
The last element of the array is null. If no sessions are active, a single element is returned with a value of null. A session is considered expired if the last activity time is longer than the timeout parameter set in the web.xml file. The user calling this method must have ViewSessionRight, UpdateSessionRight, or AdministratorRight. |
| validateSession | Checks to see whether the session exists in the database and does not expire.
A session is considered expired if the last activity time is longer than the timeout parameter set in the web.xml file. |