Package edm.edom3

Interface EDMCheckout

All Superinterfaces:

EDMContextDependent, EDMDownload, EDMWorker

public interface EDMCheckout
extends EDMDownload

/** Worker that offers the checkout operation. Refer to the EDMassist documentation for an explanation of checkout.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDatasetName()	Retrieve the dataset name for this checkout/checkin
long	getLockProtection()	Retrieve the assigned lock protection for this checkout
java.lang.String	getMethodName()	Retrieve the checkout/checkin method name for this checkout/checkin
void	setDatasetName(java.lang.String s)	Set dataset name for this checkout/checkin
void	setLockProtection(long s)	Set lock protection for this checkout/checkin
void	setMethodName(java.lang.String s)	Set method name for this checkout/checkin

Methods inherited from interface edm.edom3.EDMContextDependent

getContext

Methods inherited from interface edm.edom3.EDMDownload

getSchemaName, getShortNameFile, setFilterBuffer, setSchemaName, setShortNameFile, setStringEncodingCode

Methods inherited from interface edm.edom3.EDMWorker

execute, getConfiguration, getFileMappings, getFormalParameters, getHitsOut, getIndexOut, getLogDescription, getOptions, getParameters, getResult, getSource, getTarget, resetOptions, setConfiguration, setFileMappings, setOptions, setParameters, setSource, setSystemOutput, setSystemOutput, setTarget, setUserOutput, setUserOutput

Method Detail

getDatasetName

java.lang.String getDatasetName()
                         throws EdmiException

Retrieve the dataset name for this checkout/checkin

Returns:

dataset name, null if not set

Throws:

EdmiException - if the method fails

setDatasetName

void setDatasetName(java.lang.String s)
             throws EdmiException

Set dataset name for this checkout/checkin

Parameters:

s - dataset name, null to unset

Throws:

EdmiException - if the method fails

getMethodName

java.lang.String getMethodName()
                        throws EdmiException

Retrieve the checkout/checkin method name for this checkout/checkin

Returns:

method name, null if not set

Throws:

EdmiException - if the method fails

setMethodName

void setMethodName(java.lang.String s)
            throws EdmiException

Set method name for this checkout/checkin

Parameters:

s - method name, null to unset

Throws:

EdmiException - if the method fails

getLockProtection

long getLockProtection()
                throws EdmiException

Retrieve the assigned lock protection for this checkout

Returns:

assigned lock protection

Throws:

EdmiException - if the method fails

setLockProtection

void setLockProtection(long s)
                throws EdmiException

Set lock protection for this checkout/checkin

Parameters:

s - method name, null to unset

Throws:

EdmiException - if the method fails