Package edm.edom3

Interface EDMCheckin

All Superinterfaces:

EDMContextDependent, EDMUpload, EDMWorker

public interface EDMCheckin
extends EDMUpload

Worker that offers the checkin operation. Refer to the EDMassist documentation for an explanation of checkin.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDatasetName()	Retrieve the dataset name for this checkout/checkin
java.lang.String	getMethodName()	Retrieve the checkout/checkin method name for this checkout/checkin
java.lang.String	getNewModelVersionName()	Retrieve the assigned new model version name for this checkin
void	setDatasetName(java.lang.String s)	Set dataset name for this checkout/checkin
void	setMethodName(java.lang.String s)	Set method name for this checkout/checkin
void	setNewModelVersionName(java.lang.String s)	Assign new model version name for this checkin

Methods inherited from interface edm.edom3.EDMContextDependent

getContext

Methods inherited from interface edm.edom3.EDMUpload

getSchemaName, getShortNameFile, setSchemaName, setShortNameFile

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

getNewModelVersionName

java.lang.String getNewModelVersionName()
                                 throws EdmiException

Retrieve the assigned new model version name for this checkin

Returns:

version name, null if not set

Throws:

EdmiException - if the method fails

setNewModelVersionName

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

Assign new model version name for this checkin

Parameters:

s - dataset name, null to unset (cancel new version)

Throws:

EdmiException - if the method fails