org.tigris.scarab.om
Class BaseModuleManager

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ModuleManager

public abstract class BaseModuleManager

extends org.apache.torque.manager.AbstractBaseManager

This class manages Module objects. This class was autogenerated by Torque * You should not use this class directly. It should not even be extended all references should be to ModuleManager

See Also:

Serialized Form

Field Summary

protected static java.lang.String	DEFAULT_MANAGER_CLASS The name of our class to pass to Torque as the default manager.
protected static java.lang.String	MANAGED_CLASS The name of the manager

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

cache, listenersMap, log, mrCache, validFields

Constructor Summary

BaseModuleManager()
Creates a new BaseModuleManager instance.

Method Summary

static void	addCacheListener(org.apache.torque.manager.CacheListener listener)
static void	clear()
static boolean	exists(Module obj)
protected boolean	existsImpl(Module om) check for a duplicate project name
static Module	getCachedInstance(org.apache.torque.om.ObjectKey id) Static accessor for the @see #getCachedInstanceImpl(ObjectKey).
protected Module	getCachedInstanceImpl(org.apache.torque.om.ObjectKey id) Get a Module with the given id from the cache.
static Module	getInstance() Static accessor for the @see #getInstanceImpl().
static Module	getInstance(java.lang.Integer id) Static accessor for the @see #getInstanceImpl(ObjectKey).
static Module	getInstance(java.lang.Integer id, boolean fromCache) Static accessor for the @see #getInstanceImpl(ObjectKey).
static Module	getInstance(org.apache.torque.om.ObjectKey id) Static accessor for the @see #getInstanceImpl(ObjectKey).
static Module	getInstance(org.apache.torque.om.ObjectKey id, boolean fromCache) Static accessor for the @see #getInstanceImpl(ObjectKey, boolean).
protected Module	getInstanceImpl() Get a fresh instance of a ModuleManager
protected Module	getInstanceImpl(org.apache.torque.om.ObjectKey id) Get a Module with the given id.
protected Module	getInstanceImpl(org.apache.torque.om.ObjectKey id, boolean fromCache) Get a Module with the given id.
static java.util.List	getInstances(java.util.List ids) Static accessor for the @see #getInstancesImpl(List).
static java.util.List	getInstances(java.util.List ids, boolean fromCache) Static accessor for the @see #getInstancesImpl(List, boolean).
protected java.util.List	getInstancesImpl(java.util.List ids) Gets a list of Modules based on id's.
protected java.util.List	getInstancesImpl(java.util.List ids, boolean fromCache) Gets a list of Modules based on id's.
static ModuleManager	getManager() Retrieves an implementation of the manager, based on the settings in the configuration.
static org.apache.torque.manager.MethodResultCache	getMethodResult()
static void	putInstance(org.apache.torque.om.Persistent om)
protected org.apache.torque.om.Persistent	retrieveStoredOM(org.apache.torque.om.ObjectKey id)
protected java.util.List	retrieveStoredOMs(java.util.List ids) Gets a list of ModuleEntities based on id's.

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

MANAGED_CLASS

protected static final java.lang.String MANAGED_CLASS

The name of the manager

See Also:

Constant Field Values

DEFAULT_MANAGER_CLASS

protected static final java.lang.String DEFAULT_MANAGER_CLASS

The name of our class to pass to Torque as the default manager.

See Also:

Constant Field Values

Constructor Detail

BaseModuleManager

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

Creates a new BaseModuleManager instance.

Throws:

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

Method Detail

getManager

public static ModuleManager getManager()

Retrieves an implementation of the manager, based on the settings in the configuration.

Returns:

an implementation of ModuleManager.

getInstance

public static Module getInstance()
                          throws org.apache.torque.TorqueException

Static accessor for the @see #getInstanceImpl().

Returns:

a Module value

Throws:

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

getInstance

public static Module getInstance(org.apache.torque.om.ObjectKey id)
                          throws org.apache.torque.TorqueException

Static accessor for the @see #getInstanceImpl(ObjectKey).

Parameters:

id - an ObjectKey value

Returns:

a Module value

Throws:

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

getCachedInstance

public static Module getCachedInstance(org.apache.torque.om.ObjectKey id)
                                throws org.apache.torque.TorqueException

Static accessor for the @see #getCachedInstanceImpl(ObjectKey). Loads Module from cache, returns null, if instance is not in cache

Parameters:

id - an ObjectKey value

Returns:

a Module value

Throws:

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

getInstance

public static Module getInstance(org.apache.torque.om.ObjectKey id,
                                 boolean fromCache)
                          throws org.apache.torque.TorqueException

Static accessor for the @see #getInstanceImpl(ObjectKey, boolean).

Parameters:

id - an ObjectKey value

fromCache - if true, look for cached Modules before loading from storage.

Returns:

a Module value

Throws:

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

getInstance

public static Module getInstance(java.lang.Integer id)
                          throws org.apache.torque.TorqueException

Static accessor for the @see #getInstanceImpl(ObjectKey).

Parameters:

id - an ObjectKey value

Returns:

a Module value

Throws:

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

getInstance

public static Module getInstance(java.lang.Integer id,
                                 boolean fromCache)
                          throws org.apache.torque.TorqueException

Static accessor for the @see #getInstanceImpl(ObjectKey).

Parameters:

id - an ObjectKey value

fromCache - if true, look for cached Modules before loading from storage.

Returns:

a Module value

Throws:

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

getInstances

public static java.util.List getInstances(java.util.List ids)
                                   throws org.apache.torque.TorqueException

Static accessor for the @see #getInstancesImpl(List).

Parameters:

ids - a List value

Returns:

a List value

Throws:

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

getInstances

public static java.util.List getInstances(java.util.List ids,
                                          boolean fromCache)
                                   throws org.apache.torque.TorqueException

Static accessor for the @see #getInstancesImpl(List, boolean).

Parameters:

ids - a List value

fromCache - if true, look for cached Modules before loading from storage.

Returns:

a List value

Throws:

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

putInstance

public static void putInstance(org.apache.torque.om.Persistent om)
                        throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

clear

public static void clear()
                  throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

exists

public static boolean exists(Module obj)
                      throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getMethodResult

public static org.apache.torque.manager.MethodResultCache getMethodResult()

addCacheListener

public static void addCacheListener(org.apache.torque.manager.CacheListener listener)

getInstanceImpl

protected Module getInstanceImpl()
                          throws org.apache.torque.TorqueException

Get a fresh instance of a ModuleManager

Throws:

org.apache.torque.TorqueException

getInstanceImpl

protected Module getInstanceImpl(org.apache.torque.om.ObjectKey id)
                          throws org.apache.torque.TorqueException

Get a Module with the given id.

Parameters:

id - ObjectKey value

Throws:

org.apache.torque.TorqueException

getCachedInstanceImpl

protected Module getCachedInstanceImpl(org.apache.torque.om.ObjectKey id)
                                throws org.apache.torque.TorqueException

Get a Module with the given id from the cache. Returns null if instance is not in cache

Parameters:

id - ObjectKey value

Throws:

org.apache.torque.TorqueException

getInstanceImpl

protected Module getInstanceImpl(org.apache.torque.om.ObjectKey id,
                                 boolean fromCache)
                          throws org.apache.torque.TorqueException

Get a Module with the given id.

Parameters:

id - ObjectKey value

fromCache - if true, look for cached Modules before loading from storage.

Throws:

org.apache.torque.TorqueException

getInstancesImpl

protected java.util.List getInstancesImpl(java.util.List ids)
                                   throws org.apache.torque.TorqueException

Gets a list of Modules based on id's.

Parameters:

ids - a List of ObjectKeys value

Returns:

a List of Modules

Throws:

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

getInstancesImpl

protected java.util.List getInstancesImpl(java.util.List ids,
                                          boolean fromCache)
                                   throws org.apache.torque.TorqueException

Gets a list of Modules based on id's.

Parameters:

ids - a List of ObjectKeys value

fromCache - if true, look for cached Modules before loading from storage.

Returns:

a List of Modules

Throws:

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

existsImpl

protected boolean existsImpl(Module om)
                      throws org.apache.torque.TorqueException

check for a duplicate project name

Throws:

org.apache.torque.TorqueException

retrieveStoredOM

protected org.apache.torque.om.Persistent retrieveStoredOM(org.apache.torque.om.ObjectKey id)
                                                    throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

retrieveStoredOMs

protected java.util.List retrieveStoredOMs(java.util.List ids)
                                    throws org.apache.torque.TorqueException

Gets a list of ModuleEntities based on id's.

Parameters:

ids - a NumberKey[] value

Returns:

a List value

Throws:

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