org.apache.turbine.om.security.peer
Class GroupPeer

java.lang.Object
  org.apache.torque.util.BasePeer
      org.apache.turbine.om.security.peer.GroupPeer

All Implemented Interfaces:

java.io.Serializable

public class GroupPeer

extends org.apache.torque.util.BasePeer

This class handles all the database access for the Group table. This table contains all the Groups that a given member can play.

Version:

$Id: GroupPeer.java 264148 2005-08-29 14:21:04Z henning $

Author:

Frank Y. Kim, John D. McNally, Brett McLaughlin, Rafal Krzewski

See Also:

Serialized Form

Field Summary

static java.lang.String	GROUP_ID The column name for the Group id field.
static java.lang.String	NAME The column name for the name field.
static java.lang.String	OBJECTDATA The column name for the ObjectData field

Fields inherited from class org.apache.torque.util.BasePeer

DEFAULT_MAP_BUILDER, IGNORE_CASE, log, ORDER_BY

Constructor Summary

GroupPeer()

Method Summary

static org.apache.torque.util.Criteria	buildCriteria(Group group) Builds a criteria object based upon an Group object
static boolean	checkExists(Group group) Checks if a Group is defined in the system.
static java.util.List	doSelect(org.apache.torque.util.Criteria criteria) Issues a select based on a criteria.
static void	doUpdate(org.apache.torque.util.Criteria criteria) Issues an update based on a criteria.
static java.lang.String	getColumnName(java.lang.String name) Returns the full name of a column.
static java.lang.String	getTableName() Get the name of this table.
static GroupSet	retrieveSet() Retrieves/assembles a GroupSet of all of the Groups.
static GroupSet	retrieveSet(org.apache.torque.util.Criteria criteria) Retrieves/assembles a GroupSet based on the Criteria passed in

Methods inherited from class org.apache.torque.util.BasePeer

createPreparedStatement, createQueryString, deleteAll, deleteAll, doDelete, doDelete, doInsert, doInsert, doPSSelect, doPSSelect, doSelect, doUpdate, doUpdate, doUpdate, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeStatement, executeStatement, executeStatement, getMapBuilder, getMapBuilder, getSelectResults, getSelectResults, getSelectResults, getSelectResults, handleMultipleRecords, hashtableToByteArray, initColumnNames, initCriteriaKeys, initTableColumns, initTableSchema, initTableSchema

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_ID

public static final java.lang.String GROUP_ID

The column name for the Group id field.

NAME

public static final java.lang.String NAME

The column name for the name field.

OBJECTDATA

public static final java.lang.String OBJECTDATA

The column name for the ObjectData field

Constructor Detail

GroupPeer

public GroupPeer()

Method Detail

retrieveSet

public static GroupSet retrieveSet()
                            throws java.lang.Exception

Retrieves/assembles a GroupSet of all of the Groups.

Returns:

A GroupSet.

Throws:

java.lang.Exception - a generic exception.

retrieveSet

public static GroupSet retrieveSet(org.apache.torque.util.Criteria criteria)
                            throws java.lang.Exception

Retrieves/assembles a GroupSet based on the Criteria passed in

Parameters:

criteria - The criteria to use.

Returns:

a GroupSet

Throws:

java.lang.Exception - a generic exception.

doSelect

public static java.util.List doSelect(org.apache.torque.util.Criteria criteria)
                               throws org.apache.torque.TorqueException

Issues a select based on a criteria.

Parameters:

criteria - object containing data that is used to create the SELECT statement.

Returns:

Vector containing Group objects.

Throws:

org.apache.torque.TorqueException - a generic exception.

doUpdate

public static void doUpdate(org.apache.torque.util.Criteria criteria)
                     throws org.apache.torque.TorqueException

Issues an update based on a criteria.

Parameters:

criteria - object containing data that is used to create the UPDATE statement.

Throws:

org.apache.torque.TorqueException - a generic exception.

checkExists

public static boolean checkExists(Group group)
                           throws DataBackendException,
                                  java.lang.Exception

Checks if a Group is defined in the system. The name is used as query criteria.

Parameters:

group - The Group to be checked.

Returns:

true if given Group exists in the system.

Throws:

DataBackendException - when more than one Group with the same name exists.

java.lang.Exception - a generic exception.

getTableName

public static java.lang.String getTableName()

Get the name of this table.

Returns:

A String with the name of the table.

getColumnName

public static java.lang.String getColumnName(java.lang.String name)

Returns the full name of a column.

Parameters:

name - name of the column

Returns:

A String with the full name of the column.

buildCriteria

public static org.apache.torque.util.Criteria buildCriteria(Group group)

Builds a criteria object based upon an Group object

Parameters:

group - object to build the Criteria

Returns:

the Criteria