|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.DSENotifier | +--com.ibm.dse.base.Service | +--com.ibm.dse.services.fpprint.FormsPathService
The FormsPathService class implements the interface of a print service using the FormsPath. It has two different ways of working: through named pipes (mode="pipe") or through files (mode="file").
Field Summary | |
protected java.util.Vector |
aFPPrintListener
Contains a set of Listener of FPEvent event. |
static java.lang.String |
COMPID
The component id. |
Fields inherited from class com.ibm.dse.base.Service |
externalizer |
Fields inherited from class com.ibm.dse.base.DSENotifier |
handlersList,
name |
Constructor Summary | |
FormsPathService()
This constructor creates a FormsPathService object. |
|
FormsPathService(java.lang.String aName)
This constructor creates a FormsPathService object. |
Method Summary | |
void |
addHandler(Handler aHandler,
java.lang.String anEventName)
Adds a aHandler to the chain of handlers for the specific instance of DSENotifier. |
protected void |
firePrintJobCompleted(com.qic.FPPrint.FPEvent arg1)
Supports listener events. |
java.util.Vector |
getJobListPrintingResults()
Returns a vector of keyed collections, which contains the information available for each of the jobs that have been sent to the printer. |
KeyedCollection |
getJobResult(long aJobId)
Returns a keyed collection with all the available information for a job, given its identifier. |
int |
getJobsCurrentlyProcessing()
Returns the number of jobs that have not been completed yet. |
long |
getJobsListQueueLength()
Gets the JobListQueueLength attribute. |
int |
getStatus()
Returns the current status of the printer. |
void |
initialize()
Initializes the printer device. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes a FormsPath service object with the Tag attributes. |
boolean |
isJobCompleted(long aJobId)
Returns true if the job with a given ID has already been printed. |
long |
printForm(FormsRecordFormat aFormat,
Context aContext)
Formats a context with a given format of type FormsRecordFormat and then performs the asynchronous print with the resulting String. |
long |
printForm(java.lang.String data)
Performs the asynchronous print. |
long |
printForm(java.lang.String aFormatName,
Context aContext)
Performs the asynchronous print. |
void |
printFormAndWait(FormsRecordFormat aFormat,
Context aContext)
Formats a context with a format of type FormsRecordFormat and then performs the synchronous print with the resulting String. |
void |
printFormAndWait(java.lang.String data)
Performs the synchronous print operation. |
void |
printFormAndWait(java.lang.String aFormatName,
Context aContext)
Instantiates a FormsRecordFormat, given its name, and uses it to format a context. |
void |
printJobCompleted(com.qic.FPPrint.FPEvent event)
Handles the com.qic.FPPrint.FPEvent. |
void |
removeFPPrintListener(com.qic.FPPrint.FPListener newListener)
Removes a FPPrint.FPPrintListener. |
void |
setFilePath(java.lang.String aFilePath)
Sets the file path attribute. |
void |
setFormName(java.lang.String aFormName)
Sets the compiledFormName property. |
void |
setMode(java.lang.String aMode)
Sets the mode attribute. |
void |
setPrinterName(java.lang.String aPrinterName)
Sets the printerName property. |
void |
setServerName(java.lang.String param1)
Sets the serverName property. |
void |
shutdown()
Closes the print service, which means that no more jobs are going to be printed. |
java.lang.String |
toString()
Returns an XML representation of this print service. |
Methods inherited from class com.ibm.dse.base.Service |
externalizer,
getExternalizer,
getTagName,
readExternal,
readExternal,
readObject,
removeExternal,
setExternalizer,
terminate,
toStrings,
toTags,
writeExternal,
writeExternal |
Methods inherited from class com.ibm.dse.base.DSENotifier |
getHandlersList,
getName,
removeHandler,
setName,
signalEvent,
signalEvent,
signalEvent |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected transient java.util.Vector aFPPrintListener
public static final java.lang.String COMPID
Constructor Detail |
public FormsPathService()
public FormsPathService(java.lang.String aName) throws java.io.IOException
aName
- java.lang.String, the value to the name attribute of DSENotifierMethod Detail |
public void addHandler(Handler aHandler, java.lang.String anEventName) throws DSEInvalidArgumentException
The handler is located in the first position of the chain so it will be the first handler to receive the event when signaled.
The handler is added to the chain of handlers using this operation and is registered for the event anEventName to be signaled by the DSENotifier. If it is interested in any event signaled by this notifier then the event name must be set to "allEvents". This method generates a DSEInvalidArgumentException when aHandler, or anEventName, is null.
aHandler
- HandleranEventName
- Stringprotected void firePrintJobCompleted(com.qic.FPPrint.FPEvent arg1)
public java.util.Vector getJobListPrintingResults()
public KeyedCollection getJobResult(long aJobId) throws DSEJobNotFoundException
jobId
- long, the long that represents the job IDpublic int getJobsCurrentlyProcessing()
public long getJobsListQueueLength()
public int getStatus()
ERROR (-1): Printer has not been correctly initialized.
OK (0): Printer has been initialized.
RESET (1): The printer has been shutdown. This is the initial status of the printer.
public void initialize() throws DSEPrinterException
public java.lang.Object initializeFrom(Tag aTag) throws DSEInvalidArgumentException
aTag
- com.ibm.dse.base.Tag, the Tagpublic boolean isJobCompleted(long aJobId) throws DSEJobNotFoundException
jobId
- long, the long that represents the job ID about which we want to askpublic long printForm(FormsRecordFormat aFormat, Context aContext) throws DSEPrinterException, DSEException
aFormat
- com.ibm.dse.services.formsprint.FormsRecordFormat, the provided formataContext
- com.ibm.dse.base.Context, the context to be formatedpublic long printForm(java.lang.String data) throws DSEPrinterException
data
- java.lang.String, the data that must be sent to the printerpublic long printForm(java.lang.String aFormatName, Context aContext) throws DSEPrinterException, DSEException, java.io.IOException
aFormatName
- java.lang.String, the name of the FormsRecordFormat format to instantiateaContext
- com.ibm.dse.base.Context, the context to be formatedpublic void printFormAndWait(FormsRecordFormat aFormat, Context aContext) throws DSEPrinterException, DSEException
aFormat
- com.ibm.dse.services.formsprint.FormsRecordFormat, the provided formataContext
- com.ibm.dse.base.Context, the context to be formatedpublic void printFormAndWait(java.lang.String data) throws DSEPrinterException
data
- java.lang.String, the data that must be sent to the printer devicepublic void printFormAndWait(java.lang.String aFormatName, Context aContext) throws DSEPrinterException, DSEException, java.io.IOException
aFormatName
- java.lang.String, the name of the FormsRecordFormat to instantiateaContext
- com.ibm.dse.base.Context, the context to be formatedpublic void printJobCompleted(com.qic.FPPrint.FPEvent event)
event
- com.qic.FPPrint.FPEvent, the event to handlepublic void removeFPPrintListener(com.qic.FPPrint.FPListener newListener)
newListener
- com.qic.FPPrint.FPListener, the Listener to removepublic void setFilePath(java.lang.String aFilePath)
aName
- java.lang.String, the file path valuepublic void setFormName(java.lang.String aFormName)
aFormName
- java.lang.String, the compiled form namepublic void setMode(java.lang.String aMode)
aMode
- java.lang.String, the mode valuepublic void setPrinterName(java.lang.String aPrinterName)
aPrinterName
- java.lang.String, the resource name of the printerpublic void setServerName(java.lang.String param1)
param1
- java.lang.String, the hostname of the quality printing serverpublic void shutdown()
public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |