Enhydra 5.1 API

org.webdocwf.util.genericstore.data
Interface EnumValueDefinitionDOI

All Known Implementing Classes:
EnumValueDefinitionDO

public interface EnumValueDefinitionDOI

Interface implemented by EnumValueDefinitionDO. Interface could also be implemented by a (hand-written) Business Layer class which uses EnumValueDefinitionDO.

Since:
org
Version:
$Revision: 1.2 $
Author:
administrator

Method Summary
 void commit()
          Deprecated. Use save() instead.
 void commit(DBTransaction dbt)
          Deprecated. Use save() instead.
 void delete()
          Deletes the DO from its table.
 void delete(DBTransaction dbt)
          Deletes the DO from its table.
 boolean getBEGINSTATE()
          Get BEGINSTATE of the GENERICENUMVALUEDEFINITION
 boolean getENDSTATE()
          Get ENDSTATE of the GENERICENUMVALUEDEFINITION
 EnumTypeDefinitionDO getENUMTYPEDEFINITIONOID()
          Get ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION
 java.lang.String getKEYVALUE()
          Get KEYVALUE of the GENERICENUMVALUEDEFINITION
 java.lang.String getLONGNAME()
          Get LONGNAME of the GENERICENUMVALUEDEFINITION
 java.lang.String getSHORTNAME()
          Get SHORTNAME of the GENERICENUMVALUEDEFINITION
 java.lang.String getXMLNAME()
          Get XMLNAME of the GENERICENUMVALUEDEFINITION
 void save()
          Inserts/Updates the DO into its table.
 void save(DBTransaction dbt)
          Inserts/Updates the DO into its table.
 void setBEGINSTATE(boolean BEGINSTATE)
          Set BEGINSTATE of the GENERICENUMVALUEDEFINITION
 void setENDSTATE(boolean ENDSTATE)
          Set ENDSTATE of the GENERICENUMVALUEDEFINITION
 void setENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO ENUMTYPEDEFINITIONOID)
          Set ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION
 void setKEYVALUE(java.lang.String KEYVALUE)
          Set KEYVALUE of the GENERICENUMVALUEDEFINITION
 void setLONGNAME(java.lang.String LONGNAME)
          Set LONGNAME of the GENERICENUMVALUEDEFINITION
 void setSHORTNAME(java.lang.String SHORTNAME)
          Set SHORTNAME of the GENERICENUMVALUEDEFINITION
 void setXMLNAME(java.lang.String XMLNAME)
          Set XMLNAME of the GENERICENUMVALUEDEFINITION
 

Method Detail

getENUMTYPEDEFINITIONOID

public EnumTypeDefinitionDO getENUMTYPEDEFINITIONOID()
                                              throws DataObjectException
Get ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION

Returns:
ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

setENUMTYPEDEFINITIONOID

public void setENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO ENUMTYPEDEFINITIONOID)
                              throws DataObjectException
Set ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION

Parameters:
ENUMTYPEDEFINITIONOID - of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

getBEGINSTATE

public boolean getBEGINSTATE()
                      throws DataObjectException
Get BEGINSTATE of the GENERICENUMVALUEDEFINITION

Returns:
BEGINSTATE of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

setBEGINSTATE

public void setBEGINSTATE(boolean BEGINSTATE)
                   throws DataObjectException
Set BEGINSTATE of the GENERICENUMVALUEDEFINITION

Parameters:
BEGINSTATE - of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

getENDSTATE

public boolean getENDSTATE()
                    throws DataObjectException
Get ENDSTATE of the GENERICENUMVALUEDEFINITION

Returns:
ENDSTATE of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

setENDSTATE

public void setENDSTATE(boolean ENDSTATE)
                 throws DataObjectException
Set ENDSTATE of the GENERICENUMVALUEDEFINITION

Parameters:
ENDSTATE - of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

getLONGNAME

public java.lang.String getLONGNAME()
                             throws DataObjectException
Get LONGNAME of the GENERICENUMVALUEDEFINITION

Returns:
LONGNAME of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

setLONGNAME

public void setLONGNAME(java.lang.String LONGNAME)
                 throws DataObjectException
Set LONGNAME of the GENERICENUMVALUEDEFINITION

Parameters:
LONGNAME - of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

getSHORTNAME

public java.lang.String getSHORTNAME()
                              throws DataObjectException
Get SHORTNAME of the GENERICENUMVALUEDEFINITION

Returns:
SHORTNAME of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

setSHORTNAME

public void setSHORTNAME(java.lang.String SHORTNAME)
                  throws DataObjectException
Set SHORTNAME of the GENERICENUMVALUEDEFINITION

Parameters:
SHORTNAME - of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

getKEYVALUE

public java.lang.String getKEYVALUE()
                             throws DataObjectException
Get KEYVALUE of the GENERICENUMVALUEDEFINITION

Returns:
KEYVALUE of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

setKEYVALUE

public void setKEYVALUE(java.lang.String KEYVALUE)
                 throws DataObjectException
Set KEYVALUE of the GENERICENUMVALUEDEFINITION

Parameters:
KEYVALUE - of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

getXMLNAME

public java.lang.String getXMLNAME()
                            throws DataObjectException
Get XMLNAME of the GENERICENUMVALUEDEFINITION

Returns:
XMLNAME of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

setXMLNAME

public void setXMLNAME(java.lang.String XMLNAME)
                throws DataObjectException
Set XMLNAME of the GENERICENUMVALUEDEFINITION

Parameters:
XMLNAME - of the GENERICENUMVALUEDEFINITION
Throws:
DataObjectException - If the object is not found in the database.

save

public void save()
          throws java.sql.SQLException,
                 DatabaseManagerException,
                 DataObjectException,
                 RefAssertionException,
                 DBRowUpdateException,
                 QueryException
Inserts/Updates the DO into its table.

Throws:
DatabaseManagerException - if a Transaction can not be created.
RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
DataObjectException
DBRowUpdateException
QueryException

save

public void save(DBTransaction dbt)
          throws java.sql.SQLException,
                 DatabaseManagerException,
                 DataObjectException,
                 RefAssertionException,
                 DBRowUpdateException,
                 QueryException
Inserts/Updates the DO into its table. The transaction is likely provided by the save() method of another DO which references this DO.

Parameters:
dbt - The transaction object to use for this operation.
Throws:
DatabaseManagerException - if a Transaction can not be created.
DBRowUpdateException - if a version error occurs.
RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
DataObjectException
QueryException

commit

public void commit()
            throws java.sql.SQLException,
                   DatabaseManagerException,
                   DataObjectException,
                   RefAssertionException,
                   DBRowUpdateException,
                   QueryException
Deprecated. Use save() instead.

Inserts/Updates the DO into its table.

Throws:
DatabaseManagerException - if a Transaction can not be created.
RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
DataObjectException
DBRowUpdateException
QueryException

commit

public void commit(DBTransaction dbt)
            throws java.sql.SQLException,
                   DatabaseManagerException,
                   DataObjectException,
                   RefAssertionException,
                   DBRowUpdateException,
                   QueryException
Deprecated. Use save() instead.

Inserts/Updates the DO into its table. The transaction is likely provided by the commit() method of another DO which references this DO.

Parameters:
dbt - The transaction object to use for this operation.
Throws:
DatabaseManagerException - if a Transaction can not be created.
DBRowUpdateException - if a version error occurs.
RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
DataObjectException
QueryException

delete

public void delete()
            throws java.sql.SQLException,
                   DatabaseManagerException,
                   DataObjectException,
                   RefAssertionException,
                   DBRowUpdateException,
                   QueryException
Deletes the DO from its table.

Throws:
DatabaseManagerException - if a Transaction can not be created.
RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
DataObjectException
DBRowUpdateException
QueryException

delete

public void delete(DBTransaction dbt)
            throws java.sql.SQLException,
                   DatabaseManagerException,
                   DataObjectException,
                   RefAssertionException,
                   DBRowUpdateException,
                   QueryException
Deletes the DO from its table. The transaction is likely provided by the delete() method of another DO which references this DO.

Parameters:
dbt - The transaction object to use for this operation.
Throws:
DatabaseManagerException - if a Transaction can not be created.
DBRowUpdateException - if a version error occurs.
RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
DataObjectException
QueryException

Enhydra 5.1 API