be.SIRAPRISE.client.jsba
Class Key

java.lang.Object
  extended by be.SIRAPRISE.client.jsba.AbstractDBObject
      extended by be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject
          extended by be.SIRAPRISE.client.jsba.Key
All Implemented Interfaces:
DBObject, DBObjectToKey, KeyToDBObject, UpdatableDBObject

public final class Key
extends AbstractUpdatableDBObject
implements DBObjectToKey, KeyToDBObject

Author:
Erwin

Constructor Summary
Key()
          Creates the Key
Key(java.lang.String relvarName, long errorCode)
          Creates the Key
 
Method Summary
 long getErrorCode()
          Gets keyID
 java.lang.String getKeyErrorcode()
          Gets the keyid for key
 java.lang.String getKeyRelvarname()
          Gets the relvarname for key
 UpdatableDBObject getPreUpdateState()
          Gets The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.
 java.lang.String getRelvarName()
          Gets relvarName
 void setErrorCode(long errorCode)
          Sets keyID
 void setErrorcodeFromDB(java.lang.String errorCode)
          Sets keyid from the DB
 void setPreUpdateState()
          This method is called by the J/R bridging engine after an object has been setup from some tuple retrieved from the database.
 void setRelvarName(java.lang.String relvarName)
          Sets relvarName
 void setRelvarnameFromDB(java.lang.String relvarname)
          Sets relvarname from the DB
 
Methods inherited from class be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject
dbUpdateCommand, dbUpdateCommand
 
Methods inherited from class be.SIRAPRISE.client.jsba.AbstractDBObject
dbAddCommand, dbAddCommand, dbAddCommand, dbAddCommandAll, dbAssertCommand, dbAssertCommand, dbAssertCommand, dbAssertCommandAll, dbDeleteCommand, dbDeleteCommand, dbDeleteCommand, dbDeleteCommandAll, dbUnAssertCommand, dbUnAssertCommand, dbUnAssertCommand, dbUnAssertCommandAll
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Key

public Key()
Creates the Key


Key

public Key(java.lang.String relvarName,
           long errorCode)
Creates the Key

Parameters:
relvarName -
errorCode -
Method Detail

getErrorCode

public final long getErrorCode()
Gets keyID

Returns:
keyID.

getKeyErrorcode

public java.lang.String getKeyErrorcode()
Description copied from interface: DBObjectToKey
Gets the keyid for key

Specified by:
getKeyErrorcode in interface DBObjectToKey
Returns:
The keyid for key

getKeyRelvarname

public java.lang.String getKeyRelvarname()
Description copied from interface: DBObjectToKey
Gets the relvarname for key

Specified by:
getKeyRelvarname in interface DBObjectToKey
Returns:
The relvarname for key

getPreUpdateState

public UpdatableDBObject getPreUpdateState()
Description copied from interface: UpdatableDBObject
Gets The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.

Specified by:
getPreUpdateState in interface UpdatableDBObject
Returns:
The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.

getRelvarName

public final java.lang.String getRelvarName()
Gets relvarName

Returns:
relvarName.

setErrorCode

public final void setErrorCode(long errorCode)
Sets keyID

Parameters:
errorCode - The keyID to set.

setErrorcodeFromDB

public void setErrorcodeFromDB(java.lang.String errorCode)
Description copied from interface: KeyToDBObject
Sets keyid from the DB

Specified by:
setErrorcodeFromDB in interface KeyToDBObject
Parameters:
errorCode - The DB value for keyid

setPreUpdateState

public void setPreUpdateState()
Description copied from interface: UpdatableDBObject
This method is called by the J/R bridging engine after an object has been setup from some tuple retrieved from the database. The method must cause the object to save a copy (/clone) of all the fields that are pertinent to the database. This copy will be retrieved by the J/R bridging engine using the getPreUpdateState() method call, and will subsequently be used by the J/R bridging engine to determine which fields have changed value, and thus to determine which attributes need to be updated in the database.

Specified by:
setPreUpdateState in interface UpdatableDBObject

setRelvarName

public final void setRelvarName(java.lang.String relvarName)
Sets relvarName

Parameters:
relvarName - The relvarName to set.

setRelvarnameFromDB

public void setRelvarnameFromDB(java.lang.String relvarname)
Description copied from interface: KeyToDBObject
Sets relvarname from the DB

Specified by:
setRelvarnameFromDB in interface KeyToDBObject
Parameters:
relvarname - The DB value for relvarname