com.ibm.rfid.premises.app.entities.supplychain.printing
Class FormData

java.lang.Object
  extended by com.ibm.rfid.premises.app.entities.AbstractXmlObject
      extended by com.ibm.rfid.premises.app.entities.supplychain.printing.FormData

public class FormData
extends AbstractXmlObject

A form data represents configurable parameters for a physical label in a print job.

For instance, a custom print template may allow for company's name to be printed on the physical label. A possible FormData could be defined as

name = "Company Name"

and

value = "International Business Machines". These FormData pairs are particular to a print template. For instance, the previous example of a FormData may work for one template and not another. It is completely dependent upon the properties of the print template. For more information on these customizable properties, please see your printer manufacturer's documention on how to create customized print templates, or "labels".

FormData objects are contained within the Label object and the LabelList object.

When under a LabelList, the FormData becomes a default FormData for all Label Objects under LabelList.

See Also:
Label, LabelList

Field Summary
static java.lang.String DEFAULT_FORM_DATA
          xml tag name used to represent a default FormData found within a LabelList
static java.lang.String FORM_DATA
          xml tag name used to represent a FormData found within a Label
 
Fields inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject
attributes_, EQ, GT, LT, QUOTE, SLASH, tagName_, XML_START
 
Constructor Summary
FormData()
          Basic Constructor
FormData(java.lang.String xml)
          Constructor that creates a FormData object based on the xml String parameter.
FormData(java.lang.String xml, boolean isDefault)
          Constructor that creates a FormData object based on the xml String parameter.
 
Method Summary
 java.lang.String getName()
          Gets the name of the FormData
 java.lang.String getValue()
          Gets the value for this FormData
 void setDefault(boolean isDefault)
          This function is only used by LabelList to denote whether a FormData object should be a default FormData.
 void setName(java.lang.String s)
          Sets the name of the FormData
 void setValue(java.lang.String s)
          Sets the new value for the FormData
 java.lang.String toXmlString(boolean isTop)
          (non-Javadoc)
 
Methods inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject
getEndTag, getNodeListFromString, getStartTag, getStringFromElement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FORM_DATA

public static final java.lang.String FORM_DATA
xml tag name used to represent a FormData found within a Label

See Also:
Constant Field Values

DEFAULT_FORM_DATA

public static final java.lang.String DEFAULT_FORM_DATA
xml tag name used to represent a default FormData found within a LabelList

See Also:
Constant Field Values
Constructor Detail

FormData

public FormData()
Basic Constructor


FormData

public FormData(java.lang.String xml)
Constructor that creates a FormData object based on the xml String parameter.

Parameters:
xml - is an XML String representation of an FormData object.
isDefault -

FormData

public FormData(java.lang.String xml,
                boolean isDefault)
Constructor that creates a FormData object based on the xml String parameter.

Parameters:
xml - is an XML String representation of an FormData object.
isDefault -
Method Detail

setName

public void setName(java.lang.String s)
Sets the name of the FormData

Parameters:
s - the name of this FormData

getName

public java.lang.String getName()
Gets the name of the FormData

Returns:
the name of this FormData

setValue

public void setValue(java.lang.String s)
Sets the new value for the FormData

Parameters:
s - the new Value for this FormData

getValue

public java.lang.String getValue()
Gets the value for this FormData

Returns:
the value for this FormData

setDefault

public void setDefault(boolean isDefault)
This function is only used by LabelList to denote whether a FormData object should be a default FormData.

Parameters:
isDefault - boolean is this FormData is a default
See Also:
LabelList.addDefaultFormData(FormData)

toXmlString

public java.lang.String toXmlString(boolean isTop)
(non-Javadoc)

Specified by:
toXmlString in class AbstractXmlObject
Parameters:
isTop - decides whether or not the XML_START field is appended to the output of this method. Should be true if this AbstractXmlObject is the root element.
Returns:
an XML String representing this AbstractXmlObject.
See Also:
AbstractXmlObject.toXmlString(boolean)


Copyright © 2005 - 2009 IBM Corp. All Rights Reserved.