org.apache.turbine.om.security
Class SecurityObject

java.lang.Object
  org.apache.torque.om.BaseObject
      org.apache.turbine.om.security.SecurityObject

All Implemented Interfaces:

java.lang.Comparable, org.apache.torque.om.Persistent, java.io.Serializable

Direct Known Subclasses:

TurbineGroup, TurbinePermission, TurbineRole, TurbineUser

public abstract class SecurityObject

extends org.apache.torque.om.BaseObject

implements java.lang.Comparable

This class represents a generic object used in the Access Control Lists.

Version:

$Id: SecurityObject.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

Fields inherited from class org.apache.torque.om.BaseObject

NEW_ID

Constructor Summary

SecurityObject()
Constructs a new SecurityObject

SecurityObject(java.lang.String name)
Constructs a new SecurityObject with the specified name.

Method Summary

int	compareTo(java.lang.Object obj) Used for ordering SecurityObjects.
java.lang.Object	getAttribute(java.lang.String name) Retrieves the value of specific attribute of this object.
java.util.Map	getAttributes() Returns a Map containing this object's attributes.
int	getId() Unused.
java.lang.Integer	getIdAsObj() Unused.
java.lang.String	getName() Returns the name of this object.
void	setAttribute(java.lang.String name, java.lang.Object value) Sets the value of specific attribute of this object.
void	setAttributes(java.util.Map attributes) Replaces this object's attributes with the specified Map.
void	setId(int id) Unused.
void	setName(java.lang.String name) Sets the name of this object.
java.lang.String	toString() Returns a textual representation of this object, consisted by it's name and attributes.

Methods inherited from class org.apache.torque.om.BaseObject

equals, equals, getByName, getByPeerName, getByPosition, getLog, getPrimaryKey, hashCode, isModified, isNew, log, resetModified, save, save, save, setModified, setNew, setPrimaryKey, setPrimaryKey, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityObject

public SecurityObject()

Constructs a new SecurityObject

SecurityObject

public SecurityObject(java.lang.String name)

Constructs a new SecurityObject with the specified name.

Parameters:

name - The name of the new object.

Method Detail

getAttributes

public java.util.Map getAttributes()

Returns a Map containing this object's attributes.

Returns:

the object's attributes.

setAttributes

public void setAttributes(java.util.Map attributes)

Replaces this object's attributes with the specified Map.

Parameters:

attributes - The new attributes of the object.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Retrieves the value of specific attribute of this object.

Parameters:

name - the name of the attribute

Returns:

the value of the attribute

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Sets the value of specific attribute of this object.

Parameters:

name - the name of the attribute

value - the value of the attribute

getName

public java.lang.String getName()

Returns the name of this object.

Returns:

The name of the object.

setName

public void setName(java.lang.String name)

Sets the name of this object.

Parameters:

name - The name of the object.

getId

public int getId()

Unused. There is an ID column in the database scheme but it doesn't seem to be used.

Returns:

0

getIdAsObj

public java.lang.Integer getIdAsObj()

Unused. There is an ID column in the database scheme but it doesn't seem to be used.

Returns:

null

setId

public void setId(int id)

Unused. There is an ID column in the database scheme but it doesn't seem to be used.

Parameters:

id - The id of the User.

compareTo

public int compareTo(java.lang.Object obj)

Used for ordering SecurityObjects.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - The Object to compare to.

Returns:

-1 if the name of the other object is lexically greater than this group, 1 if it is lexically lesser, 0 if they are equal.

toString

public java.lang.String toString()

Returns a textual representation of this object, consisted by it's name and attributes.

Returns:

a textual representation of this group.