be.SIRAPRISE.client.jsba

Class DatabaseConstraint

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.DatabaseConstraint

All Implemented Interfaces:

DBObject, UpdatableDBObject

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

Author:

Erwin

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConstraintExpressionText() Gets expression
java.lang.String	getConstraintLabel() Gets label
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.
void	setConstraintExpressionText(java.lang.String constraintExpressionText) Sets expression
void	setConstraintExpressionText(ValueBuffer constraintExpressionText) Sets expression
void	setConstraintLabel(java.lang.String constraintLabel) Sets label
void	setConstraintLabel(ValueBuffer constraintLabel) Sets label
void	setConstraintMessageText(java.lang.String constraintMessageText) Sets messageText
void	setConstraintMessageText(ValueBuffer constraintMessageText) Sets messageText
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.
DmlAssignmentCommand	smartUpdateComand() 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

DatabaseConstraint

public DatabaseConstraint()

Creates the DatabaseConstraint

DatabaseConstraint

public DatabaseConstraint(long errorCode,
                          java.lang.String constraintExpressionText,
                          java.lang.String constraintLabel,
                          java.lang.String constraintMessageText)

Creates the DatabaseConstraint

Parameters:

errorCode - -

constraintExpressionText - -

constraintLabel - -

constraintMessageText - the corresponding messagetext to be generated upon violations of the constraint. null or a dash ("-") means "none".

Method Detail

getConstraintExpressionText

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

Gets expression

Returns:

expression.

getConstraintLabel

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

Gets label

Returns:

label.

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="DATABASECONSTRAINT")
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.

setConstraintExpressionText

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

Sets expression

Parameters:

constraintExpressionText - The expression to set.

setConstraintExpressionText

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

Sets expression

Parameters:

constraintExpressionText - The expression to set.

setConstraintLabel

public final void setConstraintLabel(java.lang.String constraintLabel)

Sets label

Parameters:

constraintLabel - The label to set.

setConstraintLabel

@AttributeDef(attributeName="CONSTRAINTLABEL",
              requiresEscaping=true,
              typeName="STRING")
public final void setConstraintLabel(ValueBuffer constraintLabel)

Sets label

Parameters:

constraintLabel - The label to set.

setConstraintMessageText

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

Sets messageText

Parameters:

constraintMessageText - The corresponding messagetext to be generated upon violations of the constraint. null or a dash ("-") means "none".

setConstraintMessageText

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

Sets messageText

Parameters:

constraintMessageText - The corresponding messagetext to be generated upon violations of the constraint. null or a dash ("-") means "none".

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.

smartUpdateComand

public DmlAssignmentCommand smartUpdateComand()
                                       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 DATABASECONSTRAINT 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