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

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

public class LabelPrint
extends AbstractXmlObject

A LabelPrint is an object that is held within a PrintDetails object to hold all of the details of a print job submission.

See Also:
PrintDetails, LabelList

Field Summary
static java.lang.String LABEL_PRINT
          xml tag name used to describe LabelPrint object
static java.lang.String PRINT_MODE_NORMAL
          represents the correct print mode String for a "normal" print job (default)
static java.lang.String PRINT_MODE_REPRINT
          represents the correct print mode String for a "reprint" print job
static java.lang.String PRINT_MODE_TEST
          represents the correct print mode String for a "test" print job
 
Fields inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject
attributes_, EQ, GT, LT, QUOTE, SLASH, tagName_, XML_START
 
Constructor Summary
LabelPrint()
          base constructor, creates empty LabelPrint
LabelPrint(java.lang.String xml)
          Creates a LabelPrint based on the specified XML string
 
Method Summary
 java.lang.String getBusinessRefId()
          Gets the business reference ID
 java.lang.String getDescription()
          Gets the description
 LabelList getLabelList()
          Gets the LabelList
 java.lang.String getPrinterName()
          Gets the printer name
 java.lang.String getPrintMode()
          returns the print mode for this label printing.
 java.lang.String getProfileName()
          Gets the profile name
 void setBusinessRefId(java.lang.String s)
          Sets the business reference ID
 void setDescription(java.lang.String s)
          Sets the description
 void setLabelList(LabelList labelList)
          Sets the LabelList
 void setPrinterName(java.lang.String s)
          Sets the printer name
 void setPrintMode(java.lang.String s)
          sets the print mode for this label printing.
 void setProfileName(java.lang.String s)
          Sets the profile name
 java.lang.String toXmlString(boolean isTop)
          Converts the object to XML
 
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

LABEL_PRINT

public static final java.lang.String LABEL_PRINT
xml tag name used to describe LabelPrint object

See Also:
toXmlString(boolean), Constant Field Values

PRINT_MODE_NORMAL

public static final java.lang.String PRINT_MODE_NORMAL
represents the correct print mode String for a "normal" print job (default)

See Also:
Constant Field Values

PRINT_MODE_REPRINT

public static final java.lang.String PRINT_MODE_REPRINT
represents the correct print mode String for a "reprint" print job

See Also:
Constant Field Values

PRINT_MODE_TEST

public static final java.lang.String PRINT_MODE_TEST
represents the correct print mode String for a "test" print job

See Also:
Constant Field Values
Constructor Detail

LabelPrint

public LabelPrint()
base constructor, creates empty LabelPrint


LabelPrint

public LabelPrint(java.lang.String xml)
           throws XmlConvertException
Creates a LabelPrint based on the specified XML string

Parameters:
xml -
Throws:
XmlConvertException
Method Detail

setPrintMode

public void setPrintMode(java.lang.String s)
sets the print mode for this label printing.

Parameters:
s - print mode
See Also:
PRINT_MODE_NORMAL, PRINT_MODE_REPRINT, PRINT_MODE_TEST

getPrintMode

public java.lang.String getPrintMode()
returns the print mode for this label printing. If a print mode is not set, this returns the default "NORMAL" setting.

Returns:
print mode
See Also:
PRINT_MODE_NORMAL, PRINT_MODE_REPRINT, PRINT_MODE_TEST

setBusinessRefId

public void setBusinessRefId(java.lang.String s)
Sets the business reference ID

Parameters:
s - business reference ID

getBusinessRefId

public java.lang.String getBusinessRefId()
Gets the business reference ID

Returns:
business reference ID

setDescription

public void setDescription(java.lang.String s)
Sets the description

Parameters:
s - description

getDescription

public java.lang.String getDescription()
Gets the description

Returns:
description

setPrinterName

public void setPrinterName(java.lang.String s)
Sets the printer name

Parameters:
s - printer name

getPrinterName

public java.lang.String getPrinterName()
Gets the printer name

Returns:
printer name

setProfileName

public void setProfileName(java.lang.String s)
Sets the profile name

Parameters:
s - profile name

getProfileName

public java.lang.String getProfileName()
Gets the profile name

Returns:
profile name

getLabelList

public LabelList getLabelList()
Gets the LabelList

Returns:
label list

setLabelList

public void setLabelList(LabelList labelList)
Sets the LabelList

Parameters:
labelList -

toXmlString

public java.lang.String toXmlString(boolean isTop)
Converts the object to XML

Specified by:
toXmlString in class AbstractXmlObject
Parameters:
isTop -
Returns:
the XML string


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