be.SIRAPRISE.client.jsba

Class TupleConstraint

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.TupleConstraint

All Implemented Interfaces:

DBObject, UpdatableDBObject

@Relvars(relvarNames={"TUPLECONSTRAINT","CONSTRAINTMESSAGETEXT"})
public final class TupleConstraint
extends AbstractUpdatableDBObject

Author:

Erwin

Constructor Summary

Constructors

Constructor and Description
TupleConstraint() Creates the TupleConstraint
TupleConstraint(java.lang.String relvarName, long errorCode, java.lang.String constraintExpressionText, java.lang.String constraintMessageText) Creates the TupleConstraint

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConstraintExpressionText() Gets constraintExpression
java.lang.String	getConstraintMessageText() Gets messageText
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	setConstraintExpressionText(java.lang.String constraintExpressionText) Sets constraintExpression
void	setConstraintExpressionText(ValueBuffer constraintExpressionText) Sets constraintExpression
void	setConstraintMessageText(java.lang.String constraintMessageText) Sets messageText
void	setConstraintMessageText(ValueBuffer constraintMessageText) Sets constraintMessageText
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
DmlAssignmentCommand[]	smartUpdateCommand() Gets a "smart" update command that brings the catalog from the state reflected in preUpdateState, to the current state.

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

TupleConstraint

public TupleConstraint()

Creates the TupleConstraint

TupleConstraint

public TupleConstraint(java.lang.String relvarName,
                       long errorCode,
                       java.lang.String constraintExpressionText,
                       java.lang.String constraintMessageText)

Creates the TupleConstraint

Parameters:

relvarName - -

errorCode - -

constraintExpressionText - -

constraintMessageText - -

Method Detail

getConstraintExpressionText

@GetterMethod(attributeDefs=@AttributeDef(attributeName="SP_EXPRESSION",requiresEscaping=true,typeName="STRING"),
              relvarNames="TUPLECONSTRAINT")
public final java.lang.String getConstraintExpressionText()

Gets constraintExpression

Returns:

constraintExpression.

getConstraintMessageText

@GetterMethod(attributeDefs=@AttributeDef(attributeName="CONSTRAINTMESSAGETEXT",requiresEscaping=true,typeName="STRING"),
              relvarNames="CONSTRAINTMESSAGETEXT")
public final java.lang.String getConstraintMessageText()

Gets messageText

Returns:

messageText.

getErrorCode

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

Gets errorCode

Returns:

errorCode.

getPreUpdateState

public final 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="TUPLECONSTRAINT")
public final java.lang.String getRelvarName()

Gets relvarName

Returns:

relvarName.

setConstraintExpressionText

public final void setConstraintExpressionText(java.lang.String constraintExpressionText)

Sets constraintExpression

Parameters:

constraintExpressionText - The constraintExpression to set.

setConstraintExpressionText

@AttributeDef(attributeName="SP_EXPRESSION",
              requiresEscaping=true,
              typeName="STRING")
public final void setConstraintExpressionText(ValueBuffer constraintExpressionText)

Sets constraintExpression

Parameters:

constraintExpressionText - The constraintExpression to set.

setConstraintMessageText

public final void setConstraintMessageText(java.lang.String constraintMessageText)

Sets messageText

Parameters:

constraintMessageText - The messageText to set.

setConstraintMessageText

@AttributeDef(attributeName="CONSTRAINTMESSAGETEXT",
              requiresEscaping=true,
              typeName="STRING")
public final void setConstraintMessageText(ValueBuffer constraintMessageText)

Sets constraintMessageText

Parameters:

constraintMessageText - The constraintMessageText 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.

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.

smartUpdateCommand

public final DmlAssignmentCommand[] smartUpdateCommand()
                                                throws NoUpdatesException

Gets a "smart" update command that brings the catalog from the state reflected in preUpdateState, to the current state. The "smart" update command consists of :

• optionally (if and only if any changes were applied to the error code or constraintexpression attributes), an update command for the TUPLECONSTRAINT relvar.
• optionally (if and only if any changes were applied to the error code or constraint message text), one of the following to update the CONSTRAINTMESSAGETEXT relvar :
  • a DELETE if the preUpdateState message text was non-null and non-empty, but the new message text is null or the empty string.
  • a INSERT if the preUpdateState message text was null or empty, but the new message text is non-null and a non-empty string.
  • an UPDATE if the preUpdateState message text was non-null and non-empty, and the new message text is non-null and a non-empty string, and it is the case that either the message text or the error code has changed.

Returns:

a "smart" update command that brings the catalog from the state reflected in preUpdateState, to the current state.

Throws:

NoUpdatesException - If there are no differences between the pre-update and the current state