Package org.apache.fulcrum.security.torque.security

Class TorqueAbstractSecurityEntity

java.lang.Object

org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity

All Implemented Interfaces:

Serializable, SecurityEntity, org.apache.torque.om.ObjectModel, org.apache.torque.om.Persistent

Direct Known Subclasses:

DefaultAbstractTurbinePermission, FulcrumAbstractTurbinePermission, TorqueAbstractBasicGroup, TorqueAbstractBasicUser, TorqueAbstractDynamicGroup, TorqueAbstractDynamicPermission, TorqueAbstractDynamicRole, TorqueAbstractDynamicUser, TorqueAbstractTurbineTurbineSecurityEntity

public abstract class TorqueAbstractSecurityEntity
extends Object
implements SecurityEntity, Serializable, org.apache.torque.om.Persistent

This abstract class provides the SecurityInterface to the managers.

Version:

$Id:$

Author:

Thomas Vandahl

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TorqueAbstractSecurityEntity()

Method Summary

Modifier and Type	Method	Description
abstract void	delete()	Delete this entity
abstract Integer	getEntityId()	Get a numeric entity id
abstract String	getEntityName()	Get the name of the entity
Object	getId()	Get the Id of the SecurityEntity.
String	getName()	Get the Name of the SecurityEntity.
abstract void	retrieveAttachedObjects(Connection con)	old contract, lazy is set to false.
abstract void	retrieveAttachedObjects(Connection con, Boolean lazy)	Retrieve attached objects such as users, permissions, ...
abstract void	setEntityId(Integer id)	Set a numeric entity id
abstract void	setEntityName(String name)	Set the name of the entity
void	setId(Object id)	Sets the Id of the SecurityEntity.
void	setName(String name)	Sets the Name of the SecurityEntity.
abstract void	update(Connection con)	Update this instance to the database with all dependent objects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.torque.om.ObjectModel

getPrimaryKey, isModified, isNew, setModified, setNew, setPrimaryKey, setPrimaryKey

Methods inherited from interface org.apache.torque.om.Persistent

save, save, save

Constructor Detail

TorqueAbstractSecurityEntity

public TorqueAbstractSecurityEntity()

Method Detail

getEntityId

public abstract Integer getEntityId()

Get a numeric entity id

Returns:

numeric id of this entity

setEntityId

public abstract void setEntityId(Integer id)
                          throws org.apache.torque.TorqueException

Set a numeric entity id

Parameters:

id - numeric id of this entity

Throws:

org.apache.torque.TorqueException - database not found exception

getEntityName

public abstract String getEntityName()

Get the name of the entity

Returns:

name of this entity

setEntityName

public abstract void setEntityName(String name)

Set the name of the entity

Parameters:

name - the name of the entity

retrieveAttachedObjects

public abstract void retrieveAttachedObjects(Connection con,
                                             Boolean lazy)
                                      throws DataBackendException,
                                             org.apache.torque.TorqueException

Retrieve attached objects such as users, permissions, ...

Parameters:

con - A database connection

lazy - if true, may load some or all relationships later

Throws:

org.apache.torque.TorqueException - database not found exception

DataBackendException

retrieveAttachedObjects

public abstract void retrieveAttachedObjects(Connection con)
                                      throws DataBackendException,
                                             org.apache.torque.TorqueException

old contract, lazy is set to false.

Parameters:

con - A database connection

Throws:

DataBackendException - wrapper exception: user information not found exception

org.apache.torque.TorqueException

update

public abstract void update(Connection con)
                     throws org.apache.torque.TorqueException

Update this instance to the database with all dependent objects

Parameters:

con - A database connection

Throws:

org.apache.torque.TorqueException - database not found exception

delete

public abstract void delete()
                     throws org.apache.torque.TorqueException

Delete this entity

Throws:

org.apache.torque.TorqueException - if any database error occurs if any database operation fails

getId

public Object getId()

Description copied from interface: SecurityEntity

Get the Id of the SecurityEntity.

Specified by:

getId in interface SecurityEntity

Returns:

The Id of the SecurityEntity.

See Also:

SecurityEntity.getId()

setId

public void setId(Object id)

Description copied from interface: SecurityEntity

Sets the Id of the SecurityEntity.

Specified by:

setId in interface SecurityEntity

Parameters:

id - The new Id of the SecurityEntity

See Also:

SecurityEntity.setId(java.lang.Object)

getName

public String getName()

Description copied from interface: SecurityEntity

Get the Name of the SecurityEntity.

Specified by:

getName in interface SecurityEntity

Returns:

The Name of the SecurityEntity.

See Also:

SecurityEntity.getName()

setName

public void setName(String name)

Description copied from interface: SecurityEntity

Sets the Name of the SecurityEntity.

Specified by:

setName in interface SecurityEntity

Parameters:

name - Name of the SecurityEntity.

See Also:

SecurityEntity.setName(java.lang.String)