com.ibm.as400.access
Class DataQueueAttributes
- java.lang.Object
-
- com.ibm.as400.access.DataQueueAttributes
-
- All Implemented Interfaces:
- java.io.Serializable
public class DataQueueAttributes extends java.lang.Object implements java.io.Serializable
The DataQueueAttributes class represents a data queue attributes object.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description DataQueueAttributes()
-
Method Summary
Methods Modifier and Type Method and Description 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.java.lang.String
getAuthority()
Returns the public authority of the data queue.java.lang.String
getDescription()
Returns the text description of the data queue.int
getEntryLength()
Returns the maximum entry length of the data queue.int
getKeyLength()
Returns the byte length of the keys of the data queue.boolean
isFIFO()
Returns a value that indicates if entries are read in FIFO order.boolean
isForceToAuxiliaryStorage()
Returns a value that indicates if entries are forced to auxiliary storage.boolean
isSaveSenderInfo()
Returns whether sender information is stored with each data queue entry.void
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener.void
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a vetoable change listener.void
setAuthority(java.lang.String authority)
Sets the public authority of the data queue.void
setDescription(java.lang.String description)
Sets the text description of the data queue.void
setEntryLength(int entryLength)
Sets the maximum number of bytes per data queue entry.void
setFIFO(boolean FIFO)
Sets a value that indicates if entries are read in FIFO order.void
setForceToAuxiliaryStorage(boolean forceToAuxiliaryStorage)
Sets a value that indicates if entries are forced to auxiliary storage.void
setKeyLength(int keyLength)
Sets the number of bytes per data queue key.void
setSaveSenderInfo(boolean saveSenderInfo)
Sets whether sender information is stored with each data queue entry.
-
-
-
Method Detail
-
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.- Parameters:
listener
- The listener.
-
addVetoableChangeListener
public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.- Parameters:
listener
- The listener.
-
getAuthority
public java.lang.String getAuthority()
Returns the public authority of the data queue.- Returns:
- The public authority of the data queue. Valid values are *ALL, *CHANGE, *EXCLUDE, *USE, *LIBCRTAUT.
-
getDescription
public java.lang.String getDescription()
Returns the text description of the data queue.- Returns:
- The text description of the data queue.
-
getEntryLength
public int getEntryLength()
Returns the maximum entry length of the data queue.- Returns:
- The maximum entry length of the data queue.
-
getKeyLength
public int getKeyLength()
Returns the byte length of the keys of the data queue.- Returns:
- The byte length of the keys of the data queue.
-
isFIFO
public boolean isFIFO()
Returns a value that indicates if entries are read in FIFO order. Returns true if entries are read off the data queue in FIFO order. Returns false if entries are read off the data queue in LIFO order.- Returns:
- true if entries are read off the data queue in FIFO order; false otherwise.
-
isForceToAuxiliaryStorage
public boolean isForceToAuxiliaryStorage()
Returns a value that indicates if entries are forced to auxiliary storage. If true, entries are immediately written to permanent storage. If false, written entries may be kept in memory and could be lost in the case of a power outage.- Returns:
- true if entries are immediately written to permanent storage; false otherwise.
-
isSaveSenderInfo
public boolean isSaveSenderInfo()
Returns whether sender information is stored with each data queue entry.- Returns:
- true if sender information is saved; false otherwise.
-
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener.- Parameters:
listener
- The listener.
-
removeVetoableChangeListener
public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a vetoable change listener.- Parameters:
listener
- The listener.
-
setAuthority
public void setAuthority(java.lang.String authority) throws java.beans.PropertyVetoException
Sets the public authority of the data queue.- Parameters:
authority
- The public authority of the data queue. Valid values are *ALL, *CHANGE, *EXCLUDE, *USE, *LIBCRTAUT.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.
-
setDescription
public void setDescription(java.lang.String description) throws java.beans.PropertyVetoException
Sets the text description of the data queue.- Parameters:
description
- The text description. This string must be 50 characters or less.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.
-
setEntryLength
public void setEntryLength(int entryLength) throws java.beans.PropertyVetoException
Sets the maximum number of bytes per data queue entry.- Parameters:
entryLength
- The maximum number of bytes per data queue entry. Valid values are 1-64512.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.
-
setFIFO
public void setFIFO(boolean FIFO) throws java.beans.PropertyVetoException
Sets a value that indicates if entries are read in FIFO order. If true, entries are read off the data queue in FIFO order. If false, entries are read off the data queue in LIFO order.- Parameters:
FIFO
- true if queue entries are processed in FIFO order; false otherwise.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.
-
setForceToAuxiliaryStorage
public void setForceToAuxiliaryStorage(boolean forceToAuxiliaryStorage) throws java.beans.PropertyVetoException
Sets a value that indicates if entries are forced to auxiliary storage. If true, entries are immediately written to permanent storage. If false, written entries may be kept in memory and could be lost in the case of a power outage.- Parameters:
forceToAuxiliaryStorage
- true if writes are forced to storage before return; false otherwise.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.
-
setKeyLength
public void setKeyLength(int keyLength) throws java.beans.PropertyVetoException
Sets the number of bytes per data queue key.- Parameters:
keyLength
- The number of bytes per data queue key. Valid values are 1-256.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.
-
setSaveSenderInfo
public void setSaveSenderInfo(boolean saveSenderInfo) throws java.beans.PropertyVetoException
Sets whether sender information is stored with each data queue entry.- Parameters:
saveSenderInfo
- true if sender information is saved; false otherwise.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.
-
-