javax.slee.profile
Interface ProfileLocalObject

All Known Subinterfaces:

AddressProfileLocal

public interface ProfileLocalObject

The ProfileLocalObject interface must be extended by all Profile Local Interfaces used by SLEE components to interact with profiles.

Since:

SLEE 1.1

Method Summary

java.lang.String	getProfileName() Get the name of the profile referenced by this ProfileLocalObject.
ProfileTable	getProfileTable() Get an object that implements the Profile Table Interface of the profile table in which the profile that this ProfileLocalObject references exists.
java.lang.String	getProfileTableName() Get the name of the profile table in which the profile referenced by this ProfileLocalObject exists.
boolean	isIdentical(ProfileLocalObject obj) Compare this ProfileLocalObject for identity equality with another.
void	remove() Remove the profile referenced by this ProfileLocalObject.

Method Detail

isIdentical

boolean isIdentical(ProfileLocalObject obj)
                    throws SLEEException

Compare this ProfileLocalObject for identity equality with another.

This method is a non-transactional method.

Parameters:

obj - the object to compare this with.

Returns:

true if obj is a reference to a profile with the same identity (profile table name and profile name) as the profile referenced by this ProfileLocalObject object, false otherwise.

Throws:

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

getProfileTableName

java.lang.String getProfileTableName()
                                     throws SLEEException

Get the name of the profile table in which the profile referenced by this ProfileLocalObject exists.

This method is a non-transactional method.

Returns:

the profile table name.

Throws:

SLEEException - if the profile table name could not be obtained due to a system-level failure.

getProfileName

java.lang.String getProfileName()
                                throws SLEEException

Get the name of the profile referenced by this ProfileLocalObject.

This method is a non-transactional method.

Returns:

the profile name, or null if the Profile object is associated with the profile table's default profile.

Throws:

SLEEException - if the profile name could not be obtained due to a system-level failure.

getProfileTable

ProfileTable getProfileTable()
                             throws SLEEException

Get an object that implements the Profile Table Interface of the profile table in which the profile that this ProfileLocalObject references exists. If the profile specification of the profile table has defined a Profile Table Interface that extends ProfileTable then the object returned from this method may be safely typecast to the subinterface declared in the Profile Specification.

This method is a non-transactional method.

Returns:

a Profile Table Interface object.

Throws:

SLEEException - if the Profile Table Interface object could not be obtained due to a system-level failure.

remove

void remove()
            throws TransactionRequiredLocalException,
                   TransactionRolledbackLocalException,
                   SLEEException

Remove the profile referenced by this ProfileLocalObject.

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 profile referenced by this ProfileLocalObject didn't exist;
• a ReadOnlyProfileException, if the profile table's profile specification has enforced a read-only SLEE component view of profiles; or
• a runtime exception that propagated out of the Profile.profileRemove() method

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