planetj.database.field
Interface IFieldIncrementor

All Known Implementing Classes:

FieldIncrementor

public interface IFieldIncrementor

Insert the type's description here. Creation date: (2/5/2003 11:51:02 AM)

Method Summary

void	clearValue(Field field) Clears the incrementors value.
java.lang.Object	getNextValue(Field pField) Gets the next value of a field for which the auto-increment value is true.
java.lang.Object	getNextValue(FieldDescriptorRow pFD) Gets the next value of a field for which the auto-increment value is true.
java.lang.Object	getNextValue(FieldDescriptorRow pFD, Table pTable) Gets the next value of a field for which the auto-increment value is true.
void	setLastValue(Field pField, java.lang.Object pLastValue) Sets the last value of a field for which the auto-increment value is true.
void	setNextValue(Field pField, java.lang.Object pNextValue) Sets the next value of a field for which the auto-increment value is true.

Method Detail

getNextValue

public java.lang.Object getNextValue(Field pField)
                              throws CMException

Gets the next value of a field for which the auto-increment value is true. Currently fields containing the following types of values can be incremented:

• BigInteger
• Long
• Integer
• Short
• Byte
• String (but only if the String can be converted to an Integer)

Throws:

CMException

getNextValue

public java.lang.Object getNextValue(FieldDescriptorRow pFD)
                              throws CMException

Gets the next value of a field for which the auto-increment value is true. Currently fields containing the following types of values can be incremented:

• BigInteger
• Long
• Integer
• Short
• Byte
• String (but only if the String can be converted to an Integer)

Throws:

CMException

getNextValue

public java.lang.Object getNextValue(FieldDescriptorRow pFD,
                                     Table pTable)
                              throws CMException

Gets the next value of a field for which the auto-increment value is true. Currently fields containing the following types of values can be incremented:

• BigInteger
• Long
• Integer
• Short
• Byte
• String (but only if the String can be converted to an Integer)

Throws:

CMException

setLastValue

public void setLastValue(Field pField,
                         java.lang.Object pLastValue)
                  throws CMException

Sets the last value of a field for which the auto-increment value is true. (The next value will be one more than the value passed in). Currently fields containing the following types of values can be incremented:

• BigInteger
• Long
• Integer
• Short
• Byte
• String (but only if the String can be converted to an Integer)

This method is invoked by the DataEngine - it should not be necessary for DataEngine users to invoke this method.

Throws:

CMException

setNextValue

public void setNextValue(Field pField,
                         java.lang.Object pNextValue)
                  throws CMException

Sets the next value of a field for which the auto-increment value is true. Currently fields containing the following types of values can be incremented:

• BigInteger
• Long
• Integer
• Short
• Byte
• String (but only if the String can be converted to an Integer)

This method is invoked by the DataEngine - it should not be necessary for DataEngine users to invoke this method.

Throws:

CMException

clearValue

public void clearValue(Field field)
                throws CMException

Clears the incrementors value.

Throws:

CMException