| Methods Summary |
|---|
| public void | addDescriptor(oracle.toplink.essentials.descriptors.ClassDescriptor descriptor)PUBLIC:
Add the descriptor to the session.
All persistent classes must have a descriptor registered for them with the session.
It is best to add the descriptors before login, if added after login the order in which
descriptors are added is dependant on inheritice and references unless the addDescriptors
method is used.
|
| public void | addDescriptors(java.util.Vector descriptors)PUBLIC:
Add the descriptors to the session.
All persistent classes must have a descriptor registered for them with the session.
This method allows for a batch of descriptors to be added at once so that TopLink
can resolve the dependancies between the descriptors and perform initialization optimially.
|
| public void | addDescriptors(oracle.toplink.essentials.sessions.Project project)PUBLIC:
Add the descriptors to the session from the Project.
This can be used to combine the descriptors from multiple projects into a single session.
This can be called after the session has been connected as long as there are no external dependencies.
|
| public void | beginTransaction()PUBLIC:
Begin a transaction on the database.
This allows a group of database modification to be commited or rolledback as a unit.
All writes/deletes will be sent to the database be will not be visible to other users until commit.
Although databases do not allow nested transaction,
TopLink supports nesting through only committing to the database on the outer commit.
|
| public void | commitTransaction()PUBLIC:
Commit the active database transaction.
This allows a group of database modification to be commited or rolledback as a unit.
All writes/deletes will be sent to the database be will not be visible to other users until commit.
Although databases do not allow nested transaction,
TopLink supports nesting through only committing to the database on the outer commit.
|
| public void | deleteAllObjects(java.util.Collection domainObjects)PUBLIC:
delete all of the objects and all of their privately owned parts in the database.
The allows for a group of objects to be deleted as a unit.
The objects will be deleted through a single transactions.
|
| public void | deleteAllObjects(java.util.Vector domainObjects)PUBLIC:
delete all of the objects and all of their privately owned parts in the database.
The allows for a group of objects to be deleted as a unit.
The objects will be deleted through a single transactions.
|
| public java.lang.Object | deleteObject(java.lang.Object domainObject)PUBLIC:
Delete the object and all of its privately owned parts from the database.
The delete operation can be customized through using a delete query.
|
| public oracle.toplink.essentials.sequencing.SequencingControl | getSequencingControl()PUBLIC:
Return SequencingControl which used for sequencing setup and
customization including management of sequencing preallocation.
|
| public oracle.toplink.essentials.platform.server.ServerPlatform | getServerPlatform()PUBLIC:
Answer the server platform defining server-specific behaviour for the receiver (Oc4j, WLS, ...).
If the user wants a different external transaction controller class or
to provide some different behaviour than the provided ServerPlatform(s), we recommend
subclassing oracle.toplink.essentials.platform.server.ServerPlatformBase (or a subclass),
and overriding:
ServerPlatformBase.getExternalTransactionControllerClass()
ServerPlatformBase.registerMBean()
ServerPlatformBase.unregisterMBean()
for the desired behaviour.
|
| public java.lang.Object | insertObject(java.lang.Object domainObject)PUBLIC:
Insert the object and all of its privately owned parts into the database.
Insert should only be used if the application knows that the object is new,
otherwise writeObject should be used.
The insert operation can be customized through using an insert query.
|
| public boolean | isInTransaction()PUBLIC:
Return if the session is currently in the progress of a database transaction.
Because nested transactions are allowed check if the transaction mutex has been aquired.
|
| public void | login()PUBLIC:
Connect to the database using the predefined login.
The login must have been assign when or after creating the session.
|
| public void | login(java.lang.String userName, java.lang.String password)PUBLIC:
Connect to the database using the given user name and password.
The additional login information must have been preset in the session's login attribute.
This is the login that should be used if each user has their own id,
but all users share the same database configuration.
Under this login mode the password should not stay withint the login definition after login.
|
| public void | login(oracle.toplink.essentials.sessions.Login login)PUBLIC:
Connect to the database using the given login.
The login may also the preset and the login() protocol called.
This is the login should only be used if each user has their own database configuration.
Under this login mode the password should not stay withint the login definition after login.
|
| public void | logout()PUBLIC:
Disconnect from the database.
|
| public java.lang.Object | refreshAndLockObject(java.lang.Object object)PUBLIC:
Refresh the attributes of the object and of all of its private parts from the database.
The object will be pessimisticly locked on the database for the duration of the transaction.
If the object is already locked this method will wait until the lock is released.
A no wait option is available through setting the lock mode.
|
| public java.lang.Object | refreshAndLockObject(java.lang.Object object, short lockMode)PUBLIC:
Refresh the attributes of the object and of all of its private parts from the database.
The object will be pessimisticly locked on the database for the duration of the transaction.
Lock Modes: ObjectBuildingQuery.NO_LOCK, LOCK, LOCK_NOWAIT
|
| public void | rollbackTransaction()PUBLIC:
Rollback the active database transaction.
This allows a group of database modification to be commited or rolledback as a unit.
All writes/deletes will be sent to the database be will not be visible to other users until commit.
Although databases do not allow nested transaction,
TopLink supports nesting through only committing to the database on the outer commit.
|
| public void | setDatasourceLogin(oracle.toplink.essentials.sessions.Login login)PUBLIC:
Set the login.
|
| public void | setExternalTransactionController(oracle.toplink.essentials.sessions.ExternalTransactionController etc)PUBLIC:
Used for JTS integration. If your application requires to have JTS control transactions instead of TopLink an
external transaction controler must be specified. TopLink provides JTS controlers for JTS 1.0 and Weblogic's JTS.
|
| public void | setLogin(oracle.toplink.essentials.sessions.Login login)PUBLIC:
Set the login.
|
| public void | setServerPlatform(oracle.toplink.essentials.platform.server.ServerPlatform newServerPlatform)PUBLIC:
Set the server platform defining server-specific behaviour for the receiver (Oc4j, WLS, ... ).
This is not permitted after the session is logged in.
If the user wants a different external transaction controller class or
to provide some different behaviour than the provided ServerPlatform(s), we recommend
subclassing oracle.toplink.essentials.platform.server.ServerPlatformBase (or a subclass),
and overriding:
ServerPlatformBase.getExternalTransactionControllerClass()
ServerPlatformBase.registerMBean()
ServerPlatformBase.unregisterMBean()
for the desired behaviour.
|
| public java.lang.Object | updateObject(java.lang.Object domainObject)PUBLIC:
Update the object and all of its privately owned parts in the database.
Update should only be used if the application knows that the object is new,
otherwise writeObject should be used.
The update operation can be customized through using an update query.
|
| public void | writeAllObjects(java.util.Collection domainObjects)PUBLIC:
Write all of the objects and all of their privately owned parts in the database.
The allows for a group of objects to be commited as a unit.
The objects will be commited through a single transactions.
|
| public void | writeAllObjects(java.util.Vector domainObjects)PUBLIC:
Write all of the objects and all of their privately owned parts in the database.
The allows for a group of objects to be commited as a unit.
The objects will be commited through a single transactions.
|
| public java.lang.Object | writeObject(java.lang.Object domainObject)PUBLIC:
Write the object and all of its privately owned parts in the database.
Write will determine if an insert or an update should be done,
it may go to the database to determine this (by default will check the identity map).
The write operation can be customized through using an write query.
|
