wt.dataops.archivesystem
Interface WTArchiveSystem

All Known Implementing Classes:
CYAArchiveSystem, FileArchiveSystem

public interface WTArchiveSystem



Supported API: false

Extendable: false


Method Summary
 void addClause(String name, String val, WTArchiveSystemInClauseOper oper)
          

Supported API: false
 void addOperator(WTArchiveSystemBetClauseOper op)
          

Supported API: false
 void addType(String typeName)
          

Supported API: false
 boolean connect()
          

Supported API: false
 ArchiveResident createObject(File file, String objName, String aVol, String source, long retentionPeriod)
          

Supported API: false
 ArchiveResident createObject(InputStream is, String objName, String aVol, String source, long retentionPeriod)
          

Supported API: false
 ArchiveResident createObject(String localPath, String objName, String aVol, String source, long retentionPeriod)
          

Supported API: false
 void disconnect()
          

Supported API: false
 ArchiveResident[] executeQuery()
          

Supported API: false
 void finalizeQuery()
          

Supported API: false
 WTArchiveVolume[] getAllVolumes()
          

Supported API: false
 void newQuery(String[] aVols, String[] sources)
          

Supported API: false
 ArchiveResident[] queryObject(Map criteria, String[] aVols, String[] sources)
          

Supported API: false
 ArchiveResident[] queryObject(Map criteria, String[] aVols, String[] sources, WTArchiveSystemInClauseOper operInClause, WTArchiveSystemBetClauseOper operBetClause)
          

Supported API: false
 ArchiveResident[] queryObject(String[] queryTypes, String queryString, String[] aVols, String[] sources)
          

Supported API: false
 boolean removeObject(ArchiveResident arObj)
          

Supported API: false
 boolean removeObject(String objId, String aVol)
          

Supported API: false
 boolean retrieveObject(ArchiveResident arObj, File file)
          

Supported API: false
 boolean retrieveObject(ArchiveResident arObj, OutputStream os)
          

Supported API: false
 boolean retrieveObject(ArchiveResident arObj, String localPath)
          

Supported API: false
 boolean retrieveObject(String objName, String aVol, File file)
          

Supported API: false
 boolean retrieveObject(String objName, String aVol, OutputStream os)
          

Supported API: false
 boolean retrieveObject(String objName, String aVol, String localPath)
          

Supported API: false
 String setRetentionPeriod(String aVol, String[] objName, Date futureDate, String source)
          

Supported API: false
 String setRetentionPeriod(String aVol, String[] objName, long period, String source)
          

Supported API: false
 

Method Detail

connect

public boolean connect()
                throws WTArchiveSystemException


Supported API: false

Returns:
boolean
Throws:
WTArchiveSystemException

disconnect

public void disconnect()
                throws WTArchiveSystemException


Supported API: false

Throws:
WTArchiveSystemException

createObject

public ArchiveResident createObject(String localPath,
                                    String objName,
                                    String aVol,
                                    String source,
                                    long retentionPeriod)
                             throws WTArchiveSystemException


Supported API: false

Parameters:
localPath -
objName -
aVol -
source -
retentionPeriod -
Returns:
ArchiveResident
Throws:
WTArchiveSystemException

createObject

public ArchiveResident createObject(File file,
                                    String objName,
                                    String aVol,
                                    String source,
                                    long retentionPeriod)
                             throws WTArchiveSystemException


Supported API: false

Parameters:
file -
objName -
aVol -
source -
retentionPeriod -
Returns:
ArchiveResident
Throws:
WTArchiveSystemException

createObject

public ArchiveResident createObject(InputStream is,
                                    String objName,
                                    String aVol,
                                    String source,
                                    long retentionPeriod)
                             throws WTArchiveSystemException


Supported API: false

Parameters:
is -
objName -
aVol -
source -
retentionPeriod -
Returns:
ArchiveResident
Throws:
WTArchiveSystemException

retrieveObject

public boolean retrieveObject(String objName,
                              String aVol,
                              String localPath)
                       throws WTArchiveSystemException


Supported API: false

Parameters:
objName -
aVol -
localPath -
Returns:
boolean
Throws:
WTArchiveSystemException

retrieveObject

public boolean retrieveObject(String objName,
                              String aVol,
                              File file)
                       throws WTArchiveSystemException


Supported API: false

Parameters:
objName -
aVol -
file -
Returns:
boolean
Throws:
WTArchiveSystemException

retrieveObject

public boolean retrieveObject(String objName,
                              String aVol,
                              OutputStream os)
                       throws WTArchiveSystemException


Supported API: false

Parameters:
objName -
aVol -
os -
Returns:
boolean
Throws:
WTArchiveSystemException

queryObject

public ArchiveResident[] queryObject(Map criteria,
                                     String[] aVols,
                                     String[] sources)
                              throws WTArchiveSystemException


Supported API: false

Parameters:
criteria -
aVols -
sources -
Returns:
ArchiveResident[]
Throws:
WTArchiveSystemException

queryObject

public ArchiveResident[] queryObject(Map criteria,
                                     String[] aVols,
                                     String[] sources,
                                     WTArchiveSystemInClauseOper operInClause,
                                     WTArchiveSystemBetClauseOper operBetClause)
                              throws WTArchiveSystemException


Supported API: false

Parameters:
criteria -
aVols -
sources -
operInClause -
operBetClause -
Returns:
ArchiveResident[]
Throws:
WTArchiveSystemException

queryObject

public ArchiveResident[] queryObject(String[] queryTypes,
                                     String queryString,
                                     String[] aVols,
                                     String[] sources)
                              throws WTArchiveSystemException


Supported API: false

Parameters:
queryTypes -
queryString -
aVols -
sources -
Returns:
ArchiveResident[]
Throws:
WTArchiveSystemException

newQuery

public void newQuery(String[] aVols,
                     String[] sources)
              throws WTArchiveSystemException


Supported API: false

Parameters:
aVols -
sources -
Throws:
WTArchiveSystemException

addOperator

public void addOperator(WTArchiveSystemBetClauseOper op)
                 throws WTArchiveSystemException


Supported API: false

Parameters:
op -
Throws:
WTArchiveSystemException

addClause

public void addClause(String name,
                      String val,
                      WTArchiveSystemInClauseOper oper)
               throws WTArchiveSystemException


Supported API: false

Parameters:
name -
val -
oper -
Throws:
WTArchiveSystemException

finalizeQuery

public void finalizeQuery()
                   throws WTArchiveSystemException


Supported API: false

Throws:
WTArchiveSystemException

executeQuery

public ArchiveResident[] executeQuery()
                               throws WTArchiveSystemException


Supported API: false

Returns:
ArchiveResident[]
Throws:
WTArchiveSystemException

setRetentionPeriod

public String setRetentionPeriod(String aVol,
                                 String[] objName,
                                 long period,
                                 String source)
                          throws WTArchiveSystemException


Supported API: false

Parameters:
aVol -
objName -
period -
source -
Returns:
String
Throws:
WTArchiveSystemException

setRetentionPeriod

public String setRetentionPeriod(String aVol,
                                 String[] objName,
                                 Date futureDate,
                                 String source)
                          throws WTArchiveSystemException


Supported API: false

Parameters:
aVol -
objName -
futureDate -
source -
Returns:
String
Throws:
WTArchiveSystemException

getAllVolumes

public WTArchiveVolume[] getAllVolumes()
                                throws WTArchiveSystemException


Supported API: false

Returns:
WTArchiveVolume[]
Throws:
WTArchiveSystemException

removeObject

public boolean removeObject(String objId,
                            String aVol)
                     throws WTArchiveSystemException


Supported API: false

Parameters:
objId -
aVol -
Returns:
boolean
Throws:
WTArchiveSystemException

retrieveObject

public boolean retrieveObject(ArchiveResident arObj,
                              String localPath)
                       throws WTArchiveSystemException


Supported API: false

Parameters:
arObj -
localPath -
Returns:
boolean
Throws:
WTArchiveSystemException

removeObject

public boolean removeObject(ArchiveResident arObj)
                     throws WTArchiveSystemException


Supported API: false

Parameters:
arObj -
Returns:
boolean
Throws:
WTArchiveSystemException

retrieveObject

public boolean retrieveObject(ArchiveResident arObj,
                              File file)
                       throws WTArchiveSystemException


Supported API: false

Parameters:
arObj -
file -
Returns:
boolean
Throws:
WTArchiveSystemException

retrieveObject

public boolean retrieveObject(ArchiveResident arObj,
                              OutputStream os)
                       throws WTArchiveSystemException


Supported API: false

Parameters:
arObj -
os -
Returns:
boolean
Throws:
WTArchiveSystemException

addType

public void addType(String typeName)
             throws WTArchiveSystemException


Supported API: false

Parameters:
typeName -
Throws:
WTArchiveSystemException