All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.access.DecimalDataArea
java.lang.Object
|
+----com.ibm.as400.access.DataArea
|
+----com.ibm.as400.access.DecimalDataArea
- public class DecimalDataArea
- extends DataArea
- implements Serializable
The DecimalDataArea class represents a decimal data area on the AS/400.
The following example demonstrates the use of DecimalDataArea:
// Prepare to work with the AS/400 system named "My400".
AS400 system = new AS400("My400");
// Create a DecimalDataArea object.
QSYSObjectPathName path = new QSYSObjectPathName("MYLIB", "MYDATA", "DTAARA");
DecimalDataArea dataArea = new DecimalDataArea(system, path.getPath());
// Create the decimal data area on the AS/400 using default values.
dataArea.create();
// Clear the data area.
dataArea.clear();
// Write to the data area.
dataArea.write(new BigDecimal("1.2"));
// Read from the data area.
BigDecimal data = dataArea.read();
// Delete the data area from the AS/400.
dataArea.delete();
-
DecimalDataArea()
- Constructs a DecimalDataArea object.
-
DecimalDataArea(AS400, String)
- Constructs a DecimalDataArea object.
-
clear()
- Resets the data area to contain 0.0.
-
create()
- Creates a decimal data area on the AS/400.
-
create(int, int, BigDecimal, String, String)
- Creates a decimal data area with the specified attributes.
-
delete()
- Removes the data area from the system.
-
getDecimalPositions()
- Returns the number of digits to the right of the decimal point in this data area.
-
getPath()
- Returns the integrated file system path name of the object represented by the data area.
-
read()
- Returns the data read from the data area.
-
setPath(String)
- Sets the fully qualified data area name.
-
write(BigDecimal)
- Writes data to the data area.
DecimalDataArea
public DecimalDataArea()
- Constructs a DecimalDataArea object.
It creates a default DecimalDataArea object. The system and path
properties must be set before attempting a connection.
DecimalDataArea
public DecimalDataArea(AS400 system,
String path)
- Constructs a DecimalDataArea object.
It creates a DecimalDataArea instance that represents the data area path
on system.
- Parameters:
- system - The AS/400 that contains the data area.
- path - The fully qualified integrated file system path name. The
integrated file system file extension for a data area is DTAARA. An example of a
fully qualified integrated file system path to a data area "MYDATA" in library
"MYLIB" is: /QSYS.LIB/MYLIB.LIB/MYDATA.DTAARA
clear
public void clear() throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
- Resets the data area to contain 0.0.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: ObjectDoesNotExistException
- If the AS/400 object does not exist.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
create
public void create() throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectAlreadyExistsException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
- Creates a decimal data area on the AS/400.
This method uses the following default property values.
- length - 15 digits.
- decimalPositions - 5 digits.
- initialValue - A value of 0.0.
- textDescription - A blank string.
- authority - A value of *LIBCRTAUT.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: ObjectAlreadyExistsException
- If the AS/400 object already exists.
- Throws: ObjectDoesNotExistException
- If the AS/400 object does not exist.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
create
public void create(int length,
int decimalPositions,
BigDecimal initialValue,
String textDescription,
String authority) throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectAlreadyExistsException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
- Creates a decimal data area with the specified attributes.
- Parameters:
- length - The maximum number of digits in the data area. Valid
values are 1 through 24.
- decimalPositions - The number of digits to the right of the decimal
point. Valid values are 0 through 9.
- initialValue - The initial value for the data area.
- textDescription - The text description for the data area. The maximum length is 50 characters.
- authority - The public authority level for the data area. Valid
values are *ALL, *CHANGE, *EXCLUDE, *LIBCRTAUT, *USE, or the
name of an authorization list. The maximum length is 10 characters.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: ObjectAlreadyExistsException
- If the AS/400 object already exists.
- Throws: ObjectDoesNotExistException
- If the AS/400 object does not exist.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
delete
public void delete() throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
- Removes the data area from the system.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: ObjectDoesNotExistException
- If the object does not exist.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
- Overrides:
- delete in class DataArea
getDecimalPositions
public int getDecimalPositions() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, ObjectDoesNotExistException
- Returns the number of digits to the right of the decimal point in this data area.
- Returns:
- The number of decimal positions.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: ObjectDoesNotExistException
- If the AS/400 object does not exist.
getPath
public String getPath()
- Returns the integrated file system path name of the object represented by the data area.
- Returns:
- The integrated file system path name of the object represented by the data area.
- Overrides:
- getPath in class DataArea
read
public BigDecimal read() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, ObjectDoesNotExistException
- Returns the data read from the data area.
- Returns:
- The decimal data read from the data area.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: ObjectDoesNotExistException
- If the AS/400 object does not exist.
setPath
public void setPath(String path) throws PropertyVetoException
- Sets the fully qualified data area name.
The following example demonstrates the use of setPath:
// Create a DecimalDataArea object.
DecimalDataArea dataArea = new DecimalDataArea();
// Set its path to be the data area "MYDATA" in the library "MYLIB".
dataArea.setPath("/QSYS.LIB/MYLIB.LIB/MYDATA.DTAARA");
- Parameters:
- path - The fully qualified integrated file system path name of the data area.
- Throws: PropertyVetoException
- If the change is vetoed.
- Overrides:
- setPath in class DataArea
write
public void write(BigDecimal data) throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
- Writes data to the data area.
- Parameters:
- data - The decimal data to be written.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: ObjectDoesNotExistException
- If the AS/400 object does not exist.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
All Packages Class Hierarchy This Package Previous Next Index