org.tigris.scarab.om
Class ScarabUserManager

java.lang.Object
  org.apache.torque.manager.AbstractBaseManager
      org.tigris.scarab.om.BaseScarabUserManager
          org.tigris.scarab.om.ScarabUserManager

All Implemented Interfaces:

java.io.Serializable

public class ScarabUserManager

extends BaseScarabUserManager

This class manages ScarabUser objects.

Version:

$Id: ScarabUserManager.java 10042 2006-04-11 11:28:39Z jorgeuriarte $

Author:

John McNally, Jon S. Stevens

See Also:

Serialized Form

Field Summary

static java.lang.String	GET_ACL
static java.lang.String	HAS_ROLE_IN_MODULE

Fields inherited from class org.tigris.scarab.om.BaseScarabUserManager

DEFAULT_MANAGER_CLASS, MANAGED_CLASS

Fields inherited from class org.apache.torque.manager.AbstractBaseManager

cache, listenersMap, log, mrCache, validFields

Constructor Summary

ScarabUserManager()
Creates a new ScarabUserManager instance.

Method Summary

static ScarabUser	getInstance(java.lang.String username) Return an instance of User based on username.
static ScarabUser	getInstanceByEmail(java.lang.String email) Return an instance of User based on username.
protected ScarabUser	getInstanceByEmailImpl(java.lang.String email) Return an instance of User based on email.
protected ScarabUser	getInstanceImpl() Get a fresh instance of a ScarabUserManager
protected ScarabUser	getInstanceImpl(java.lang.String username) Return an instance of User based on username.
static java.util.List	getUsers(java.lang.String[] usernames) Gets a list of ScarabUsers based on usernames.
protected java.util.List	getUsersImpl(java.lang.String[] usernames) Gets a list of ScarabUsers based on usernames.
static ScarabUser	reactivateUserIfDeleted(ScarabUser su) Reactivate a User instance, if and only if it exists AND it has previously been delted (instance state is DELETED).

Methods inherited from class org.tigris.scarab.om.BaseScarabUserManager

addCacheListener, clear, exists, existsImpl, getCachedInstance, getCachedInstanceImpl, getInstance, getInstance, getInstance, getInstance, getInstance, getInstanceImpl, getInstanceImpl, getInstances, getInstances, getInstancesImpl, getInstancesImpl, getManager, getMethodResult, putInstance, retrieveStoredOM, retrieveStoredOMs

Methods inherited from class org.apache.torque.manager.AbstractBaseManager

addCacheListenerImpl, cacheGet, clearImpl, getClassName, getMethodResultCache, getOMClass, getOMInstance, getOMInstance, getOMInstance, getOMs, getOMs, getOMs, getRegion, notifyListeners, putInstanceImpl, putInstanceImpl, registerAsListener, removeInstanceImpl, setClassName, setOMClass, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HAS_ROLE_IN_MODULE

public static final java.lang.String HAS_ROLE_IN_MODULE

See Also:

Constant Field Values

GET_ACL

public static final java.lang.String GET_ACL

See Also:

Constant Field Values

Constructor Detail

ScarabUserManager

public ScarabUserManager()
                  throws org.apache.torque.TorqueException

Creates a new ScarabUserManager instance.

Throws:

org.apache.torque.TorqueException - if an error occurs

Method Detail

getInstanceImpl

protected ScarabUser getInstanceImpl()

Description copied from class: BaseScarabUserManager

Get a fresh instance of a ScarabUserManager

Overrides:

getInstanceImpl in class BaseScarabUserManager

Returns:

null if there is an UnknownEntityException

getInstance

public static ScarabUser getInstance(java.lang.String username)
                              throws org.apache.torque.TorqueException,
                                     ScarabException

Return an instance of User based on username. Domain is currently unused.

Throws:

org.apache.torque.TorqueException

ScarabException

getInstanceByEmail

public static ScarabUser getInstanceByEmail(java.lang.String email)
                                     throws org.apache.torque.TorqueException,
                                            ScarabException

Return an instance of User based on username.

Throws:

org.apache.torque.TorqueException

ScarabException

getUsers

public static java.util.List getUsers(java.lang.String[] usernames)
                               throws org.apache.torque.TorqueException

Gets a list of ScarabUsers based on usernames. Domain is currently unused.

Parameters:

usernames - a String[] value

Returns:

a List value

Throws:

java.lang.Exception - if an error occurs

org.apache.torque.TorqueException

getInstanceImpl

protected ScarabUser getInstanceImpl(java.lang.String username)
                              throws org.apache.torque.TorqueException,
                                     ScarabException

Return an instance of User based on username. Domain is currently unused.

Throws:

org.apache.torque.TorqueException

ScarabException

getInstanceByEmailImpl

protected ScarabUser getInstanceByEmailImpl(java.lang.String email)
                                     throws org.apache.torque.TorqueException,
                                            ScarabException

Return an instance of User based on email.

Throws:

org.apache.torque.TorqueException

ScarabException

getUsersImpl

protected java.util.List getUsersImpl(java.lang.String[] usernames)
                               throws org.apache.torque.TorqueException

Gets a list of ScarabUsers based on usernames. Domain is currently unused.

Parameters:

usernames - a String[] value

Returns:

a List value

Throws:

java.lang.Exception - if an error occurs

org.apache.torque.TorqueException

reactivateUserIfDeleted

public static ScarabUser reactivateUserIfDeleted(ScarabUser su)
                                          throws java.lang.Exception

Reactivate a User instance, if and only if it exists AND it has previously been delted (instance state is DELETED). returns reacitvated ScarabUser instance, or null, if user is NOT deleted. May return an internal Exception.

Parameters:

su -

Returns:

Throws:

java.lang.Exception