Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.flexstor.ejb.bucket.persist
Interface BucketPersist  view BucketPersist download BucketPersist.java

All Superinterfaces:
com.flexstor.ejb.EjbObject, javax.ejb.EJBObject, java.rmi.Remote

public interface BucketPersist
extends com.flexstor.ejb.EjbObject

This is the client interface for obtaining a bucket Data Object.

Since:
FlexDB 3.0
Version:
$Id: BucketPersist.java,v 1.2 2003/08/11 02:22:44 aleric Exp $

Field Summary
static java.lang.String IDENTIFIER
           
 
Method Summary
 com.flexstor.common.data.ejb.bucket.BucketData getDataObject(com.flexstor.common.keys.ejb.BucketKey key)
          This will get the Data Object based upon key.
 com.flexstor.common.data.ejb.bucket.BucketData getDataObject(int id)
          This will get A Bucket Data object based upon an Identifier.
 com.flexstor.common.keys.ejb.BucketKey insert(com.flexstor.common.data.ejb.bucket.BucketData fieldDat)
          Insert a new bucket column in the bucket table.
 java.util.Vector queryDataObjects(java.lang.String label)
          This will get A list of BucketData objects based on Label.
 void remove(com.flexstor.common.keys.ejb.BucketKey key)
          Remove a Bucket From database Based upon key.
 void update(com.flexstor.common.data.ejb.bucket.BucketData fieldDat)
          This will update a bucket row.
 
Methods inherited from interface com.flexstor.ejb.EjbObject
keepAlive
 
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
 

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER
See Also:
Constant Field Values
Method Detail

getDataObject

public com.flexstor.common.data.ejb.bucket.BucketData getDataObject(int id)
                                                             throws com.flexstor.common.exceptions.ejb.EjbException,
                                                                    java.rmi.RemoteException,
                                                                    com.flexstor.common.exceptions.ejb.NotFoundException
This will get A Bucket Data object based upon an Identifier.

Since:
FlexDB 3.0

queryDataObjects

public java.util.Vector queryDataObjects(java.lang.String label)
                                  throws com.flexstor.common.exceptions.ejb.EjbException,
                                         java.rmi.RemoteException,
                                         com.flexstor.common.exceptions.ejb.NotFoundException
This will get A list of BucketData objects based on Label. This will return a list of close matches. The string should be a partial pattern and then a query will be performed.

Example: queryDataObjects( "Label 1%" );


Will return all names which begin with the pattern.

Example: queryDataObjects( "%Label%" );


Will return all names which contains the pattern.

Since:
FlexDB 3.0

getDataObject

public com.flexstor.common.data.ejb.bucket.BucketData getDataObject(com.flexstor.common.keys.ejb.BucketKey key)
                                                             throws com.flexstor.common.exceptions.ejb.EjbException,
                                                                    java.rmi.RemoteException,
                                                                    com.flexstor.common.exceptions.ejb.NotFoundException
This will get the Data Object based upon key.

Since:
FlexDB 3.0

update

public void update(com.flexstor.common.data.ejb.bucket.BucketData fieldDat)
            throws com.flexstor.common.exceptions.ejb.EjbException,
                   java.rmi.RemoteException
This will update a bucket row. There MUST contain a Database key! If key is null in the dataobject then a RemoteException is thrown!

Also the id needs to be set to the valid id or id will become null.

Since:
FlexDB 3.0

insert

public com.flexstor.common.keys.ejb.BucketKey insert(com.flexstor.common.data.ejb.bucket.BucketData fieldDat)
                                              throws com.flexstor.common.exceptions.ejb.EjbException,
                                                     java.rmi.RemoteException
Insert a new bucket column in the bucket table. This will insert a new field and return a Bucket key.


remove

public void remove(com.flexstor.common.keys.ejb.BucketKey key)
            throws com.flexstor.common.exceptions.ejb.EjbException,
                   java.rmi.RemoteException
Remove a Bucket From database Based upon key. Throws exception if error removing row.