com.ibm.dse.application
Class CashDrawer

java.lang.Object
  |
  +--com.ibm.dse.base.DataElement
        |
        +--com.ibm.dse.base.DataCollection
              |
              +--com.ibm.dse.base.KeyedCollection
                    |
                    +--com.ibm.dse.application.CashDrawer

public class CashDrawer
extends KeyedCollection

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.base.DataElement
description, name, state
 
Constructor Summary
CashDrawer()
          Deprecated. This constructor creates a CashDrawer object.
CashDrawer(java.lang.String aName)
          Deprecated. This constructor creates a new instance of the CashDrawer class, which is obtained from the external definition files through aName.
 
Method Summary
 void addCounter(Counter aCounter)
          Deprecated. Adds the Counter aCounter to the cashDrawer.
 java.lang.String getCashDrawerName()
          Deprecated. Returns the "cashDrawerName" element value of the CashDrawer.
 Counter getCounter(java.lang.String aCounterName)
          Deprecated. Returns the Counter named aCounterName.
 java.lang.Boolean getCounterCheckIfRequired(java.lang.String aCounterName)
          Deprecated. Returns the checkIfRequired state of the Counter named aCounterName.
 java.lang.Float getCounterIncrement(java.lang.String aCounterName)
          Deprecated. Returns the increment value of the Counter named aCounterName.
 java.lang.Float getCounterIncrementMaxLimit(java.lang.String aCounterName)
          Deprecated. Returns the increment maxLimit value of the Counter named aCounterName.
 java.lang.Float getCounterIncrementMinLimit(java.lang.String aCounterName)
          Deprecated. Returns the increment minLimit value of the Counter named aCounterName.
 Vector getCounterNames()
          Deprecated. Returns a Vector with the Names of the counters held in the Cashdrawer
 Vector getCounters()
          Deprecated. Returns a Vector with the counters held in the Cashdrawer.
 java.lang.Float getCounterTotal(java.lang.String aCounterName)
          Deprecated. Returns the total value of the Counter named aCounterName.
 java.lang.Float getCounterTotalMaxLimit(java.lang.String aCounterName)
          Deprecated. Returns the total maxLimit value of the Counter named aCounterName.
 java.lang.Float getCounterTotalMinLimit(java.lang.String aCounterName)
          Deprecated. Returns the total minLimit value of the Counter named aCounterName.
 java.lang.Float getCounterTotIncrs(java.lang.String aCounterName)
          Deprecated. Returns the totIncrs value of the Counter named aCounterName.
 java.lang.Float getCounterTotIncrsMaxLimit(java.lang.String aCounterName)
          Deprecated. Returns the totIncrs maxLimit value of the Counter named aCounterName.
 java.lang.Float getCounterTotIncrsMinLimit(java.lang.String aCounterName)
          Deprecated. Returns the totIncrs minLimit value of the Counter named aCounterName.
 java.lang.String getCurrency()
          Deprecated. Returns the "currency" element value of the CashDrawer.
 java.lang.String getFormat()
          Deprecated. Returns the "format" element value of the CashDrawer.
 java.lang.String getIsAssigned()
          Deprecated. Returns the "isAssigned" element state of the CashDrawer.
 java.lang.String getIsSettled()
          Deprecated. Returns the "isSettled" element state of the CashDrawer.
 java.lang.String getType()
          Deprecated. Returns the "type" element value of the CashDrawer.
 java.lang.String getUserid()
          Deprecated. Returns the "userid" element value of the CashDrawer.
 java.lang.Object initializeFrom(Tag aTag)
          Deprecated. Returns the cashDrawer implemented by the Tag aTag.
 void setCashDrawerName(java.lang.String aCashDrawerName)
          Deprecated. Sets the "cashDrawerName" element value of the CashDrawer.
 void setCounterCheckIfRequired(java.lang.String aCounterName, java.lang.Boolean aBoolean)
          Deprecated. Sets the checkIfRequired state of the Counter named aCounterName.
 void setCounterIncrement(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets Increment value of the Counter named aCounterName.
 void setCounterIncrementMaxLimit(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets Increment maxLimit value of the Counter named aCounterName.
 void setCounterIncrementMinLimit(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets Increment minLimit value of the Counter named aCounterName.
 void setCounterTotal(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets Total value of the Counter named aCounterName.
 void setCounterTotalMaxLimit(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets Total maxLimit value of the Counter named aCounterName.
 void setCounterTotalMinLimit(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets Total minLimit value of the Counter named aCounterName.
 void setCounterTotIncrs(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets TotIncrs value of the Counter named aCounterName.
 void setCounterTotIncrsMaxLimit(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets TotIncrs maxLimit value of the Counter named aCounterName.
 void setCounterTotIncrsMinLimit(java.lang.String aCounterName, java.lang.Float aFloat)
          Deprecated. Sets TotIncrs minLimit value of the Counter named aCounterName.
 void setCurrency(java.lang.String aString)
          Deprecated. Sets the "currency" element value of the CashDrawer.
 void setDescription(java.lang.String aDescription)
          Deprecated. Sets the description value of the CashDrawer.
 void setFormat(java.lang.String aFormat)
          Deprecated. Sets the "format" element value of the CashDrawer.
 void setIsAssigned(java.lang.String aString)
          Deprecated. Sets the "isAssigned" element state of the CashDrawer.
 void setIsSettled(java.lang.String aString)
          Deprecated. Sets the "isSettled" element state of the CashDrawer.
 void setName(java.lang.String aName)
          Deprecated. Sets the name property of the CashDrawer.
 void setType(java.lang.String aString)
          Deprecated. Sets the "type" element value of the CashDrawer.
 void setUserid(java.lang.String aUserID)
          Deprecated. Sets the "userid" element value of the CashDrawer.
 Vector toStrings()
          Deprecated. Returns a Vector with a String representation of the CashDrawer.
 
Methods inherited from class com.ibm.dse.base.KeyedCollection
addElement, addElement, calculeNestedElements, calculeNestedQualifiedElements, clone, getDynamic, getElementAt, getElementAt, getElementAtAnyLevel, getElementAtFirstLevel, getElements, getEnumeration, getIndexOf, getIndexOf, getNestedElements, getOrder, getValue, isDynamic, readExternal, removeAll, removeElementAt, removeElementAt, removeElementAtFirstLevel, reorderElements, setDynamic, setElements, setOrder, setValue, setValueAt, setValueAt, size, toString, validate, writeExternal
 
Methods inherited from class com.ibm.dse.base.DataCollection
getValueAt, nestedElements, nestedElements, nestedFields, nestedKeyedCollections, nestedQualifiedElements
 
Methods inherited from class com.ibm.dse.base.DataElement
externalizer, getDescription, getDescriptor, getErrorInfo, getExternalizer, getKey, getName, getState, getTagName, readExternal, readObject, removeExternal, setDescriptor, setErrorInfo, setExternalizer, setState, toTags, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CashDrawer

public CashDrawer()
Deprecated. 
This constructor creates a CashDrawer object.

CashDrawer

public CashDrawer(java.lang.String aName)
           throws java.io.IOException
Deprecated. 
This constructor creates a new instance of the CashDrawer class, which is obtained from the external definition files through aName.
Method Detail

addCounter

public void addCounter(Counter aCounter)
                throws DSEInvalidArgumentException
Deprecated. 
Adds the Counter aCounter to the cashDrawer. This method throws a DSEInvalidArgumentException if the Counter aCounter already exists in the cashDrawer.

getCashDrawerName

public java.lang.String getCashDrawerName()
                                   throws DSEObjectNotFoundException
Deprecated. 
Returns the "cashDrawerName" element value of the CashDrawer.

This method throws a DSEObjectNotFoundException if the "cashDrawerName" element is not found.


getCounter

public Counter getCounter(java.lang.String aCounterName)
                   throws DSEObjectNotFoundException
Deprecated. 
Returns the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter is not found.


getCounterCheckIfRequired

public java.lang.Boolean getCounterCheckIfRequired(java.lang.String aCounterName)
                                            throws DSEObjectNotFoundException
Deprecated. 
Returns the checkIfRequired state of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "increment" CounterElement are not found.


getCounterIncrement

public java.lang.Float getCounterIncrement(java.lang.String aCounterName)
                                    throws DSEObjectNotFoundException
Deprecated. 
Returns the increment value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "increment" CounterElement are not found.


getCounterIncrementMaxLimit

public java.lang.Float getCounterIncrementMaxLimit(java.lang.String aCounterName)
                                            throws DSEObjectNotFoundException
Deprecated. 
Returns the increment maxLimit value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "increment" CounterElement are not found.


getCounterIncrementMinLimit

public java.lang.Float getCounterIncrementMinLimit(java.lang.String aCounterName)
                                            throws DSEObjectNotFoundException
Deprecated. 
Returns the increment minLimit value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "increment" CounterElement are not found.


getCounterNames

public Vector getCounterNames()
Deprecated. 
Returns a Vector with the Names of the counters held in the Cashdrawer

getCounters

public Vector getCounters()
Deprecated. 
Returns a Vector with the counters held in the Cashdrawer.

getCounterTotal

public java.lang.Float getCounterTotal(java.lang.String aCounterName)
                                throws DSEObjectNotFoundException
Deprecated. 
Returns the total value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "total" CounterElement are not found.


getCounterTotalMaxLimit

public java.lang.Float getCounterTotalMaxLimit(java.lang.String aCounterName)
                                        throws DSEObjectNotFoundException
Deprecated. 
Returns the total maxLimit value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "total" CounterElement are not found.


getCounterTotalMinLimit

public java.lang.Float getCounterTotalMinLimit(java.lang.String aCounterName)
                                        throws DSEObjectNotFoundException
Deprecated. 
Returns the total minLimit value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "total" CounterElement are not found.


getCounterTotIncrs

public java.lang.Float getCounterTotIncrs(java.lang.String aCounterName)
                                   throws DSEObjectNotFoundException
Deprecated. 
Returns the totIncrs value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "totIncrs" CounterElement are not found.


getCounterTotIncrsMaxLimit

public java.lang.Float getCounterTotIncrsMaxLimit(java.lang.String aCounterName)
                                           throws DSEObjectNotFoundException
Deprecated. 
Returns the totIncrs maxLimit value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "totIncrs" CounterElement are not found.


getCounterTotIncrsMinLimit

public java.lang.Float getCounterTotIncrsMinLimit(java.lang.String aCounterName)
                                           throws DSEObjectNotFoundException
Deprecated. 
Returns the totIncrs minLimit value of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "totIncrs" CounterElement are not found.


getCurrency

public java.lang.String getCurrency()
                             throws DSEObjectNotFoundException
Deprecated. 
Returns the "currency" element value of the CashDrawer.

This method throws a DSEObjectNotFoundException if the "currency" element is not found.


getFormat

public java.lang.String getFormat()
                           throws DSEObjectNotFoundException
Deprecated. 
Returns the "format" element value of the CashDrawer.

This method throws a DSEObjectNotFoundException if the "format" element is not found.


getIsAssigned

public java.lang.String getIsAssigned()
                               throws DSEObjectNotFoundException
Deprecated. 
Returns the "isAssigned" element state of the CashDrawer.

This method throws a DSEObjectNotFoundException if the "isAssigned" element is not found.


getIsSettled

public java.lang.String getIsSettled()
                              throws DSEObjectNotFoundException
Deprecated. 
Returns the "isSettled" element state of the CashDrawer.

This method throws a DSEObjectNotFoundException if the "isSettled" element is not found.


getType

public java.lang.String getType()
                         throws DSEObjectNotFoundException
Deprecated. 
Returns the "type" element value of the CashDrawer.

This method throws a DSEObjectNotFoundException if the "type" element is not found.


getUserid

public java.lang.String getUserid()
                           throws DSEObjectNotFoundException
Deprecated. 
Returns the "userid" element value of the CashDrawer.

This method throws a DSEObjectNotFoundException if the "userid" element is not found.


initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Deprecated. 
Returns the cashDrawer implemented by the Tag aTag.

This method throws an IOException if the externalizer hasn't been initialized.

Overrides:
initializeFrom in class KeyedCollection
Tags copied from class: KeyedCollection
Parameters:
aTag - Tag
Returns:
java.lang.Object

setCashDrawerName

public void setCashDrawerName(java.lang.String aCashDrawerName)
                       throws DSEInvalidArgumentException,
                              DSEObjectNotFoundException
Deprecated. 
Sets the "cashDrawerName" element value of the CashDrawer.

This method throws :

  1. - A DSEObjectNotFoundException if the "cashDrawerName" element is not found.
  2. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setCounterCheckIfRequired

public void setCounterCheckIfRequired(java.lang.String aCounterName,
                                      java.lang.Boolean aBoolean)
                               throws DSEObjectNotFoundException
Deprecated. 
Sets the checkIfRequired state of the Counter named aCounterName.

This method throws a DSEObjectNotFoundException if the aCounterName Counter or its "increment" CounterElement are not found.


setCounterIncrement

public void setCounterIncrement(java.lang.String aCounterName,
                                java.lang.Float aFloat)
                         throws DSECounterException,
                                DSEObjectNotFoundException,
                                DSEInvalidArgumentException
Deprecated. 
Sets Increment value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "increment" counterElement are not found.
  2. - A DSECounterException if the value aFloat is not correct.
  3. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setCounterIncrementMaxLimit

public void setCounterIncrementMaxLimit(java.lang.String aCounterName,
                                        java.lang.Float aFloat)
                                 throws DSECounterException,
                                        DSEObjectNotFoundException
Deprecated. 
Sets Increment maxLimit value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "increment" counterElement are not found.
  2. - A DSECounterException if the maxLimit aFloat is not correct.

setCounterIncrementMinLimit

public void setCounterIncrementMinLimit(java.lang.String aCounterName,
                                        java.lang.Float aFloat)
                                 throws DSECounterException,
                                        DSEObjectNotFoundException
Deprecated. 
Sets Increment minLimit value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "increment" counterElement are not found.
  2. - A DSECounterException if the minLimit aFloat is not correct.

setCounterTotal

public void setCounterTotal(java.lang.String aCounterName,
                            java.lang.Float aFloat)
                     throws DSECounterException,
                            DSEObjectNotFoundException,
                            DSEInvalidArgumentException
Deprecated. 
Sets Total value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "total" counterElement are not found.
  2. - A DSECounterException if the value aFloat is not correct.
  3. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setCounterTotalMaxLimit

public void setCounterTotalMaxLimit(java.lang.String aCounterName,
                                    java.lang.Float aFloat)
                             throws DSECounterException,
                                    DSEObjectNotFoundException
Deprecated. 
Sets Total maxLimit value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "total" counterElement are not found.
  2. - A DSECounterException if the maxLimit aFloat is not correct.

setCounterTotalMinLimit

public void setCounterTotalMinLimit(java.lang.String aCounterName,
                                    java.lang.Float aFloat)
                             throws DSECounterException,
                                    DSEObjectNotFoundException
Deprecated. 
Sets Total minLimit value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "total" counterElement are not found.
  2. - A DSECounterException if the minLimit aFloat is not correct.

setCounterTotIncrs

public void setCounterTotIncrs(java.lang.String aCounterName,
                               java.lang.Float aFloat)
                        throws DSECounterException,
                               DSEObjectNotFoundException,
                               DSEInvalidArgumentException
Deprecated. 
Sets TotIncrs value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "totIncrs" counterElement are not found.
  2. - A DSECounterException if the value aFloat is not correct.
  3. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setCounterTotIncrsMaxLimit

public void setCounterTotIncrsMaxLimit(java.lang.String aCounterName,
                                       java.lang.Float aFloat)
                                throws DSECounterException,
                                       DSEObjectNotFoundException
Deprecated. 
Sets TotIncrs maxLimit value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "totIncrs" counterElement are not found.
  2. - A DSECounterException if the maxLimit aFloat is not correct.

setCounterTotIncrsMinLimit

public void setCounterTotIncrsMinLimit(java.lang.String aCounterName,
                                       java.lang.Float aFloat)
                                throws DSECounterException,
                                       DSEObjectNotFoundException
Deprecated. 
Sets TotIncrs minLimit value of the Counter named aCounterName.

This method throws :

  1. - A DSEObjectNotFoundException if the aCounterName Counter or its "totIncrs" counterElement are not found.
  2. - A DSECounterException if the minLimit aFloat is not correct.

setCurrency

public void setCurrency(java.lang.String aString)
                 throws DSEObjectNotFoundException,
                        DSEInvalidArgumentException
Deprecated. 
Sets the "currency" element value of the CashDrawer.

This method throws :

  1. - A DSEObjectNotFoundException if the "currency" element is not found.
  2. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setDescription

public void setDescription(java.lang.String aDescription)
Deprecated. 
Sets the description value of the CashDrawer.
Overrides:
setDescription in class DataElement
Tags copied from class: DataElement
Parameters:
aDescription - java.lang.String

setFormat

public void setFormat(java.lang.String aFormat)
               throws DSEObjectNotFoundException,
                      DSEInvalidArgumentException
Deprecated. 
Sets the "format" element value of the CashDrawer.

This method throws :

  1. - A DSEObjectNotFoundException if the "format" element is not found.
  2. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setIsAssigned

public void setIsAssigned(java.lang.String aString)
                   throws DSEObjectNotFoundException,
                          DSEInvalidArgumentException
Deprecated. 
Sets the "isAssigned" element state of the CashDrawer.

This method throws :

  1. - A DSEObjectNotFoundException if the "isAssigned" element is not found.
  2. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setIsSettled

public void setIsSettled(java.lang.String aString)
                  throws DSEObjectNotFoundException,
                         DSEInvalidArgumentException
Deprecated. 
Sets the "isSettled" element state of the CashDrawer.

This method throws :

  1. - A DSEObjectNotFoundException if the "isSettled" element is not found.
  2. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setName

public void setName(java.lang.String aName)
Deprecated. 
Sets the name property of the CashDrawer.
Overrides:
setName in class DataElement
Tags copied from class: DataElement
Parameters:
name - The new value for the property.
See Also:
DataElement.getName()

setType

public void setType(java.lang.String aString)
             throws DSEObjectNotFoundException,
                    DSEInvalidArgumentException
Deprecated. 
Sets the "type" element value of the CashDrawer.

This method throws :

  1. - A DSEObjectNotFoundException if the "type" element is not found.
  2. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

setUserid

public void setUserid(java.lang.String aUserID)
               throws DSEObjectNotFoundException,
                      DSEInvalidArgumentException
Deprecated. 
Sets the "userid" element value of the CashDrawer.

This method throws :

  1. - A DSEObjectNotFoundException if the "userid" element is not found.
  2. - A DSEInvalidArgumentException when trying to set the value of a non-DataField component.

toStrings

public Vector toStrings()
Deprecated. 
Returns a Vector with a String representation of the CashDrawer. This method is an Externalizable interface method.
Overrides:
toStrings in class KeyedCollection
Tags copied from class: KeyedCollection
Returns:
Vector