org.apache.turbine.services.schedule
Class JobEntryPeer

java.lang.Object
  |
  +--org.apache.turbine.om.peer.BasePeer
        |
        +--org.apache.turbine.services.schedule.JobEntryPeer

public class JobEntryPeer
extends BasePeer

Peer class for JobEntry database access.

Version:
$Id$
Author:
Dave Bryson

Field Summary
static java.lang.String DAY_OF_MONTH
           
static java.lang.String EMAIL
           
static java.lang.String HOUR
           
private static TurbineMapBuilder mapBuilder
          Get the MapBuilder.
static java.lang.String MINUTE
           
static java.lang.String OID
           
static java.lang.String PROPERTY
           
static java.lang.String SECOND
           
private static java.lang.String TABLE_NAME
          Name of the table.
static java.lang.String TASK
           
static java.lang.String WEEKDAY
           
 
Fields inherited from class org.apache.turbine.om.peer.BasePeer
DEFAULT_MAP_BUILDER, IGNORE_CASE, mapBuilders, ORDER_BY
 
Constructor Summary
JobEntryPeer()
           
 
Method Summary
protected static void addSelectColumns(Criteria criteria)
          Add all the columns needed to create a new object.
static ObjectKey doInsert(Criteria criteria)
          Perform a SQL insert, handling connection details internally.
static ObjectKey doInsert(Criteria criteria, DBConnection dbCon)
          Method to do inserts.
static java.util.Vector doSelect(Criteria criteria)
          Called from the SchedulerService init() to batch load Jobs into the queue.
static void doUpdate(Criteria criteria)
          Update an existing Job.
static JobEntry getJob(int oid)
          Retrieve a JobEntry based on its id.
 
Methods inherited from class org.apache.turbine.om.peer.BasePeer
beginTransaction, commitTransaction, createPreparedStatement, createQueryString, deleteAll, deleteAll, doDelete, doDelete, doPSSelect, doPSSelect, doSelect, doUpdate, doUpdate, doUpdate, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeStatement, executeStatement, executeStatement, getMapBuilder, getMapBuilder, getPrimaryKey, getSelectResults, getSelectResults, getSelectResults, getSelectResults, handleMultiple, handleMultipleRecords, hashtableToByteArray, initColumnNames, initCriteriaKeys, initTableColumns, initTableSchema, initTableSchema, insertOrUpdateRecord, rollBackTransaction
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

mapBuilder

private static final TurbineMapBuilder mapBuilder
Get the MapBuilder.

TABLE_NAME

private static final java.lang.String TABLE_NAME
Name of the table.

OID

public static final java.lang.String OID

SECOND

public static final java.lang.String SECOND

MINUTE

public static final java.lang.String MINUTE

HOUR

public static final java.lang.String HOUR

WEEKDAY

public static final java.lang.String WEEKDAY

DAY_OF_MONTH

public static final java.lang.String DAY_OF_MONTH

TASK

public static final java.lang.String TASK

EMAIL

public static final java.lang.String EMAIL

PROPERTY

public static final java.lang.String PROPERTY
Constructor Detail

JobEntryPeer

public JobEntryPeer()
Method Detail

doUpdate

public static void doUpdate(Criteria criteria)
                     throws java.lang.Exception
Update an existing Job.
Parameters:
Criteria - The information to update.
Throws:
Exception, - a generic exception.

doSelect

public static java.util.Vector doSelect(Criteria criteria)
                                 throws java.lang.Exception
Called from the SchedulerService init() to batch load Jobs into the queue.
Parameters:
Criteria - The information for the where.
Returns:
Vector of JobEntries.
Throws:
Exception, - a generic exception.

doInsert

public static ObjectKey doInsert(Criteria criteria)
                          throws java.lang.Exception
Perform a SQL insert, handling connection details internally.
Following copied from class: org.apache.turbine.om.peer.BasePeer
Parameters:
criteria - Object containing values to insert.
Returns:
An Object which is the id of the row that was inserted (if the table has a primary key) or null (if the table does not have a primary key).
Throws:
Exception, - a generic exception.

doInsert

public static ObjectKey doInsert(Criteria criteria,
                                 DBConnection dbCon)
                          throws java.lang.Exception
Method to do inserts. This method is to be used during a transaction, otherwise use the doInsert(Criteria) method. It will take care of the connection details internally.
Following copied from class: org.apache.turbine.om.peer.BasePeer
Parameters:
criteria - Object containing values to insert.
dbCon - A DBConnection.
Returns:
An Object which is the id of the row that was inserted (if the table has a primary key) or null (if the table does not have a primary key).
Throws:
Exception, - a generic exception.

addSelectColumns

protected static void addSelectColumns(Criteria criteria)
                                throws java.lang.Exception
Add all the columns needed to create a new object.

getJob

public static JobEntry getJob(int oid)
                       throws java.lang.Exception
Retrieve a JobEntry based on its id.
Parameters:
oid - The JobEntry int id.
Returns:
A JobEntry.
Throws:
Exception, - a generic exception.


Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.