be.SIRAPRISE.client.jsba

Class AssignmentConstraint

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.AssignmentConstraint

All Implemented Interfaces:

DBObject, UpdatableDBObject

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

Author:

Erwin Smout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConstraintExpressionText() Gets The constraint expression
java.lang.String	getConstraintLabel() Gets The constraint label
java.lang.String	getConstraintMessageText() Gets The corresponding constraint message text, if any
long	getErrorCode()
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 The constraint expression
void	setConstraintExpressionText(ValueBuffer constraintExpressionText) Sets The constraint expression
void	setConstraintLabel(java.lang.String constraintLabel) Sets The constraint label
void	setConstraintLabel(ValueBuffer constraintLabel) Sets The constraint label
void	setConstraintMessageText(java.lang.String constraintMessageText) Sets The corresponding constraint message text, if any
void	setConstraintMessageText(ValueBuffer constraintMessageText) Sets The corresponding constraint message text, if any
void	setErrorCode(long errorCode)
void	setErrorCode(ValueBuffer 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[]	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

AssignmentConstraint

public AssignmentConstraint()

Creates the AssignmentConstraint

AssignmentConstraint

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

Creates the AssignmentConstraint

Parameters:

constraintExpressionText - The constraint expression

errorCode - The page size

constraintLabel - The constraint label

AssignmentConstraint

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

Creates the AssignmentConstraint

Parameters:

constraintExpressionText - The file name

errorCode - The page size

constraintLabel - The constraint label

constraintMessageText - The constraint message text to be displayed in the event of violations

Method Detail

getConstraintExpressionText

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

Gets The constraint expression

Returns:

The constraint expression.

getConstraintLabel

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

Gets The constraint label

Returns:

The constraint label.

getConstraintMessageText

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

Gets The corresponding constraint message text, if any

Returns:

The corresponding constraint message text, if any

getErrorCode

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

Returns:

Returns the 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.

setConstraintExpressionText

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

Sets The constraint expression

Parameters:

constraintExpressionText - The constraintExpression to set.

setConstraintExpressionText

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

Sets The constraint expression

Parameters:

constraintExpressionText - The constraintExpression to set.

setConstraintLabel

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

Sets The constraint label

Parameters:

constraintLabel - The constraintLabel to set.

setConstraintLabel

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

Sets The constraint label

Parameters:

constraintLabel - The constraintLabel to set.

setConstraintMessageText

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

Sets The corresponding constraint message text, if any

Parameters:

constraintMessageText - The constraintMessageText to set.

setConstraintMessageText

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

Sets The corresponding constraint message text, if any

Parameters:

constraintMessageText - The constraintMessageText to set.

setErrorCode

public final void setErrorCode(long errorCode)

Parameters:

errorCode - The errorCode to set.

setErrorCode

@AttributeDef(attributeName="ERRORCODE",
              requiresEscaping=false,
              typeName="LONG")
public final void setErrorCode(ValueBuffer 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.

smartUpdateCommand

public 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