org.sape.carbon.services.uniqueid
Interface UniqueIDServiceConfiguration

All Superinterfaces:

ComponentConfiguration, Configuration

public interface UniqueIDServiceConfiguration

extends ComponentConfiguration

An Interface that represents the Factory configuration.

Copyright 2002 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.4 $($Author: dvoet $ / $Date: 2003/05/05 21:21:38 $)

Author:

Vivekanand Kirubanandan, June 2002

Field Summary

static boolean	AutoCreate Default value for AutoCreate
static long	BlockSize Default value for BlockSize
static String	CreateStatementName Default value for CreateStatementName
static long	InitialBlockStart Default value for InitialBlockStart
static String	RetrieveStatementName Default value for RetrieveStatementName
static String	UpdateStatementName Default value for UpdateStatementName

Fields inherited from interface org.sape.carbon.core.component.ComponentConfiguration

ComponentTemplateName

Method Summary

long	getBlockSize() BlockSize is the number of IDs that is reserved upon each call to the database.
ConnectionFactory	getConnectionFactory() Reference to the ConnectionFactory that this service will use to create connections to the database (required)
String	getCreateStatementName() Name of a PreparedStatement configured within the StatementFactory used to create a new ID
String	getIDName() IDName identifies the UniqueID in the database (required)
long	getInitialBlockStart() InitialBlockStart is used to define the starting value of the ID in the case that the ID is automatically created by the service
String	getRetrieveStatementName() Name of a PreparedStatement configured within the StatementFactory used to get the starting value of the next available block of IDs
StatementFactory	getStatementFactory() Reference to the StatementFactory that this service will use to create sql statements (required)
String	getUpdateStatementName() Name of a PreparedStatement configured within the StatementFactory used to update the starting value of the next available block of IDs
boolean	isAutoCreate() AutoCreate specifies whether or not the ID should be created if it does not exist.
void	setAutoCreate(boolean autoCreate) AutoCreate specifies whether or not the ID should be created if it does not exist.
void	setBlockSize(long size) BlockSize is the number of IDs that is reserved upon each call to the database.
void	setConnectionFactory(ConnectionFactory factory) Reference to the ConnectionFactory that this service will use to create connections to the database (required)
void	setCreateStatementName(String name) Name of a PreparedStatement configured within the StatementFactory used to create a new ID
void	setIDName(String name) IDName identifies the UniqueID in the database (required)
void	setInitialBlockStart(long startValue) InitialBlockStart is used to define the starting value of the ID in the case that the ID is automatically created by the service.
void	setRetrieveStatementName(String name) Name of a PreparedStatement configured within the StatementFactory used to get the starting value of the next available block of IDs
void	setStatementFactory(StatementFactory factory) Reference to the StatementFactory that this service will use to create sql statements (required)
void	setUpdateStatementName(String name) Name of a PreparedStatement configured within the StatementFactory used to update the starting value of the next available block of IDs

Methods inherited from interface org.sape.carbon.core.component.ComponentConfiguration

getComponentDescription, getComponentTemplateName, getFunctionalImplementationClass, getFunctionalInterface, setComponentDescription, setComponentTemplateName, setFunctionalImplementationClass, setFunctionalInterface

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Field Detail

InitialBlockStart

public static final long InitialBlockStart

Default value for InitialBlockStart

See Also:

Constant Field Values

BlockSize

public static final long BlockSize

Default value for BlockSize

See Also:

Constant Field Values

AutoCreate

public static final boolean AutoCreate

Default value for AutoCreate

See Also:

Constant Field Values

RetrieveStatementName

public static final String RetrieveStatementName

Default value for RetrieveStatementName

See Also:

Constant Field Values

UpdateStatementName

public static final String UpdateStatementName

Default value for UpdateStatementName

See Also:

Constant Field Values

CreateStatementName

public static final String CreateStatementName

Default value for CreateStatementName

See Also:

Constant Field Values

Method Detail

getInitialBlockStart

public long getInitialBlockStart()

InitialBlockStart is used to define the starting value of the ID in the case that the ID is automatically created by the service

Returns:

the first value of an ID that is automatically created

setInitialBlockStart

public void setInitialBlockStart(long startValue)

InitialBlockStart is used to define the starting value of the ID in the case that the ID is automatically created by the service.

Parameters:

startValue - the first value of an ID that is automatically created

getIDName

public String getIDName()

IDName identifies the UniqueID in the database (required)

Returns:

the name of the unique id

setIDName

public void setIDName(String name)

IDName identifies the UniqueID in the database (required)

Parameters:

name - the name of the unique id

getBlockSize

public long getBlockSize()

BlockSize is the number of IDs that is reserved upon each call to the database. This should be optimized to minimize hits to the database.

Returns:

the blocksize to reservice in the database

setBlockSize

public void setBlockSize(long size)

BlockSize is the number of IDs that is reserved upon each call to the database. This should be optimized to minimize hits to the database.

Parameters:

size - the blocksize to reservce in the database

isAutoCreate

public boolean isAutoCreate()

AutoCreate specifies whether or not the ID should be created if it does not exist. If this is true, the ID will be automatically created

Returns:

indicates if the id will be auto created.

setAutoCreate

public void setAutoCreate(boolean autoCreate)

AutoCreate specifies whether or not the ID should be created if it does not exist. If this is true, the ID will be automatically created

Parameters:

autoCreate - should the id be auto created

getStatementFactory

public StatementFactory getStatementFactory()

Reference to the StatementFactory that this service will use to create sql statements (required)

Returns:

statement factory to use with the service

setStatementFactory

public void setStatementFactory(StatementFactory factory)

Reference to the StatementFactory that this service will use to create sql statements (required)

Parameters:

factory - statement factory to use with the service

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Reference to the ConnectionFactory that this service will use to create connections to the database (required)

Returns:

connection factory to use with the service

setConnectionFactory

public void setConnectionFactory(ConnectionFactory factory)

Reference to the ConnectionFactory that this service will use to create connections to the database (required)

Parameters:

factory - connection factory to use with the service

getRetrieveStatementName

public String getRetrieveStatementName()

Name of a PreparedStatement configured within the StatementFactory used to get the starting value of the next available block of IDs

Returns:

name of the prepared statement

setRetrieveStatementName

public void setRetrieveStatementName(String name)

Name of a PreparedStatement configured within the StatementFactory used to get the starting value of the next available block of IDs

Parameters:

name - name of the prepared statement

getUpdateStatementName

public String getUpdateStatementName()

Name of a PreparedStatement configured within the StatementFactory used to update the starting value of the next available block of IDs

Returns:

name of the prepared statement

setUpdateStatementName

public void setUpdateStatementName(String name)

Name of a PreparedStatement configured within the StatementFactory used to update the starting value of the next available block of IDs

Parameters:

name - name of the prepared statement

getCreateStatementName

public String getCreateStatementName()

Name of a PreparedStatement configured within the StatementFactory used to create a new ID

Returns:

name of the prepared statement

setCreateStatementName

public void setCreateStatementName(String name)

Name of a PreparedStatement configured within the StatementFactory used to create a new ID

Parameters:

name - name of the prepared statement