com.bristle.javalib.sql.bristle
Class AbstractSecurableStandardTableBackedObject

java.lang.Object
  com.bristle.javalib.sql.bristle.AbstractStandardTableBackedObject
      com.bristle.javalib.sql.bristle.AbstractSecurableStandardTableBackedObject

All Implemented Interfaces:

Securable

public abstract class AbstractSecurableStandardTableBackedObject
extends AbstractStandardTableBackedObject
implements Securable

This class is a simple object that implements the Securable interface for an AbstractStandardTableBackedObject.

Usage:

   - The typical scenarios for using this class are:

Assumptions:
Effects:
       - None.
Anticipated Changes:
Notes:
Implementation Notes:
Portability Issues:
Revision History:
   $Log$

Constructor Summary

AbstractSecurableStandardTableBackedObject()

Method Summary

AbstractStandardTableBackedObject	getCLASS_OF_OBJECTS() Get the special instance that indicates the class of objects instead of any one particular instance.
abstract int	getClassId() Get the id of the class of objects.
String	getDataSource() Get the data source, typically a DB table name, of the object, for use in determining whether the current user has access to it.
Securable	getSecurableCLASS_OF_OBJECTS()
abstract AbstractSecurableStandardTableBackedObject	getSecurableStandardTableBackedCLASS_OF_OBJECTS()
abstract String	getTableName() Get the name of the database table that holds the class of objects.

Methods inherited from class com.bristle.javalib.sql.bristle.AbstractStandardTableBackedObject

getCreateDT, getCreateUser, getDefaultNullClassId, getDefaultNullId, getId, getNullClassId, getNullId, getStatus, getUpdateDT, getUpdateUser, setCreateDT, setCreateUser, setId, setStatus, setUpdateDT, setUpdateUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bristle.javalib.security.Securable

getId, getNullClassId, getNullId

Constructor Detail

AbstractSecurableStandardTableBackedObject

public AbstractSecurableStandardTableBackedObject()

Method Detail

getDataSource

public String getDataSource()

Description copied from interface: Securable

Get the data source, typically a DB table name, of the object, for use in determining whether the current user has access to it.

Specified by:

getDataSource in interface Securable

Returns:

The data source

See Also:

Securable.getDataSource()

getCLASS_OF_OBJECTS

public AbstractStandardTableBackedObject getCLASS_OF_OBJECTS()

Description copied from class: AbstractStandardTableBackedObject

Get the special instance that indicates the class of objects instead of any one particular instance.

 Implementation Note:
   Abstract to force each subclass to explicitly specify an instance of 
   itself to represent its entire class.

Specified by:

getCLASS_OF_OBJECTS in class AbstractStandardTableBackedObject

Returns:

The special instance.

See Also:

Calls {@link getSecurableStandardTableBackedCLASS_OF_OBJECTS()}

getSecurableCLASS_OF_OBJECTS

public Securable getSecurableCLASS_OF_OBJECTS()

Specified by:

getSecurableCLASS_OF_OBJECTS in interface Securable

See Also:

Calls {@link getSecurableStandardTableBackedCLASS_OF_OBJECTS()}

getSecurableStandardTableBackedCLASS_OF_OBJECTS

public abstract AbstractSecurableStandardTableBackedObject getSecurableStandardTableBackedCLASS_OF_OBJECTS()

See Also:

getCLASS_OF_OBJECTS(), getSecurableCLASS_OF_OBJECTS()

getClassId

public abstract int getClassId()

Description copied from class: AbstractStandardTableBackedObject

Get the id of the class of objects.

 Implementation Note:
   Abstract to force each subclass to explicitly specify its class id.
   If a subclass doesn't care about class id, it can call getNullClassId() 
   from its override.

Specified by:

getClassId in interface Securable

Specified by:

getClassId in class AbstractStandardTableBackedObject

Returns:

The class id.

See Also:

 Implementation Note:
   Abstract to force each subclass to explicitly specify its class id.
   If a subclass doesn't care about class id, it can call getNullClassId() 
   from its override.

getTableName

public abstract String getTableName()

Description copied from class: AbstractStandardTableBackedObject

Get the name of the database table that holds the class of objects.

 Implementation Note:
   Abstract to force each subclass to explicitly specify its table name.

Specified by:

getTableName in class AbstractStandardTableBackedObject

Returns:

The table name.

See Also:

 Implementation Note:
   Abstract to force each subclass to explicitly specify its table name.