|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.BaseDataQueue
The BaseDataQueue class represents an AS/400 data queue object.
Constructor Summary | |
BaseDataQueue()
Constructs a BaseDataQueue object. |
|
BaseDataQueue(AS400 system,
java.lang.String path)
Constructs a BaseDataQueue object. |
Method Summary | |
void |
addDataQueueListener(DataQueueListener listener)
Adds a listener to be notified when a data queue event occurs. |
void |
addObjectListener(ObjectListener listener)
Adds a listener to be notified when an object event occurs. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes. |
void |
addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes. |
void |
clear()
Removes all entries from the data queue. |
void |
delete()
Deletes the data queue. |
boolean |
exists()
Checks to see if the data queue exists. |
int |
getCcsid()
Returns the CCSID used for the data in this data queue. |
java.lang.String |
getDescription()
Returns the text description of the data queue. |
boolean |
getForceToAuxiliaryStorage()
Returns a value that indicates if entries are forced to auxiliary storage on the server. |
int |
getMaxEntryLength()
Returns the maximum entry length of the data queue. |
java.lang.String |
getName()
Returns the name of the data queue. |
java.lang.String |
getPath()
Returns the full integrated file system path name of the data queue. |
boolean |
getSaveSenderInformation()
Returns whether sender information is stored with each data queue entry. |
AS400 |
getSystem()
Returns the AS400 object representing the system on which the data queue exists. |
boolean |
isFIFO()
Returns a value that indicates if entries are read in FIFO order. |
void |
refreshAttributes()
Refreshes the attributes of the data queue. |
void |
removeDataQueueListener(DataQueueListener listener)
Removes a data queue listener. |
void |
removeObjectListener(ObjectListener listener)
Removes a object listener. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a vetoable change listener. |
void |
setCcsid(int ccsid)
Sets the CCSID to use for the data in this data queue. |
void |
setPath(java.lang.String path)
Sets the fully qualified integrated file system path name of the data queue. |
void |
setSystem(AS400 system)
Sets the system on which the data queue exists. |
java.lang.String |
toString()
Returns the String representation of this data queue object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public BaseDataQueue()
public BaseDataQueue(AS400 system, java.lang.String path)
system
- The AS/400 system on which the data queue exists.path
- The fully qualified integrated file system path name of the data queue.Method Detail |
public void addDataQueueListener(DataQueueListener listener)
listener
- The listener.public void addObjectListener(ObjectListener listener)
listener
- The listener.public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener.public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The listener.public void clear() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public void delete() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public boolean exists() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public int getCcsid()
public java.lang.String getDescription() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public boolean getForceToAuxiliaryStorage() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public int getMaxEntryLength() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public java.lang.String getName()
public java.lang.String getPath()
public boolean getSaveSenderInformation() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public AS400 getSystem()
public boolean isFIFO() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public void refreshAttributes() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public void removeDataQueueListener(DataQueueListener listener)
listener
- The listener.public void removeObjectListener(ObjectListener listener)
listener
- The listener.public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener.public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The listener.public void setCcsid(int ccsid) throws java.beans.PropertyVetoException
ccsid
- The CCSID to use for the data in this data queue.java.beans.PropertyVetoException
- If the change is vetoed.public void setPath(java.lang.String path) throws java.beans.PropertyVetoException
path
- The fully qualified integrated file system path name of the data queue.java.beans.PropertyVetoException
- If the change is vetoed.public void setSystem(AS400 system) throws java.beans.PropertyVetoException
system
- The AS/400 system on which the data queue exists.java.beans.PropertyVetoException
- If the change is vetoed.public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |