javax.slee

Interface SbbLocalObject

public interface SbbLocalObject

The SbbLocalObject interface must be extended by all SBB local interfaces used for synchronous SBB invocations.

Method Summary

Methods

Modifier and Type	Method and Description
byte	getSbbPriority() Get the invocation priority for the SBB entity referenced by this SbbLocalObject.
boolean	isIdentical(SbbLocalObject obj) Compare this SbbLocalObject for identity equality with another.
void	remove() Remove the SBB entity referenced by this SbbLocalObject.
void	setSbbPriority(byte priority) Set the invocation priority for the SBB entity referenced by this SbbLocalObject.

Method Detail

isIdentical

boolean isIdentical(SbbLocalObject obj)
                    throws TransactionRequiredLocalException,
                           SLEEException

Compare this SbbLocalObject for identity equality with another.

This method is a mandatory transactional method.

Parameters:

obj - the object to compare this with.

Returns:

true if obj is a reference to an SBB entity with the same identity as the SBB entity referenced by this SbbLocalObject object, false otherwise.

Throws:

TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

SLEEException - if the equality test could not be completed due to a system-level failure.

setSbbPriority

void setSbbPriority(byte priority)
                    throws TransactionRequiredLocalException,
                           NoSuchObjectLocalException,
                           SLEEException

Set the invocation priority for the SBB entity referenced by this SbbLocalObject.

This method is a mandatory transactional method.

Parameters:

priority - the new priority. The valid range for priorities is -128 to 127.

Throws:

TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

NoSuchObjectLocalException - if the SBB entity referenced by this SbbLocalObject is no longer valid.

SLEEException - if the priority could not be set due to a system-level failure.

getSbbPriority

byte getSbbPriority()
                    throws TransactionRequiredLocalException,
                           NoSuchObjectLocalException,
                           SLEEException

Get the invocation priority for the SBB entity referenced by this SbbLocalObject.

This method is a mandatory transactional method.

Returns:

the priority of the SBB entity.

Throws:

TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

NoSuchObjectLocalException - if the SBB entity referenced by this SbbLocalObject is no longer valid.

SLEEException - if the SBB's priority could not be obtained due to a system-level failure.

remove

void remove()
            throws TransactionRequiredLocalException,
                   TransactionRolledbackLocalException,
                   SLEEException

Remove the SBB entity referenced by this SbbLocalObject. Any children of the removed SBB entity also also removed. If the removed SBB entity is not a root SBB entity of a Service, then the SBB entity is also removed from the relevant child relation of its parent SBB entity.

An SBB entity that is removed, either directly or indirectly (via a cascade removal), is automatically detached from any Activity Contexts it is attached to.

This method is a mandatory transactional method.

Throws:

TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

TransactionRolledbackLocalException - if the SLEE catches a runtime exception during the remove that causes the transaction to be marked for rollback. The TransactionRolledbackLocalException's getCause() method returns the exception that caused the transaction to be marked for rollback. This could be, for example:

• a NoSuchObjectLocalException, if the SBB entity referenced by this SbbLocalObject didn't exist; or
• a runtime exception that propagated out of the Sbb.sbbRemove() method

SLEEException - if the SBB entity could not be removed due to a system-level failure.