Elexis API documentation
Version 2.1.6 as of December 11 2011

ch.elexis.util
Interface IRnOutputter

All Known Implementing Classes:
DefaultOutputter, RechnungsDrucker, RechnungsDrucker, RechnungsDrucker, XMLExporter

public interface IRnOutputter

An Object that is able to output a bill. Can be a ptinter, a file, an electronic connection or whatever else.

Author:
Gerry

Nested Class Summary
static class IRnOutputter.TYPE
           
 
Field Summary
static java.lang.String PROP_OUTPUT_METHOD
          Property indicating the output method.
 
Method Summary
 boolean canBill(Fall fall)
          check whether a case could be billed, i.e. all billing data are present.
 boolean canStorno(Rechnung rn)
          Cancelling an already output bill: Depending on the type of the outputter, this might result in propagataing the cancel information to the final destination of the bill.
 Control createSettingsControl(Composite parent)
          Create a Control to perform necessary setings for his outputter.
 Result<Rechnung> doOutput(IRnOutputter.TYPE type, java.util.Collection<Rechnung> rnn, java.util.Properties props)
          Do the actual output
 java.lang.String getDescription()
          A short textual description for this output (as Label)
 void saveComposite()
          Methode is called before dialog is closed.
 

Field Detail

PROP_OUTPUT_METHOD

static final java.lang.String PROP_OUTPUT_METHOD
Property indicating the output method. "asDefault" -> The user requested output via default outputter "byName" -> The user requested this outputter by name. If the property is not set, byName will be assumed.

See Also:
Constant Field Values
Method Detail

getDescription

java.lang.String getDescription()
A short textual description for this output (as Label)


doOutput

Result<Rechnung> doOutput(IRnOutputter.TYPE type,
                          java.util.Collection<Rechnung> rnn,
                          java.util.Properties props)
Do the actual output

Parameters:
type - Type of the bill
rnn - collection with all bills to process
props - properties for various purposes. Can be null.
Returns:
a result indicating errors

canStorno

boolean canStorno(Rechnung rn)
Cancelling an already output bill: Depending on the type of the outputter, this might result in propagataing the cancel information to the final destination of the bill.

Parameters:
rn - the specific bill to cancel or null, if it is just a general question
Returns:
true if this outputter wants to be informed if this (or any in case of Rn==null) bill is cancelled. If an outputter does need to react on storno messages, it should return false.

canBill

boolean canBill(Fall fall)
check whether a case could be billed, i.e. all billing data are present. This should only check for required absolutely mandatory data. At output time, the outputter still can reject.

Parameters:
fall - the case to check
Returns:
true if we can send a bill from this case

createSettingsControl

Control createSettingsControl(Composite parent)
Create a Control to perform necessary setings for his outputter.

Parameters:
parent -
Returns:

saveComposite

void saveComposite()
Methode is called before dialog is closed. Used to save the widget contents before the composite is disposed;


Elexis API documentation
Version 2.1.6 as of December 11 2011

Copyright 2005-2011 by Gerry Weirich, Elexis