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

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

All Implemented Interfaces:

java.io.Serializable

public class PermissionPeer

extends org.apache.torque.util.BasePeer

This class handles all the database access for the PERMISSION table. This table contains all the permissions that are used in the system.

Version:

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

Author:

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

See Also:

Serialized Form

Field Summary

static java.lang.String	NAME The column name for the name field.
static java.lang.String	OBJECTDATA The column name for the ObjectData field
static java.lang.String	PERMISSION_ID The column name for the permission id field.

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

DEFAULT_MAP_BUILDER, IGNORE_CASE, log, ORDER_BY

Constructor Summary

PermissionPeer()

Method Summary

static org.apache.torque.util.Criteria	buildCriteria(Permission permission) Builds a criteria object based upon an Permission object
static boolean	checkExists(Permission permission) Checks if a Permission 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.util.Vector	getDifference(java.util.Vector some, java.util.Vector all) Pass in two Vector's of Permission Objects.
static java.lang.String	getTableName() Get the name of this table.
static PermissionSet	retrieveSet(org.apache.torque.util.Criteria criteria) Retrieves/assembles a PermissionSet
static PermissionSet	retrieveSet(Role role) Retrieves a set of Permissions associated with a particular Role.

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

PERMISSION_ID

public static final java.lang.String PERMISSION_ID

The column name for the permission 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

PermissionPeer

public PermissionPeer()

Method Detail

retrieveSet

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

Retrieves/assembles a PermissionSet

Parameters:

criteria - The criteria to use.

Returns:

A PermissionSet.

Throws:

java.lang.Exception - a generic exception.

retrieveSet

public static PermissionSet retrieveSet(Role role)
                                 throws java.lang.Exception

Retrieves a set of Permissions associated with a particular Role.

Parameters:

role - The role to query permissions of.

Returns:

A set of permissions associated with the Role.

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 Permission objects.

Throws:

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

buildCriteria

public static org.apache.torque.util.Criteria buildCriteria(Permission permission)

Builds a criteria object based upon an Permission object

Parameters:

permission - object to build the criteria

Returns:

the Criteria

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(Permission permission)
                           throws DataBackendException,
                                  java.lang.Exception

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

Parameters:

permission - The Permission to be checked.

Returns:

true if given Permission exists in the system.

Throws:

DataBackendException - when more than one Permission 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 a column

Returns:

A String with the full name of the column.

getDifference

public static final java.util.Vector getDifference(java.util.Vector some,
                                                   java.util.Vector all)

Pass in two Vector's of Permission Objects. It will return a new Vector with the difference of the two Vectors: C = (A - B).

Parameters:

some - Vector B in C = (A - B).

all - Vector A in C = (A - B).

Returns:

Vector C in C = (A - B).