All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.DataQueueAttributes

java.lang.Object
   |
   +----com.ibm.as400.access.DataQueueAttributes

public class DataQueueAttributes
extends Object
implements Serializable
The DataQueueAttributes class represents an AS/400 data queue attributes object.


Constructor Index

 o DataQueueAttributes()

Method Index

 o addPropertyChangeListener(PropertyChangeListener)
Adds a listener to be notified when the value of any bound property changes.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a listener to be notified when the value of any constrained property changes.
 o getAuthority()
Returns the public authority of the data queue.
 o getDescription()
Returns the text description of the data queue.
 o getEntryLength()
Returns the maximum entry length of the data queue.
 o getKeyLength()
Returns the byte length of the keys of the data queue.
 o isFIFO()
Returns a value that indicates if entries are read in FIFO order.
 o isForceToAuxiliaryStorage()
Returns a value that indicates if entries are forced to auxiliary storage.
 o isSaveSenderInfo()
Returns whether sender information is stored with each data queue entry.
 o removePropertyChangeListener(PropertyChangeListener)
Removes a property change listener.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a vetoable change listener.
 o setAuthority(String)
Sets the public authority of the data queue.
 o setDescription(String)
Sets the text description of the data queue.
 o setEntryLength(int)
Sets the maximum number of bytes per data queue entry.
 o setFIFO(boolean)
Sets a value that indicates if entries are read in FIFO order.
 o setForceToAuxiliaryStorage(boolean)
Sets a value that indicates if entries are forced to auxiliary storage.
 o setKeyLength(int)
Sets the number of bytes per data queue key.
 o setSaveSenderInfo(boolean)
Sets whether sender information is stored with each data queue entry.

Constructors

 o DataQueueAttributes
 public DataQueueAttributes()

Methods

 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.

Parameters:
listener - The listener.
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.

Parameters:
listener - The listener.
 o getAuthority
 public 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.
 o getDescription
 public String getDescription()
Returns the text description of the data queue.

Returns:
The text description of the data queue.
 o getEntryLength
 public int getEntryLength()
Returns the maximum entry length of the data queue.

Returns:
The maximum entry length of the data queue.
 o 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.
 o 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.
 o 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.
 o isSaveSenderInfo
 public boolean isSaveSenderInfo()
Returns whether sender information is stored with each data queue entry.

Returns:
true if sender information is saved; false otherwise.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener.

Parameters:
listener - The listener.
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a vetoable change listener.

Parameters:
listener - The listener.
 o setAuthority
 public void setAuthority(String authority) throws 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: PropertyVetoException
If the change is vetoed.
 o setDescription
 public void setDescription(String description) throws PropertyVetoException
Sets the text description of the data queue.

Parameters:
description - The text description. This string must be 50 characters or less.
Throws: PropertyVetoException
If the change is vetoed.
 o setEntryLength
 public void setEntryLength(int entryLength) throws 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: PropertyVetoException
If the change is vetoed.
 o setFIFO
 public void setFIFO(boolean FIFO) throws 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: PropertyVetoException
If the change is vetoed.
 o setForceToAuxiliaryStorage
 public void setForceToAuxiliaryStorage(boolean forceToAuxiliaryStorage) throws 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: PropertyVetoException
If the change is vetoed.
 o setKeyLength
 public void setKeyLength(int keyLength) throws 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: PropertyVetoException
If the change is vetoed.
 o setSaveSenderInfo
 public void setSaveSenderInfo(boolean saveSenderInfo) throws PropertyVetoException
Sets whether sender information is stored with each data queue entry.

Parameters:
saveSenderInformation - true if sender information is saved; false otherwise.
Throws: PropertyVetoException
If the change is vetoed.

All Packages  Class Hierarchy  This Package  Previous  Next  Index