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 PropertyChangeListener.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a VetoableChangeListener.
 o getAuthority()
Returns the Public authority for 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 number of bytes per data queue key.
 o isFIFO()
Returns whether entries are read off of the data queue in FIFO order.
 o isForceToAuxiliaryStorage()
Returns whether entries are immediately written to permanent storage.
 o isSaveSenderInfo()
Returns whether sender information is stored with each data queue entry.
 o removePropertyChangeListener(PropertyChangeListener)
Removes this PropertyChangeListener from the internal list.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes this VetoableChangeListener from the JellyBeans internal list.
 o setAuthority(String)
Sets the Public authority for the data queue.
 o setDescription(String)
Sets the text description of the data queue.
 o setEntryLength(int)
Sets the maximum entry length of the data queue.
 o setFIFO(boolean)
Sets the order in which entries are read off of the data queue.
 o setForceToAuxiliaryStorage(boolean)
Sets the force to auxilary storage value.
 o setKeyLength(int)
Set 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 l)
Adds a PropertyChangeListener. The specified PropertyChangeListeners propertyChange method will be called each time the value of any bound property is changed. The PropertyListener object is addded to a list of PropertyChangeListeners managed by this CommandCall, it can be removed with removePropertyChangeListener.

Parameters:
l - The PropertyChangeListener.
See Also:
removePropertyChangeListener
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener l)
Adds a VetoableChangeListener. The specified VetoableChangeListeners vetoableChange method will be called each time the value of any constrained property is changed.

Parameters:
l - The VetoableChangeListener.
See Also:
removeVetoableChangeListener
 o getAuthority
 public String getAuthority()
Returns the Public authority for the data queue.

Returns:
The public authority for 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. This string must be 50 characters or less.
 o getEntryLength
 public int getEntryLength()
Returns the maximum entry length of the data queue.

Returns:
The maximum entry length.
 o getKeyLength
 public int getKeyLength()
Returns the number of bytes per data queue key.

Returns:
The number of bytes per data queue key. Valid values are 1-256.
 o isFIFO
 public boolean isFIFO()
Returns whether entries are read off of the data queue in FIFO order. If true, entries are read off of the data queue in FIFO order. If false, entries are read off of the data queue in LIFO order.

Returns:
true if entries are read in FIFO order; false if entries are read in LIFO order.
 o isForceToAuxiliaryStorage
 public boolean isForceToAuxiliaryStorage()
Returns whether entries are immediately written to permanent 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 forced to auxiliary storage; false if entries may be kept in memory and could be lost in the case of a power outage.
 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 l)
Removes this PropertyChangeListener from the internal list. If the PropertyChangeListener isn't on the list, silently do nothing.

Parameters:
l - The PropertyChangeListener.
See Also:
addPropertyChangeListener
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener l)
Removes this VetoableChangeListener from the JellyBeans internal list. If the VetoableChangeListener isn't on the list, silently do nothing.

Parameters:
l - The VetoableChangeListener.
See Also:
addVetoableChangeListener
 o setAuthority
 public void setAuthority(String authority) throws PropertyVetoException
Sets the Public authority for the data queue.

Parameters:
authority - The public authority for the data queue. Valid values are *ALL, *CHANGE, *EXCLUDE, *USE, *LIBCRTAUT.
Throws: PropertyVetoException
If a 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 a change is vetoed.
 o setEntryLength
 public void setEntryLength(int entryLength) throws PropertyVetoException
Sets the maximum entry length of the data queue.

Parameters:
entryLength - The maximum entry length. Valid values are 1-31744.
Throws: PropertyVetoException
If a change is vetoed.
 o setFIFO
 public void setFIFO(boolean fifo) throws PropertyVetoException
Sets the order in which entries are read off of the data queue. Set to true if entries are read off of the data queue in FIFO order. Set to false if entries are read off of the data queue in LIFO order.

Parameters:
fifo - Value indicating if entries are read in FIFO order.
Throws: PropertyVetoException
If a change is vetoed.
 o setForceToAuxiliaryStorage
 public void setForceToAuxiliaryStorage(boolean forceToAux) throws PropertyVetoException
Sets the force to auxilary storage value. If set to true, entries are immediately written to permanent storage. If set to false, written entries may be kept in memory and could be lost in the case of a power outage.

Parameters:
forceToAux - The value indicating if entries are forced to auxiliary storage.
Throws: PropertyVetoException
If a change is vetoed.
 o setKeyLength
 public void setKeyLength(int keyLength) throws PropertyVetoException
Set 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 a change is vetoed.
 o setSaveSenderInfo
 public void setSaveSenderInfo(boolean saveSenderInfo) throws PropertyVetoException
Sets whether sender information is stored with each data queue entry.

Parameters:
saveSenderInfo - Value indicating if sender information is saved.
Throws: PropertyVetoException
If a change is vetoed.

All Packages  Class Hierarchy  This Package  Previous  Next  Index