Package de.gmxhome.conrad.jpos.jpos_base.electronicjournal

Interface ElectronicJournalInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

ElectronicJournal, ElectronicJournalProperties

public interface ElectronicJournalInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the ElectronicJournal device category. For details about properties, methods and method parameters, see UPOS specification, chapter Electronic Journal. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	addMarker(String marker)	Final part of AddMarker method.
void	cancelPrintContent()	Final part of CancelPrintContent method.
void	cancelQueryContent()	Final part of CancelQueryContent method.
EraseMedium	eraseMedium()	Validation part of EraseMedium method.
void	eraseMedium(EraseMedium request)	Final part of EraseMedium method.
void	initializeMedium(InitializeMedium request)	Final part of InitializeMedium method.
InitializeMedium	initializeMedium(String mediumID)	Validation part of InitializeMedium method.
void	printContent(PrintContent request)	Final part of PrintContent method.
PrintContent	printContent(String fromMarker, String toMarker)	Validation part of PrintContent method.
void	printContentFile(PrintContentFile request)	Final part of PrintContentFile method.
PrintContentFile	printContentFile(String fileName)	Validation part of PrintContentFile method.
void	queryContent(QueryContent request)	Final part of QueryContent method.
QueryContent	queryContent(String fileName, String fromMarker, String toMarker)	Validation part of QueryContent method.
void	resumePrintContent()	Final part of ResumePrintContent method.
void	resumeQueryContent()	Final part of ResumeQueryContent method.
void	retrieveCurrentMarker(int markerType, String[] marker)	Final part of RetrieveCurrentMarker method.
void	retrieveMarker(int markerType, int sessionNumber, int documentNumber, String[] marker)	Final part of RetrieveMarker method.
void	retrieveMarkerByDateTime(int markerType, String dateTime, String markerNumber, String[] marker)	Final part of RetrieveMarkerByDateTime method.
void	retrieveMarkersDateTime(String marker, String[] dateTime)	Final part of RetrieveMarkersDateTime method.
void	station(int station)	Final part of setting Station.
void	storageEnabled(boolean flag)	Final part of setting StorageEnabled.
void	suspendPrintContent()	Final part of SuspendPrintContent method.
void	suspendQueryContent()	Final part of SuspendQueryContent method.
void	waterMark(boolean flag)	Final part of setting WaterMark.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

station

void station(int station)
      throws jpos.JposException

Final part of setting Station. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• All bits set in station are set in CapStation as well,
• internal property AllowAlwaysSetProperties is true or station equals the previous value of Station.

Parameters:

station - Station for subsequent storing data into journal.

Throws:

jpos.JposException - If an error occurs.

storageEnabled

void storageEnabled(boolean flag)
             throws jpos.JposException

Final part of setting StorageEnabled. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapStorageEnabled is true or flag is true.

Parameters:

flag - New StorageEnabled value.

Throws:

jpos.JposException - If an error occurs.

waterMark

void waterMark(boolean flag)
        throws jpos.JposException

Final part of setting WaterMark. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapWaterMark is true or flag is false,
• internal property AllowAlwaysSetProperties is true or flag equals the previous value of WaterMark.

Parameters:

flag - New WaterMark value.

Throws:

jpos.JposException - If an error occurs.

addMarker

void addMarker(String marker)
        throws jpos.JposException

Final part of AddMarker method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapAddMarker is true.

Parameters:

marker - Marker identifier.

Throws:

jpos.JposException - If an error occurs.

eraseMedium

EraseMedium eraseMedium()
                 throws jpos.JposException

Validation part of EraseMedium method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapErasableMedium is true,
• CapMediumIsAvailable is false or MediumIsAvailable is true.

Returns:

EraseMedium object for use in final part.

Throws:

jpos.JposException - If an error occurs.

eraseMedium

void eraseMedium(EraseMedium request)
          throws jpos.JposException

Final part of EraseMedium method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a EraseMedium object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by EraseMedium.

Throws:

jpos.JposException - If an error occurs.

initializeMedium

InitializeMedium initializeMedium(String mediumID)
                           throws jpos.JposException

Validation part of InitializeMedium method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapInitializeMedium is true,
• mediumID in not null.

Parameters:

mediumID - Medium identifier.

Returns:

InitializeMedium object for use in final part.

Throws:

jpos.JposException - If an error occurs.

initializeMedium

void initializeMedium(InitializeMedium request)
               throws jpos.JposException

Final part of InitializeMedium method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a InitializeMedium object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by InitializeMedium.

Throws:

jpos.JposException - If an error occurs.

printContent

PrintContent printContent(String fromMarker,
 String toMarker)
                   throws jpos.JposException

Validation part of PrintContent method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapPrintContent is true,
• Neither fromMarker nor toMarker is null.

Parameters:

fromMarker - Marker that marks start position of data to be printed.

toMarker - Marker that marks end position of data to be printed.

Returns:

PrintContent object for use in final part.

Throws:

jpos.JposException - If an error occurs.

printContent

void printContent(PrintContent request)
           throws jpos.JposException

Final part of PrintContent method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintContent object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by PrintContent.

Throws:

jpos.JposException - If an error occurs.

printContentFile

PrintContentFile printContentFile(String fileName)
                           throws jpos.JposException

Validation part of PrintContentFile method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapPrintContentFile is true,
• fileName is not null.

Parameters:

fileName - Name of file that contains printing data.

Returns:

PrintContentFile object for use in final part.

Throws:

jpos.JposException - If an error occurs.

printContentFile

void printContentFile(PrintContentFile request)
               throws jpos.JposException

Final part of PrintContentFile method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintContentFile object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by PrintContentFile.

Throws:

jpos.JposException - If an error occurs.

queryContent

QueryContent queryContent(String fileName,
 String fromMarker,
 String toMarker)
                   throws jpos.JposException

Validation part of QueryContent method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• fileName is not null,
• Neither fromMarker nor toMarker is null.

Parameters:

fileName - Filename to be used to store queried contents.

fromMarker - Name of lower bound marker.

toMarker - Name of upper bound marker.

Returns:

QueryContent object for use in final part.

Throws:

jpos.JposException - If an error occurs.

queryContent

void queryContent(QueryContent request)
           throws jpos.JposException

Final part of QueryContent method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a QueryContent object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by QueryContent.

Throws:

jpos.JposException - If an error occurs.

cancelPrintContent

void cancelPrintContent()
                 throws jpos.JposException

Final part of CancelPrintContent method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapSuspendPrintContent is true,
• Suspended is true.

Throws:

jpos.JposException - If an error occurs.

cancelQueryContent

void cancelQueryContent()
                 throws jpos.JposException

Final part of CancelQueryContent method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapSuspendQueryContent is true,
• Suspended is true.

Throws:

jpos.JposException - If an error occurs.

resumePrintContent

void resumePrintContent()
                 throws jpos.JposException

Final part of ResumePrintContent method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapSuspendPrintContent is true,
• Suspended is true.

Throws:

jpos.JposException - If an error occurs.

resumeQueryContent

void resumeQueryContent()
                 throws jpos.JposException

Final part of ResumeQueryContent method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapSuspendQueryContent is true,
• Suspended is true.

Throws:

jpos.JposException - If an error occurs.

retrieveCurrentMarker

void retrieveCurrentMarker(int markerType,
 String[] marker)
                    throws jpos.JposException

Final part of RetrieveCurrentMarker method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• marker is a String array of length 1,
• CapRetrieveCurrentMarker is true,
• marterType is one of MT_SESSION_BEG, MT_SESSION_END, MT_DOCUMENT, MT_HEAD or MT_TAIL.

Parameters:

markerType - Specifies the type of the queried current marker.

marker - Contains the return value, the implementation specific marker.

Throws:

jpos.JposException - If an error occurs.

retrieveMarker

void retrieveMarker(int markerType,
 int sessionNumber,
 int documentNumber,
 String[] marker)
             throws jpos.JposException

Final part of RetrieveMarker method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• marker is a String array with length 1,
• CapRetrieveMarker is true,
• markerType is one of MT_SESSION_BEG, MT_SESSION_END or MT_DOCUMENT,
• documentNumber is ≥ 0.

Parameters:

markerType - Specifies the type of the queried marker.

sessionNumber - Contains the number of the session the marker is queried for.

documentNumber - Contains the number of the document the marker is queried.

marker - Contains the return value, the implementation specific marker.

Throws:

jpos.JposException - If an error occurs.

retrieveMarkerByDateTime

void retrieveMarkerByDateTime(int markerType,
 String dateTime,
 String markerNumber,
 String[] marker)
                       throws jpos.JposException

Final part of RetrieveMarkerByDateTime method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• Neither dateTime normarkerNumber is null,
• marker is a String array of length 1,
• CapRetrieveMarkerByDateTime is true,
• markerType is one of MT_SESSION_BEG, MT_SESSION_END or MT_DOCUMENT,
• dateTime consists of a valid date and - if present - a valid time,
• markerNumber is numeric, the value is ≥ 1,

Parameters:

markerType - Specifies the type of the queried marker.

dateTime - The date-time period the marker is queried for.

markerNumber - The number of the marker which has to be queried.

marker - Contains the return value, the implementation specific marker.

Throws:

jpos.JposException - If an error occurs.

retrieveMarkersDateTime

void retrieveMarkersDateTime(String marker,
 String[] dateTime)
                      throws jpos.JposException

Final part of RetrieveMarkersDateTime method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• marker is not null,
• dateTime is a String array of length 1,
• CapRetrieveMarkersDateTime is true.

Parameters:

marker - Specifies the marker for which the time has to be determined.

dateTime - Contains the return value, the date and time string of the given marker.

Throws:

jpos.JposException - If an error occurs.

suspendPrintContent

void suspendPrintContent()
                  throws jpos.JposException

Final part of SuspendPrintContent method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• State is S_BUSY,
• CapSuspendPrintContent is true,
• Suspended is false.

Throws:

jpos.JposException - If an error occurs.

suspendQueryContent

void suspendQueryContent()
                  throws jpos.JposException

Final part of SuspendQueryContent method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• State is S_BUSY,
• CapSuspendQueryContent is true,
• Suspended is false.

Throws:

jpos.JposException - If an error occurs.