org.griphyn.common.catalog
Interface WorkCatalog

All Superinterfaces:
Catalog
All Known Implementing Classes:
Database

public interface WorkCatalog
extends Catalog

The catalog interface to the Work Catalog, the erstwhile Work DB, that is populated by tailstatd and associates.

Version:
$Revision$
Author:
Karan Vahi

Field Summary
static String c_prefix
          Prefix for the property subset to use with this catalog.
static String DB_PREFIX
          The DB Driver properties prefix.
static String VERSION
          The version of the API
 
Fields inherited from interface org.griphyn.common.catalog.Catalog
DB_ALL_PREFIX
 
Method Summary
 int delete(String basedir, String vogroup, String label, String run)
          Deletes a mapping from the work catalog.
 int insert(String basedir, String vogroup, String label, String run, String creator, Date cTime, Date mTime, int state)
          Inserts a new mapping into the work catalog.
 
Methods inherited from interface org.griphyn.common.catalog.Catalog
close, connect, isClosed
 

Field Detail

c_prefix

static final String c_prefix
Prefix for the property subset to use with this catalog.

See Also:
Constant Field Values

DB_PREFIX

static final String DB_PREFIX
The DB Driver properties prefix.

See Also:
Constant Field Values

VERSION

static final String VERSION
The version of the API

See Also:
Constant Field Values
Method Detail

insert

int insert(String basedir,
           String vogroup,
           String label,
           String run,
           String creator,
           Date cTime,
           Date mTime,
           int state)
           throws WorkCatalogException
Inserts a new mapping into the work catalog.

Parameters:
basedir - the base directory
vogroup - the vo to which the user belongs to.
label - the label in the DAX
run - the run number.
creator - the user who is running.
cTime - the creation time of the DAX
mTime - the modification time.
state - the state of the workflow
Returns:
number of insertions, should always be 1. On failure, throw an exception, don't use zero.
Throws:
WorkCatalogException - in case of unable to delete entry.

delete

int delete(String basedir,
           String vogroup,
           String label,
           String run)
           throws WorkCatalogException
Deletes a mapping from the work catalog.

Parameters:
basedir - the base directory
vogroup - the vo to which the user belongs to.
label - the label in the DAX
run - the run number.
Returns:
number of insertions, should always be 1. On failure, throw an exception, don't use zero.
Throws:
WorkCatalogException - in case of unable to delete entry.


Copyright © 2007 The University of Southern California. All Rights Reserved.