be.SIRAPRISE.client.jsba

Class Key

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.Key

All Implemented Interfaces:

DBObject, UpdatableDBObject

@Relvars(relvarNames="KEY")
public final class Key
extends AbstractUpdatableDBObject

Author:

Erwin

Constructor Summary

Constructors

Constructor and Description
Key() Creates the Key
Key(java.lang.String relvarName, long errorCode) Creates the Key

Method Summary

Modifier and Type	Method and Description
long	getErrorCode() Gets errorCode
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 errorCode
void	setErrorCode(ValueBuffer errorCode) Sets errorCode
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	setRelvarName(ValueBuffer relvarName) Sets relvarName

Methods inherited from class be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

dbUpdateCommand, 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

@GetterMethod(attributeDefs=@AttributeDef(attributeName="ERRORCODE",requiresEscaping=false,typeName="LONG"),
              relvarNames="KEY")
public final long getErrorCode()

Gets errorCode

Returns:

errorCode.

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.

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

@GetterMethod(attributeDefs=@AttributeDef(attributeName="RELVARNAME",requiresEscaping=false,typeName="NAME"),
              relvarNames="KEY")
public final java.lang.String getRelvarName()

Gets relvarName

Returns:

relvarName.

setErrorCode

public final void setErrorCode(long errorCode)

Sets errorCode

Parameters:

errorCode - The errorCode to set.

setErrorCode

@AttributeDef(attributeName="ERRORCODE",
              requiresEscaping=false,
              typeName="LONG")
public final void setErrorCode(ValueBuffer errorCode)

Sets errorCode

Parameters:

errorCode - The errorCode to set.

setPreUpdateState

public final 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.

setRelvarName

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

Sets relvarName

Parameters:

relvarName - The relvarName to set.

setRelvarName

@AttributeDef(attributeName="RELVARNAME",
              requiresEscaping=false,
              typeName="NAME")
public final void setRelvarName(ValueBuffer relvarName)

Sets relvarName

Parameters:

relvarName - The relvarName to set.