|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.as400.access.BaseDataQueue
public abstract class BaseDataQueue extends Object implements Serializable
The BaseDataQueue class represents an IBM i data queue object.
Constructor and Description |
---|
BaseDataQueue()
Constructs a BaseDataQueue object. |
BaseDataQueue(AS400 system,
String path)
Constructs a BaseDataQueue object. |
Modifier and Type | Method and Description |
---|---|
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(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes. |
void |
addVetoableChangeListener(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. |
String |
getDescription()
Returns the text description of the data queue. |
boolean |
getForceToAuxiliaryStorage()
Returns a value that indicates if entries are forced to auxiliary storage. |
int |
getMaxEntryLength()
Returns the maximum entry length of the data queue. |
String |
getName()
Returns the name of the data queue. |
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 system 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(PropertyChangeListener listener)
Removes a property change listener. |
void |
removeVetoableChangeListener(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(String path)
Sets the fully qualified integrated file system path name of the data queue. |
void |
setSystem(AS400 system)
Sets the system object representing the system on which the data queue exists. |
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, String path)
system
- The system object representing the 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 object.public void addObjectListener(ObjectListener listener)
listener
- The listener object.public void addPropertyChangeListener(PropertyChangeListener listener)
listener
- The listener object.public void addVetoableChangeListener(VetoableChangeListener listener)
listener
- The listener object.public void clear() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public void delete() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public boolean exists() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.public int getCcsid()
public String getDescription() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public boolean getForceToAuxiliaryStorage() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public int getMaxEntryLength() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public String getName()
public String getPath()
public boolean getSaveSenderInformation() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public AS400 getSystem()
public boolean isFIFO() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public void refreshAttributes() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.IOException
- If an error occurs while communicating with the system.IllegalObjectTypeException
- If the object on the system is not the required type.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the object does not exist on the system.public void removeDataQueueListener(DataQueueListener listener)
listener
- The listener object.public void removeObjectListener(ObjectListener listener)
listener
- The listener object.public void removePropertyChangeListener(PropertyChangeListener listener)
listener
- The listener object.public void removeVetoableChangeListener(VetoableChangeListener listener)
listener
- The listener object.public void setCcsid(int ccsid) throws PropertyVetoException
ccsid
- The CCSID to use for the data in this data queue.PropertyVetoException
- If the change is vetoed.public void setPath(String path) throws PropertyVetoException
path
- The fully qualified integrated file system path name of the data queue.PropertyVetoException
- If the change is vetoed.public void setSystem(AS400 system) throws PropertyVetoException
system
- The system object representing the system on which the data queue exists.PropertyVetoException
- If the change is vetoed.public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |