Agent System POND 1.2 (28.2.2002)

FIM.payment
Class VoucherPayment

java.lang.Object
  |
  +--FIM.payment.PaymentBase
        |
        +--FIM.payment.VoucherPayment
All Implemented Interfaces:
Payment, Serializable, XMLEncodeable

public class VoucherPayment
extends PaymentBase

A class representing the payment by providing a voucher (which must be a certificate).

Version:
1.0
Author:
Michael Sonntag
See Also:
Invoice, Serialized Form

Constructor Summary
VoucherPayment()
          Create a new empty object.
VoucherPayment(Element elem)
          Create a new voucher payment from an XML element.
VoucherPayment(Invoice inv, String characteristic, Certificate voucher)
          Create a new voucher payment.
 
Method Summary
 void decodeXMLElement(Element elem)
          Parse back the payment from an XML element.
 Element getAsXMLElement(Document doc)
          Retrieve the payment as an XML element.
 byte[] getEncoded()
          Retrieve the payment in encoded form to be used for signing.
 Certificate getVoucher()
          Retrieve the voucher.
 String toString()
          Retrieve the payment as a string, suitable for presenting to the user in a very simple form.
 
Methods inherited from class FIM.payment.PaymentBase
characteristics, getAsSerializable, getCertificate, getInvoice, isSigned, sign, verifySignature, verifySignature
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VoucherPayment

public VoucherPayment()
Create a new empty object. To be used for parsing in XML data later. Must be public so it can be created by factory methods.

VoucherPayment

public VoucherPayment(Invoice inv,
                      String characteristic,
                      Certificate voucher)
Create a new voucher payment.
Parameters:
invoice - the invoice this payment is for
characteristic - the description of the content
voucher - the voucher

VoucherPayment

public VoucherPayment(Element elem)
Create a new voucher payment from an XML element.
Parameters:
elem - the XML element containing the encoded form
Method Detail

getVoucher

public Certificate getVoucher()
Retrieve the voucher.
Returns:
the voucher

toString

public String toString()
Retrieve the payment as a string, suitable for presenting to the user in a very simple form.
Overrides:
toString in class Object
Returns:
the payment encoded as a string

getEncoded

public byte[] getEncoded()
Retrieve the payment in encoded form to be used for signing. Does NOT include the signing information itself (which will be created based on the result!). Must be exactly the same on all calls and if the content is the same.
Overrides:
getEncoded in class PaymentBase
Returns:
the payment in encoded form

getAsXMLElement

public Element getAsXMLElement(Document doc)
Retrieve the payment as an XML element.
Overrides:
getAsXMLElement in class PaymentBase
Parameters:
doc - the document within which to create the element
Returns:
the currency as an element

decodeXMLElement

public void decodeXMLElement(Element elem)
                      throws IllegalArgumentException
Parse back the payment from an XML element.
Overrides:
decodeXMLElement in class PaymentBase
Parameters:
elem - the element containing the currency to parse back
Throws:
IllegalArgumentException - if the element is incorrect (e. g. wrong tag name)

Agent System POND 1.2 (28.2.2002)

Submit a bug

Copyright 2001,2002 Michael Sonntag & Institute for Information Processing and Microprocessor Technology (FIM), Johannes-Kepler-University Linz, Altenbergerstr. 69, A-4040 Linz, Austria.