com.sssw.fw.usermgr.api
Interface EbiUserMetaDelegate

All Superinterfaces:

EbiDelegate

public interface EbiUserMetaDelegate

extends EbiDelegate

User Meta Delegate that is Provided as a facade to access user meta related information either from the local user manager or through EJB api provided by the user service.

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

boolean	addUserMeta(EbiContext context, EbiUserMeta userMeta) Adds the user metadata object.
EbiUserMeta	createUserMeta() Gets a new EbiUserMeta info object for use in UserMeta creation.
EbiUserMeta	getClonedUserMeta(EbiContext context) Gets an EbiUserMeta object for modification.
EbiUserMeta	getUserMeta() Gets an EbiUserMeta object in read-only mode.
EbiUserMeta	getUserMeta(EbiContext context) Gets an EbiUserMeta object in read-only mode.
boolean	modifyUserMeta(EbiContext context, EbiUserMeta userMeta) Modifies the user metadata object.
boolean	removeUserMeta(EbiContext context) Removes the user metadata object.

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

createUserMeta

public EbiUserMeta createUserMeta()
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Gets a new EbiUserMeta info object for use in UserMeta creation.

Returns:

a new EbiUserMetaInfo object.

getUserMeta

public EbiUserMeta getUserMeta()
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Gets an EbiUserMeta object in read-only mode.

this call assumes that the EbiUserMeta object is already cached in the user manager.

Returns:

an EbiUserMeta object.

getUserMeta

public EbiUserMeta getUserMeta(EbiContext context)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Gets an EbiUserMeta object in read-only mode.

Parameters:

context - an EbiContext object.

Returns:

an EbiUserMeta object.

getClonedUserMeta

public EbiUserMeta getClonedUserMeta(EbiContext context)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Gets an EbiUserMeta object for modification.

Parameters:

context - an EbiContext object.

Returns:

an EbiUserMeta object.

addUserMeta

public boolean addUserMeta(EbiContext context,
                           EbiUserMeta userMeta)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Adds the user metadata object.

Parameters:

context - an EbiContext object.

userMeta - an EbiUserMeta object.

Returns:

true if the user metadata is added to the database successfully.

modifyUserMeta

public boolean modifyUserMeta(EbiContext context,
                              EbiUserMeta userMeta)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Modifies the user metadata object.

Parameters:

context - an EbiContext object.

userMeta - an EbiUserMeta object.

Returns:

true if the user metadata is modified successfully.

removeUserMeta

public boolean removeUserMeta(EbiContext context)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Removes the user metadata object.

Parameters:

context - an EbiContext object.

Returns:

true if the user metadata is removed from the database successfully.