org.apache.turbine.om.security
Class TurbinePermission

java.lang.Object
  |
  +--org.apache.torque.om.BaseObject
        |
        +--org.apache.turbine.om.security.SecurityObject
              |
              +--org.apache.turbine.om.security.TurbinePermission
All Implemented Interfaces:
java.lang.Comparable, Permission, org.apache.torque.om.Persistent, SecurityEntity, java.io.Serializable

public class TurbinePermission
extends SecurityObject
implements Permission

This class represents the permissions that a Role has to access certain pages/functions within the system. The class implements Comparable so that when Permissions are added to a Set, they will be in alphabetical order by name.

Version:
$Id: TurbinePermission.java,v 1.2 2002/07/11 07:34:30 mpoeschl Exp $
Author:
Frank Y. Kim, John D. McNally, Brett McLaughlin
See Also:
Serialized Form

Fields inherited from class org.apache.torque.om.BaseObject
NEW_ID
 
Constructor Summary
TurbinePermission()
          Constructs a new TurbinePermission.
TurbinePermission(java.lang.String name)
          Constructs a new TurbinePermission with the sepcified name.
 
Method Summary
static Permission create(java.lang.String name)
          Deprecated. Please use the createPermission method in TurbineSecurity.
 void remove()
          Removes a permission from the system.
 void rename(java.lang.String name)
          Renames the permission.
 void save()
          Makes changes made to the Permission attributes permanent.
 void save(java.sql.Connection conn)
          not implemented
 void save(java.lang.String dbname)
          not implemented
 
Methods inherited from class org.apache.turbine.om.security.SecurityObject
compareTo, getAttribute, getAttributes, getName, setAttribute, setAttributes, setName, toString
 
Methods inherited from class org.apache.torque.om.BaseObject
equals, equals, getByName, getByPeerName, getByPosition, getCategory, getPrimaryKey, getPrimaryKeyAsBigDecimal, getPrimaryKeyAsInt, getPrimaryKeyAsLong, getPrimaryKeyAsString, hashCode, isModified, isNew, log, resetModified, setModified, setNew, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.turbine.om.security.SecurityEntity
getName, setName
 

Constructor Detail

TurbinePermission

public TurbinePermission()
Constructs a new TurbinePermission.

TurbinePermission

public TurbinePermission(java.lang.String name)
Constructs a new TurbinePermission with the sepcified name.
Parameters:
name - The name of the new object.
Method Detail

create

public static Permission create(java.lang.String name)
                         throws TurbineSecurityException
Deprecated. Please use the createPermission method in TurbineSecurity.

Creates a new Permission in the system.
Parameters:
name - The name of the new Permission.
Returns:
An object representing the new Permission.
Throws:
TurbineSecurityException - if the Permission could not be created.

save

public void save()
          throws TurbineSecurityException
Makes changes made to the Permission attributes permanent.
Specified by:
save in interface Permission
Overrides:
save in class org.apache.torque.om.BaseObject
Throws:
TurbineSecurityException - if there is a problem while saving data.

save

public void save(java.sql.Connection conn)
          throws java.lang.Exception
not implemented
Overrides:
save in class org.apache.torque.om.BaseObject
Parameters:
conn -  
Throws:
java.lang.Exception -  

save

public void save(java.lang.String dbname)
          throws java.lang.Exception
not implemented
Overrides:
save in class org.apache.torque.om.BaseObject
Parameters:
dbname -  
Throws:
java.lang.Exception -  

remove

public void remove()
            throws TurbineSecurityException
Removes a permission from the system.
Specified by:
remove in interface Permission
Throws:
TurbineSecurityException - if the Permission could not be removed.

rename

public void rename(java.lang.String name)
            throws TurbineSecurityException
Renames the permission.
Specified by:
rename in interface Permission
Parameters:
name - The new Permission name.
Throws:
TurbineSecurityException - if the Permission could not be renamed.


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.