com.highdeal.pnr.tif

Interface ITransactionField<E>

Type Parameters:

E - generic class of the transaction field

All Known Implementing Classes:

ITransactionField.BooleanTransactionField, ITransactionField.ChargedTransactionAccessibleFieldSet.AccountCodeField, ITransactionField.ChargedTransactionAccessibleFieldSet.AccountTypeCodeField, ITransactionField.ChargedTransactionAccessibleFieldSet.AccountTypeNameField, ITransactionField.ChargedTransactionAccessibleFieldSet.AmountField, ITransactionField.ChargedTransactionAccessibleFieldSet.BaseAmountField, ITransactionField.ChargedTransactionAccessibleFieldSet.CreditorIdField, ITransactionField.ChargedTransactionAccessibleFieldSet.DateDetailRecordField, ITransactionField.ChargedTransactionAccessibleFieldSet.DateField, ITransactionField.ChargedTransactionAccessibleFieldSet.DebtorIdField, ITransactionField.ChargedTransactionAccessibleFieldSet.ExternalAccountCodeField, ITransactionField.ChargedTransactionAccessibleFieldSet.ExternalAccountNameField, ITransactionField.ChargedTransactionAccessibleFieldSet.IsCredit, ITransactionField.ChargedTransactionAccessibleFieldSet.IsDebit, ITransactionField.ChargedTransactionAccessibleFieldSet.NumberDetailRecordField, ITransactionField.ChargedTransactionAccessibleFieldSet.PrepaidAccountNameField, ITransactionField.ChargedTransactionAccessibleFieldSet.PrepaidBalanceAmount, ITransactionField.ChargedTransactionAccessibleFieldSet.ServiceProviderField, ITransactionField.ChargedTransactionAccessibleFieldSet.StringDetailRecordField, ITransactionField.ChargedTransactionAccessibleFieldSet.SubscriberAccountCodeField, ITransactionField.ChargedTransactionAccessibleFieldSet.SubscriberAccountReferenceField, ITransactionField.ChargedTransactionAccessibleFieldSet.TaxAmountField, ITransactionField.ChargedTransactionAccessibleFieldSet.TaxCodeField, ITransactionField.ChargedTransactionAccessibleFieldSet.TaxDetailField, ITransactionField.ChargedTransactionAccessibleFieldSet.TaxStatusCodeField, ITransactionField.ChargedTransactionAccessibleFieldSet.TaxStatusIdField, ITransactionField.ChargedTransactionAccessibleFieldSet.TotalAmountField, ITransactionField.ChargedTransactionAccessibleFieldSet.TransactionIdField, ITransactionField.ChargedTransactionAccessibleFieldSet.TransactionIdStringField, ITransactionField.ChargedTransactionSetAccessibleFieldSet.ChargeableItemIdField, ITransactionField.ChargedTransactionSetAccessibleFieldSet.ChargeableItemIdTypeField, ITransactionField.ChargedTransactionSetAccessibleFieldSet.EventProcessingDate, ITransactionField.ChargedTransactionSetAccessibleFieldSet.IsChargeableItemExportedChargingOutputField, ITransactionField.ChargedTransactionSetAccessibleFieldSet.JobIdSenderContextField, ITransactionField.ChargedTransactionSetAccessibleFieldSet.TransactionSetIDField, ITransactionField.ChargedTransactionSetAccessibleFieldSet.TransactionSetIDStringField, ITransactionField.ChargedTransactionSetAccessibleFieldSet.TransactionSetIDTypeField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.ChargeTypeCodeField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.ChargeTypeNameField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.IsPrepaidField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.IsPrepaidRefillField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.IsPrepaidUsageField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.IsTaxIncludedField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.LabelField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.MasterFlagField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.TaxAmountField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.TaxCodeField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.TaxDetailField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.TaxDetTypeField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.TaxStatusCodeField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.TaxStatusIdField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.TotalAmountField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.VatBusinessCategoryField, ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet.VatTaxationPlaceField, ITransactionField.DateTransactionField, ITransactionField.EmptyAccessibleFieldSet.EmptyBooleanField, ITransactionField.EmptyAccessibleFieldSet.EmptyDateField, ITransactionField.EmptyAccessibleFieldSet.EmptyNumberField, ITransactionField.EmptyAccessibleFieldSet.EmptyStringField, ITransactionField.NumberTransactionField, ITransactionField.ParametrableBooleanTransactionField, ITransactionField.ParametrableDateTransactionField, ITransactionField.ParametrableNumberTransactionField, ITransactionField.ParametrableStringTransactionField, ITransactionField.StringTransactionField, ITransactionField.TransactionAccessibleFieldSet.AmountCurrencyCodeField, ITransactionField.TransactionAccessibleFieldSet.AmountField, ITransactionField.TransactionAccessibleFieldSet.AmountIsoCurrencyCodeField, ITransactionField.TransactionAccessibleFieldSet.BooleanDetailRecordField, ITransactionField.TransactionAccessibleFieldSet.ChargeCodeField, ITransactionField.TransactionAccessibleFieldSet.ContractTypeField, ITransactionField.TransactionAccessibleFieldSet.DateDependentDetailRecordField, ITransactionField.TransactionAccessibleFieldSet.DateDetailRecordField, ITransactionField.TransactionAccessibleFieldSet.DispatchCode1Field, ITransactionField.TransactionAccessibleFieldSet.DispatchCode2Field, ITransactionField.TransactionAccessibleFieldSet.DispatchCode3Field, ITransactionField.TransactionAccessibleFieldSet.EventDateField, ITransactionField.TransactionAccessibleFieldSet.ExcludedRecurringPeriodStopDateField, ITransactionField.TransactionAccessibleFieldSet.GrossPriceFlagField, ITransactionField.TransactionAccessibleFieldSet.IncludedRecurringPeriodStopDateField, ITransactionField.TransactionAccessibleFieldSet.IsAllowanceField, ITransactionField.TransactionAccessibleFieldSet.IsClient, ITransactionField.TransactionAccessibleFieldSet.IsPartner, ITransactionField.TransactionAccessibleFieldSet.IsProrated, ITransactionField.TransactionAccessibleFieldSet.IsRefund, ITransactionField.TransactionAccessibleFieldSet.LabelField, ITransactionField.TransactionAccessibleFieldSet.NumberDetailRecordField, ITransactionField.TransactionAccessibleFieldSet.OfferCodeField, ITransactionField.TransactionAccessibleFieldSet.OperationTypeField, ITransactionField.TransactionAccessibleFieldSet.OriginField, ITransactionField.TransactionAccessibleFieldSet.ReservationUIDField, ITransactionField.TransactionAccessibleFieldSet.SessionIDField, ITransactionField.TransactionAccessibleFieldSet.StringDetailRecordField, ITransactionField.TransactionAccessibleFieldSet.SubscriptionCodeField

public interface ITransactionField<E>

This Java interface describes a transaction field, i.e. a field accessible from a charged transaction set, an entry in a charged transaction set, a charged transaction, or a rated transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ITransactionField.BadFieldException This abstract Java class represents an exception that is thrown if a transaction field cannot be accessed; Consider the direct known subclasses.
static class	ITransactionField.BooleanTransactionField This class is used to create transaction field with type Boolean.
static class	ITransactionField.ChargedTransactionAccessibleFieldSet
static class	ITransactionField.ChargedTransactionSetAccessibleFieldSet
static class	ITransactionField.ChargedTransactionSetEntryAccessibleFieldSet
static class	ITransactionField.DateTransactionField This class is used to create transaction field with type Date.
static class	ITransactionField.EmptyAccessibleFieldSet
static class	ITransactionField.InvalidArgumentValueException Exception thrown
static class	ITransactionField.InvalidTypeFieldException Exception thrown when a transaction field does not contain a value with defined expected type.
static class	ITransactionField.InvalidValueException Exception thrown when a transaction field does not contain a value that is compatible with this field.
static interface	ITransactionField.ITransactionFieldParametrable<T> This Java interface is used to create a transaction field that can be set with a parameter.
static class	ITransactionField.MissingMandatoryArgumentException Exception thrown when a transaction field cannot be accessed because one of charged transaction set, charged transaction set entry, charged transaction or transaction is not provided.
static class	ITransactionField.NumberTransactionField This class is used to create transaction field with type BigDecimal.
static class	ITransactionField.ParametrableBooleanTransactionField This abstract class is used to create parametrable transaction field with type Boolean.
static class	ITransactionField.ParametrableDateTransactionField This abstract class is used to create parametrable transaction field with type Date.
static class	ITransactionField.ParametrableNumberTransactionField This abstract class is used to create parametrable transaction field with type BigDecimal.
static class	ITransactionField.ParametrableStringTransactionField This abstract class is used to create a parametrable transaction field with type String.
static class	ITransactionField.StringTransactionField This abstract class is used to create transaction field with type String.
static class	ITransactionField.TransactionAccessibleFieldSet
static class	ITransactionField.TransactionFieldSet This class defines a set of transaction fields.

Method Summary

Modifier and Type	Method and Description
E	get(ChargedTransactionSet set, ChargedTransactionSet.ChargedTransactionSetEntry entry, ChargedTransaction chargedTransaction, Transaction transaction) Retrieves, whether from a charged transaction set, a charged transaction set entry, a charged transaction or a transaction the value of a transaction field and returns it.
java.lang.Object	getFlag(ChargedTransactionSet set, ChargedTransactionSet.ChargedTransactionSetEntry entry, ChargedTransaction chargedTransaction, Transaction transaction) Returns an object to be used as flag for later processing if needed.
com.highdeal.pnr.domain.TransactionFieldType	getType() The type of the transaction field; Transaction field type cannot be null.

Method Detail

get

E get(ChargedTransactionSet set,
      ChargedTransactionSet.ChargedTransactionSetEntry entry,
      ChargedTransaction chargedTransaction,
      Transaction transaction)
throws ITransactionField.BadFieldException

Retrieves, whether from a charged transaction set, a charged transaction set entry, a charged transaction or a transaction the value of a transaction field and returns it.

Parameters:

set - The charged transaction set

entry - The charged transaction set entry

chargedTransaction - The charged transaction

transaction - The rated transaction

Returns:

The value contained in targeted field

Throws:

ITransactionField.MissingMandatoryArgumentException - this exception is thrown if a field, mandatory to retrieve the value of targeted field, is missing.

ITransactionField.BadFieldException - this exception is thrown if failure is not caused by a mandatory field missing or an empty field.

getFlag

java.lang.Object getFlag(ChargedTransactionSet set,
                         ChargedTransactionSet.ChargedTransactionSetEntry entry,
                         ChargedTransaction chargedTransaction,
                         Transaction transaction)
                  throws ITransactionField.BadFieldException

Returns an object to be used as flag for later processing if needed.

Parameters:

set - The charged transaction set

entry - The charged transaction set entry

chargedTransaction - The charged transaction

transaction - The rated transaction

Returns:

An object to be used as flag for later processing, or null if no such flag is needed

Throws:

ITransactionField.BadFieldException - this exception is thrown if the flag cannot be computed

getType

com.highdeal.pnr.domain.TransactionFieldType getType()

The type of the transaction field; Transaction field type cannot be null.

Returns:

The type of the property