Textschluessel (jDTAUS Banking ⁑ API 1.16)

java.lang.Object
- org.jdtaus.banking.Textschluessel

All Implemented Interfaces:

Serializable, Cloneable, Comparable
```
public class Textschluessel
extends Object
implements Cloneable, Comparable, Serializable
```
Type of a transaction in germany.
A Textschlüssel is made up of a two-digit positive integer (the key) and a three-digit positive integer (the extension). The key, together with a constant extension, uniquely identifies a transaction's type. The extension may also be used to hold non-identifying data. In such cases only the key is used to identify a transaction's type and the extension holds variable data.

Version:

$JDTAUS: Textschluessel.java 8890 2014-12-08 22:37:57Z schulte $

Author:

Christian Schulte

See Also:
TextschluesselVerzeichnis, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_DEBIT` Constant for the name of property `debit`.
`static String`	`PROP_EXTENSION` Constant for the name of property `extension`.
`static String`	`PROP_KEY` Constant for the name of property `key`.
`static String`	`PROP_REMITTANCE` Constant for the name of property `remittance`.
`static String`	`PROP_SHORTDESCRIPTION` Constant for the name of property `shortDescription`.
`static String`	`PROP_VALID_FROM` Constant for the name of property `validFrom`.
`static String`	`PROP_VALID_TO` Constant for the name of property `validTo`.
`static String`	`PROP_VARIABLE` Constant for the name of property `variable`.

Constructor Summary

Constructors
Constructor and Description

Textschluessel()
Creates a new Textschluessel instance.

Constructors
Constructor and Description
`Textschluessel()` Creates a new `Textschluessel` instance.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates and returns a copy of this object.
`int`	`compareTo(Object o)` Compares this object with the specified object for order.
`boolean`	`equals(Object o)` Indicates whether some other object is equal to this one by comparing the values of all properties.
`int`	`getExtension()` Getter for property `extension`.
`int`	`getKey()` Getter for property `key`.
`Locale[]`	`getLocales()` Gets all locales for which the instance holds short descriptions.
`String`	`getShortDescription(Locale locale)` Gets the short description of the Textschlüssel for a given locale.
`Date`	`getValidFrom()` Gets the date of validity of the Textschlüssel.
`Date`	`getValidTo()` Gets the date of expiration of the Textschlüssel.
`int`	`hashCode()` Returns a hash code value for this object.
`boolean`	`isDebit()` Flag indicating if a transaction of this type is a debit.
`boolean`	`isRemittance()` Flag indicating if a transaction of this type is a remittance.
`boolean`	`isValidAt(Date date)` Gets a flag indicating that the Textschlüssel is valid at a given date.
`boolean`	`isVariable()` Flag indicating if the extension holds non-identifying, variable data.
`void`	`setDebit(boolean value)` Setter for property `debit`.
`void`	`setExtension(int value)` Setter for property `extension`.
`void`	`setKey(int value)` Setter for property `key`.
`void`	`setRemittance(boolean value)` Setter for property `remittance`.
`String`	`setShortDescription(Locale locale, String shortDescription)` Setter for property `shortDescription`.
`void`	`setValidFrom(Date value)` Sets the date of validity of the Textschlüssel.
`void`	`setValidTo(Date value)` Sets the date of expiration of the Textschlüssel.
`void`	`setVariable(boolean value)` Setter for property `variable`.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PROP_DEBIT
```
public static final String PROP_DEBIT
```
    Constant for the name of property debit.
    
    See Also:
    Constant Field Values
  - PROP_EXTENSION
```
public static final String PROP_EXTENSION
```
    Constant for the name of property extension.
    
    See Also:
    Constant Field Values
  - PROP_KEY
```
public static final String PROP_KEY
```
    Constant for the name of property key.
    
    See Also:
    Constant Field Values
  - PROP_REMITTANCE
```
public static final String PROP_REMITTANCE
```
    Constant for the name of property remittance.
    
    See Also:
    Constant Field Values
  - PROP_SHORTDESCRIPTION
```
public static final String PROP_SHORTDESCRIPTION
```
    Constant for the name of property shortDescription.
    
    See Also:
    Constant Field Values
  - PROP_VALID_FROM
```
public static final String PROP_VALID_FROM
```
    Constant for the name of property validFrom.
    
    See Also:
    Constant Field Values
  - PROP_VALID_TO
```
public static final String PROP_VALID_TO
```
    Constant for the name of property validTo.
    
    See Also:
    Constant Field Values
  - PROP_VARIABLE
```
public static final String PROP_VARIABLE
```
    Constant for the name of property variable.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Textschluessel
```
public Textschluessel()
```
    Creates a new Textschluessel instance.
- Method Detail
  - clone
```
public Object clone()
```
    Creates and returns a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    A clone of this instance.
  - compareTo
```
public int compareTo(Object o)
```
    Compares this object with the specified object for order.
    Compares the values of properties key and extension and returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    o - The Object to be compared.
    
    Returns:
    A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Throws:
    
    NullPointerException - if o is null.
    
    ClassCastException - if the specified object's type prevents it from being compared to this Object.
  - equals
```
public boolean equals(Object o)
```
    Indicates whether some other object is equal to this one by comparing the values of all properties.
    The extension will only be compared if it is part of the identifying key based on the value of property variable.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - The reference object with which to compare.
    
    Returns:
    true if this object is the same as o; false otherwise.
  - getExtension
```
public int getExtension()
```
    Getter for property extension.
    
    Returns:
    Extension of the Textschlüssel.
  - getKey
```
public int getKey()
```
    Getter for property key.
    
    Returns:
    Key of the Textschlüssel.
  - getLocales
```
public Locale[] getLocales()
```
    Gets all locales for which the instance holds short descriptions.
    
    Returns:
    All locales for which the instance holds short descriptions.
  - getShortDescription
```
public String getShortDescription(Locale locale)
```
    Gets the short description of the Textschlüssel for a given locale.
    
    Parameters:
    locale - The locale of the short description to return or null for Locale.getDefault().
    
    Returns:
    The short description of the instance for locale.
  - getValidFrom
```
public Date getValidFrom()
```
    Gets the date of validity of the Textschlüssel.
    
    Returns:
    The date the Textschlüssel is valid from (inclusive) or null if nothing is known about the start of validity of the Textschlüssel.
  - getValidTo
```
public Date getValidTo()
```
    Gets the date of expiration of the Textschlüssel.
    
    Returns:
    The date the Textschlüssel is valid to (inclusive) or null if nothing is known about the date of expiration of the Textschlüssel.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    A hash code value for this object.
  - isDebit
```
public boolean isDebit()
```
    Flag indicating if a transaction of this type is a debit.
    
    Returns:
    true if a transaction of this type is a debit; false if not.
  - isRemittance
```
public boolean isRemittance()
```
    Flag indicating if a transaction of this type is a remittance.
    
    Returns:
    true if a transaction of this type is a remittance; false if not.
  - isValidAt
```
public boolean isValidAt(Date date)
```
    Gets a flag indicating that the Textschlüssel is valid at a given date.
    
    Parameters:
    date - The date with which to check.
    
    Returns:
    true, if the Textschlüssel is valid at date; false if not.
    
    Throws:
    
    NullPointerException - if date is null.
  - isVariable
```
public boolean isVariable()
```
    Flag indicating if the extension holds non-identifying, variable data.
    
    Returns:
    true if the extension holds non-identifying, variable data; false if the extension is part of the identifying key.
  - setDebit
```
public void setDebit(boolean value)
```
    Setter for property debit.
    
    Parameters:
    value - true if a transaction of this type is a debit; false if not.
  - setExtension
```
public void setExtension(int value)
```
    Setter for property extension.
    
    Parameters:
    value - New extension of the Textschlüssel.
  - setKey
```
public void setKey(int value)
```
    Setter for property key.
    
    Parameters:
    value - New key of the Textschlüssel.
  - setRemittance
```
public void setRemittance(boolean value)
```
    Setter for property remittance.
    
    Parameters:
    value - true if a transaction of this type is a remittance; false if not.
  - setShortDescription
```
public String setShortDescription(Locale locale,
                         String shortDescription)
```
    Setter for property shortDescription.
    
    Parameters:
    locale - The locale to set the short description for or null for Locale.getDefault().
    shortDescription - The new value for property shortDescription for locale.
    
    Returns:
    The value previously held by the instance for locale or null if the instance previously held no value for locale.
    
    Throws:
    
    NullPointerException - if shortDescription is null.
  - setValidFrom
```
public void setValidFrom(Date value)
```
    Sets the date of validity of the Textschlüssel.
    
    Parameters:
    value - The new date the Textschlüssel is valid from or null if nothing is known about the start of validity of the Textschlüssel.
  - setValidTo
```
public void setValidTo(Date value)
```
    Sets the date of expiration of the Textschlüssel.
    
    Parameters:
    value - The new date the Textschlüssel is valid to or null if nothing is known about the date of expiration of the Textschlüssel.
  - setVariable
```
public void setVariable(boolean value)
```
    Setter for property variable.
    
    Parameters:
    value - true if the extension holds non-identifying, variable data; false if the extension is part of the identifying key.
  - toString
```
public String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of the object.

Class Textschluessel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_DEBIT

PROP_EXTENSION

PROP_KEY

PROP_REMITTANCE

PROP_SHORTDESCRIPTION

PROP_VALID_FROM

PROP_VALID_TO

PROP_VARIABLE

Constructor Detail

Textschluessel

Method Detail

clone

compareTo

equals

getExtension

getKey

getLocales

getShortDescription

getValidFrom

getValidTo

hashCode

isDebit

isRemittance

isValidAt

isVariable

setDebit

setExtension

setKey

setRemittance

setShortDescription

setValidFrom

setValidTo

setVariable

toString