be.SIRAPRISE.client.jsba

Class ConstrainedType

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.ConstrainedType

All Implemented Interfaces:

DBObject, UpdatableDBObject

@Relvars(relvarNames="CONSTRAINEDTYPE")
public final class ConstrainedType
extends AbstractUpdatableDBObject

Author:

Erwin Smout

Constructor Summary

Constructors

Constructor and Description
ConstrainedType() Creates an empty ConstrainedType
ConstrainedType(java.lang.String typeName, java.lang.String baseTypeName, java.lang.String expression) Creates the ConstrainedType

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseTypeName() Gets The base type's name
java.lang.String	getExpressionText() Gets The constraint expression
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	getTypeName() Gets The type name
void	setBaseTypeName(java.lang.String baseTypeName) Sets The base type's name
void	setBaseTypeName(ValueBuffer baseTypeName) Sets The base type's name
void	setExpressionText(java.lang.String expressionText) Sets The constraint expression
void	setExpressionText(ValueBuffer expressionText) Sets The constraint expression
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	setTypeName(java.lang.String typeName) Sets The type name
void	setTypeName(ValueBuffer typeName) Sets The type name

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

ConstrainedType

public ConstrainedType()

Creates an empty ConstrainedType

ConstrainedType

public ConstrainedType(java.lang.String typeName,
                       java.lang.String baseTypeName,
                       java.lang.String expression)

Creates the ConstrainedType

Parameters:

typeName - The type name

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

expression - The file name

Method Detail

getBaseTypeName

@GetterMethod(attributeDefs=@AttributeDef(attributeName="BASETYPE",requiresEscaping=false,typeName="NAME"),
              relvarNames="CONSTRAINEDTYPE")
public final java.lang.String getBaseTypeName()

Gets The base type's name

Returns:

The base type's name

getExpressionText

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

Gets The constraint expression

Returns:

The constraint expression.

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.

getTypeName

@GetterMethod(attributeDefs=@AttributeDef(attributeName="TYPENAME",requiresEscaping=false,typeName="NAME"),
              relvarNames="CONSTRAINEDTYPE")
public final java.lang.String getTypeName()

Gets The type name

Returns:

The type name.

setBaseTypeName

public final void setBaseTypeName(java.lang.String baseTypeName)

Sets The base type's name

Parameters:

baseTypeName - The baseTypeName to set.

setBaseTypeName

@AttributeDef(attributeName="BASETYPE",
              requiresEscaping=false,
              typeName="NAME")
public void setBaseTypeName(ValueBuffer baseTypeName)

Sets The base type's name

Parameters:

baseTypeName - The baseTypeName to set.

setExpressionText

public final void setExpressionText(java.lang.String expressionText)

Sets The constraint expression

Parameters:

expressionText - The expression to set.

setExpressionText

@AttributeDef(attributeName="SP_EXPRESSION",
              requiresEscaping=true,
              typeName="STRING")
public void setExpressionText(ValueBuffer expressionText)

Sets The constraint expression

Parameters:

expressionText - The expression 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.

setTypeName

public final void setTypeName(java.lang.String typeName)

Sets The type name

Parameters:

typeName - The typeName to set.

setTypeName

@AttributeDef(attributeName="TYPENAME",
              requiresEscaping=false,
              typeName="NAME")
public void setTypeName(ValueBuffer typeName)

Sets The type name

Parameters:

typeName - The typeName to set.