be.SIRAPRISE.client.jsba

Class KeyAttribute

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.KeyAttribute

All Implemented Interfaces:

DBObject, UpdatableDBObject

@Relvars(relvarNames="KEYATTRIBUTE")
public final class KeyAttribute
extends AbstractUpdatableDBObject

Author:

Erwin

Constructor Summary

Constructors

Constructor and Description
KeyAttribute() Creates the KeyAttribute
KeyAttribute(long errorCode, java.lang.String attributeName) Creates the KeyAttribute

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeName() Gets attributeName
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.
void	setAttributeName(java.lang.String attributeName) Sets attributeName
void	setAttributeName(ValueBuffer attributeName) Sets attributeName
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.

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

KeyAttribute

public KeyAttribute()

Creates the KeyAttribute

KeyAttribute

public KeyAttribute(long errorCode,
                    java.lang.String attributeName)

Creates the KeyAttribute

Parameters:

errorCode - -

attributeName - -

Method Detail

getAttributeName

@GetterMethod(attributeDefs=@AttributeDef(attributeName="ATTRIBUTENAME",requiresEscaping=false,typeName="NAME"),
              relvarNames="KEYATTRIBUTE")
public final java.lang.String getAttributeName()

Gets attributeName

Returns:

attributeName.

getErrorCode

@GetterMethod(attributeDefs=@AttributeDef(attributeName="ERRORCODE",requiresEscaping=false,typeName="LONG"),
              relvarNames="KEYATTRIBUTE")
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.

setAttributeName

public final void setAttributeName(java.lang.String attributeName)

Sets attributeName

Parameters:

attributeName - The attributeName to set.

setAttributeName

@AttributeDef(attributeName="ATTRIBUTENAME",
              requiresEscaping=false,
              typeName="NAME")
public final void setAttributeName(ValueBuffer attributeName)

Sets attributeName

Parameters:

attributeName - The attributeName to set.

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.