com.sap.ip.me.api.smartsync
Interface NumericField

All Superinterfaces:

Field

public interface NumericField

extends Field

NumericField represents the static type of field with java.math.BigInteger as the underlying data type.

To retrieve the NumericField instance on a certain Row, the FieldDescriptor of this Field is used.

Example:

 	NumericField numcFieldITEMCOUNT = parentRow.getNumericField(numcFieldITEMCOUNT_FieldDesciptor);
      BigInteger value = numcFieldITEMCOUNT.getBigInteger();
      

value is the current value of the NumericField object.

      BigInteger newValue = new BigInteger("123456789");
      numcFieldITEMCOUNT.setValue(newValue);
 

Setting of a new value to the field.

Copyright: Copyright (c) 2002

Company: SAP AG

Since:

2.5

Version:

2.5

Author:

SAP

See Also:

Field

Method Summary

java.math.BigInteger	getBigInteger() Returns the value attribute of the NumericField object as a java.math.BigInteger object.
java.lang.String	getValueWithLeadingZeros() Returns the String value of this Field of length equal to the defined length in the metadata.
void	setValue(java.math.BigInteger fieldValue) Sets the value attribute of the NumericField object

Methods inherited from interface com.sap.ip.me.api.smartsync.Field

getFieldDescriptor, getGroupFields, getRow, getValue, setValue

Method Detail

setValue

public void setValue(java.math.BigInteger fieldValue)
              throws ModificationNotAllowedException,
                     PersistenceException

Sets the value attribute of the NumericField object

Parameters:

fieldValue - The new field value.

Throws:

ModificationNotAllowedException - thrown if the operation is not complying with the rules set in the metadata definition.

PersistenceException - thrown if any persistent layer exception occurred during the retrieval.

getBigInteger

public java.math.BigInteger getBigInteger()

Returns the value attribute of the NumericField object as a java.math.BigInteger object.

Returns:

The value of the NumericField object

getValueWithLeadingZeros

public java.lang.String getValueWithLeadingZeros()

Returns the String value of this Field of length equal to the defined length in the metadata. Leading zeros will be inserted if the actual value has a length less than the defined length. For example, the value of 12 will be 0000000012 for the specified length of 10.

Returns:

The value of the NumericField object as a String with the leading zeros if required.