com.ibm.as400.access
Class LogicalDataArea

java.lang.Object
  com.ibm.as400.access.DataArea
      com.ibm.as400.access.LogicalDataArea

All Implemented Interfaces:

Serializable

public class LogicalDataArea
extends DataArea
implements Serializable

The LogicalDataArea class represents a logical data area on the system.

The following example demonstrates the use of LogicalDataArea:

// Prepare to work with the system named "My400".
AS400 system = new AS400("My400");

// Create a LogicalDataArea object.
QSYSObjectPathName path = new QSYSObjectPathName("MYLIB", "MYDATA", "DTAARA");
LogicalDataArea dataArea = new LogicalDataArea(system, path.getPath());

// Create the logical data area on the system using default values.
dataArea.create();

// Clear the data area.
dataArea.clear();

// Write to the data area.
dataArea.write(true);

// Read from the data area.
boolean data = dataArea.read();

// Delete the data area from the system.
dataArea.delete();

See Also:

Serialized Form

Constructor and Description

LogicalDataArea()
Constructs a LogicalDataArea object.

LogicalDataArea(AS400 system, String path)
Constructs a LogicalDataArea object.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the data area.
void	create() Creates a logical data area on the system.
void	create(boolean initialValue, String textDescription, String authority) Creates a logical data area with the specified attributes.
void	delete() Removes the data area from the system.
String	getPath() Returns the integrated file system path name of the object represented by the data area.
boolean	read() Returns the value in the data area.
void	setPath(String path) Sets the fully qualified data area name.
void	write(boolean data) Writes the value in data to the data area.

Methods inherited from class com.ibm.as400.access.DataArea

addDataAreaListener, addPropertyChangeListener, addVetoableChangeListener, getLength, getName, getSystem, refreshAttributes, removeDataAreaListener, removePropertyChangeListener, removeVetoableChangeListener, setSystem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogicalDataArea

public LogicalDataArea()

Constructs a LogicalDataArea object. It creates a default LogicalDataArea object. The system and path properties must be set before attempting a connection.

LogicalDataArea

public LogicalDataArea(AS400 system,
                       String path)

Constructs a LogicalDataArea object. It creates a LogicalDataArea instance that represents the data area path on system.

Parameters:

system - The system 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

Method Detail

clear

public void clear()
           throws AS400SecurityException,
                  ErrorCompletingRequestException,
                  InterruptedException,
                  IOException,
                  ObjectDoesNotExistException

Clears the data area. This method resets the data area to contain the default value of false.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the system object does not exist.

create

public void create()
            throws AS400SecurityException,
                   ErrorCompletingRequestException,
                   InterruptedException,
                   IOException,
                   ObjectAlreadyExistsException,
                   ObjectDoesNotExistException

Creates a logical data area on the system. This method uses the following default property values.

• initialValue - A value of false.
• textDescription - A blank string.
• authority - A value of *LIBCRTAUT.

Note the length of a LogicalDataArea is always 1.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectAlreadyExistsException - If the system object already exists.

ObjectDoesNotExistException - If the system object does not exist.

create

public void create(boolean initialValue,
                   String textDescription,
                   String authority)
            throws AS400SecurityException,
                   ErrorCompletingRequestException,
                   InterruptedException,
                   IOException,
                   ObjectAlreadyExistsException,
                   ObjectDoesNotExistException

Creates a logical data area with the specified attributes.

Parameters:

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.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectAlreadyExistsException - If the system object already exists.

ObjectDoesNotExistException - If the system object does not exist.

delete

public void delete()
            throws AS400SecurityException,
                   ErrorCompletingRequestException,
                   InterruptedException,
                   IOException,
                   ObjectDoesNotExistException

Removes the data area from the system.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the 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.

read

public boolean read()
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    IllegalObjectTypeException,
                    InterruptedException,
                    IOException,
                    ObjectDoesNotExistException

Returns the value in the data area.

Returns:

The data read from the data area.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

IllegalObjectTypeException - If the system object is not the required type.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the system 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 LogicalDataArea object.
   LogicalDataArea dataArea = new LogicalDataArea();

   // 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.

write

public void write(boolean data)
           throws AS400SecurityException,
                  ErrorCompletingRequestException,
                  InterruptedException,
                  IOException,
                  ObjectDoesNotExistException

Writes the value in data to the data area.

Parameters:

data - The data to be written.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the system object does not exist.