Field98D (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.field.Field
- - com.prowidesoftware.swift.model.field.Field98D

All Implemented Interfaces:

DateContainer, PatternContainer, Serializable
```
@Generated
public class Field98D
extends Field
implements Serializable, DateContainer
```
SWIFT MT Field 98D
Model and parser for field 98D of a SWIFT MT message.
Subfields (components) Data types
1. Calendar
2. Calendar
3. Number
4. Currency
5. Calendar
Structure definition
- validation pattern: <DATE4><TIME2>[,3n][/[<N>]<TIME3>]
- parser pattern: <DATE4><TIME2>[,S][/[c]<TIME3>]
- components pattern: DTNCW
This class complies with standard release SRU2017

NOTE: this source code has been generated from template
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`DATE` Component number for the Date subfield
`static Integer`	`DECIMALS` Component number for the Decimals subfield
`static String`	`F_98D` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 98D
`static String`	`PARSER_PATTERN`
`static Integer`	`SIGN` Component number for the Sign subfield
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.
`static Integer`	`TIME` Component number for the Time subfield
`static Integer`	`UTC_INDICATOR` Component number for the UTC Indicator subfield

Fields inherited from class com.prowidesoftware.swift.model.field.Field
components

Constructor Summary

Constructors
Constructor and Description
`Field98D()` Default constructor.
`Field98D(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field98D(Tag tag)` Creates a new field and initializes its components with content from the parameter tag.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`componentsPattern()` Returns the field's components pattern
`int`	`componentsSize()` Returns the defined amount of components. This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.
`List<Calendar>`	`dates()` Get a calendar for every date found
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field98D`	`get(SwiftMessage msg)` Get the first instance of Field98D in the given message.
`static Field98D`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field98D>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field98D in the given message an empty list is returned if none found.
`static List<Field98D>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field98D from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`Calendar`	`getComponent1AsCalendar()` Get the component1 as Calendar
`String`	`getComponent2()` Get the component2
`Calendar`	`getComponent2AsCalendar()` Get the component2 as Calendar
`String`	`getComponent3()` Get the component3
`Number`	`getComponent3AsNumber()` Get the component3 as Number
`String`	`getComponent4()` Get the component4
`Currency`	`getComponent4AsCurrency()` Get the component4 as Currency
`String`	`getComponent5()` Get the component5
`Calendar`	`getComponent5AsCalendar()` Get the component5 as Calendar
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getDate()` Get the Date (component1).
`Calendar`	`getDateAsCalendar()` Get the Date (component1) as Calendar
`String`	`getDecimals()` Get the Decimals (component3).
`Number`	`getDecimalsAsNumber()` Get the Decimals (component3) as Number
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getSign()` Get the Sign (component4).
`Currency`	`getSignAsCurrency()` Get the Sign (component4) as Currency
`String`	`getTime()` Get the Time (component2).
`Calendar`	`getTimeAsCalendar()` Get the Time (component2) as Calendar
`String`	`getUTCIndicator()` Get the UTC Indicator (component5).
`Calendar`	`getUTCIndicatorAsCalendar()` Get the UTC Indicator (component5) as Calendar
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`String`	`getValueDisplay(int component, Locale locale)` Returns a localized suitable for showing to humans string of a field component.
`boolean`	`isGeneric()` Returns true if the field is a GENERIC FIELD as specified by the standard.
`boolean`	`isOptional(int component)` Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message. Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.
`static Field98D`	`newInstance(Field98D source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`void`	`parse(String value)` Parses the parameter value into the internal components structure.
`String`	`parserPattern()`
`Field98D`	`setComponent1(Calendar component1)` Set the component1 from a Calendar object.
`Field98D`	`setComponent1(String component1)` Set the component1.
`Field98D`	`setComponent2(Calendar component2)` Set the component2 from a Calendar object.
`Field98D`	`setComponent2(String component2)` Set the component2.
`Field98D`	`setComponent3(Number component3)` Set the component3 from a Number object.
`Field98D`	`setComponent3(String component3)` Set the component3.
`Field98D`	`setComponent4(Currency component4)` Set the component4 from a Currency object.
`Field98D`	`setComponent4(String component4)` Set the component4.
`Field98D`	`setComponent5(Calendar component5)` Set the component5 from a Calendar object.
`Field98D`	`setComponent5(String component5)` Set the component5.
`Field98D`	`setDate(Calendar component1)` Set the Date (component1) from a Calendar object.
`Field98D`	`setDate(String component1)` Set the Date (component1).
`Field98D`	`setDecimals(Number component3)` Set the Decimals (component3) from a Number object.
`Field98D`	`setDecimals(String component3)` Set the Decimals (component3).
`Field98D`	`setSign(Currency component4)` Set the Sign (component4) from a Currency object.
`Field98D`	`setSign(String component4)` Set the Sign (component4).
`Field98D`	`setTime(Calendar component2)` Set the Time (component2) from a Calendar object.
`Field98D`	`setTime(String component2)` Set the Time (component2).
`Field98D`	`setUTCIndicator(Calendar component5)` Set the UTC Indicator (component5) from a Calendar object.
`Field98D`	`setUTCIndicator(String component5)` Set the UTC Indicator (component5).
`static Tag`	`tag(String value)` Create a Tag with this field name and the given value.
`String`	`validatorPattern()` Returns the field's validators pattern

Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName

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

- Field Detail
  - SRU
```
public static final int SRU
```
    Constant identifying the SRU to which this class belongs to.
    
    See Also:
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Constant with the field name 98D
    
    See Also:
    Constant Field Values
  - F_98D
```
public static final String F_98D
```
    same as NAME, intended to be clear when using static imports
    
    See Also:
    Constant Field Values
  - PARSER_PATTERN
```
public static final String PARSER_PATTERN
```
    See Also:
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final String COMPONENTS_PATTERN
```
    See Also:
    Constant Field Values
  - DATE
```
public static final Integer DATE
```
    Component number for the Date subfield
  - TIME
```
public static final Integer TIME
```
    Component number for the Time subfield
  - DECIMALS
```
public static final Integer DECIMALS
```
    Component number for the Decimals subfield
  - SIGN
```
public static final Integer SIGN
```
    Component number for the Sign subfield
  - UTC_INDICATOR
```
public static final Integer UTC_INDICATOR
```
    Component number for the UTC Indicator subfield
- Constructor Detail
  - Field98D
```
public Field98D()
```
    Default constructor. Creates a new field setting all components to null.
  - Field98D
```
public Field98D(String value)
```
    Creates a new field and initializes its components with content from the parameter value.
    
    Parameters:
    value - complete field value including separators and CRLF
  - Field98D
```
public Field98D(Tag tag)
```
    Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)
    
    Throws:
    
    IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name
    Since:
    
    7.8
- Method Detail
  - parse
```
public void parse(String value)
```
    Parses the parameter value into the internal components structure.
    Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
    
    Specified by:
    
    parse in class Field
    
    Parameters:
    value - complete field value including separators and CRLF
    Since:
    
    7.8
  - newInstance
```
public static Field98D newInstance(Field98D source)
```
    Copy constructor.
    Initializes the components list with a deep copy of the source components list.
    
    Parameters:
    source - a field instance to copy
    Since:
    
    7.7
  - getValue
```
public String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format)
    
    Specified by:
    
    getValue in class Field
    
    Returns:
    SWIFT formatted value
  - tag
```
public static Tag tag(String value)
```
    Create a Tag with this field name and the given value. Shorthand for new Tag(NAME, value)
    
    Since:
    
    7.5
    
    See Also:
    NAME
  - emptyTag
```
public static Tag emptyTag()
```
    Create a Tag with this field name and an empty string as value Shorthand for new Tag(NAME, "")
    
    Since:
    
    7.5
    
    See Also:
    NAME
  - getComponent1
```
public String getComponent1()
```
    Get the component1
    
    Returns:
    the component1
  - getComponent1AsCalendar
```
public Calendar getComponent1AsCalendar()
```
    Get the component1 as Calendar
    
    Returns:
    the component1 converted to Calendar or null if cannot be converted
  - getDate
```
public String getDate()
```
    Get the Date (component1).
    
    Returns:
    the Date from component1
  - getDateAsCalendar
```
public Calendar getDateAsCalendar()
```
    Get the Date (component1) as Calendar
    
    Returns:
    the Date from component1 converted to Calendar or null if cannot be converted
  - setComponent1
```
public Field98D setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field98D setComponent1(Calendar component1)
```
    Set the component1 from a Calendar object.
    
    Parameters:
    component1 - the Calendar with the component1 content to set
  - setDate
```
public Field98D setDate(String component1)
```
    Set the Date (component1).
    
    Parameters:
    component1 - the Date to set
  - setDate
```
public Field98D setDate(Calendar component1)
```
    Set the Date (component1) from a Calendar object.
    
    Parameters:
    component1 - Calendar with the Date content to set
    See Also:
    setComponent1(java.util.Calendar)
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsCalendar
```
public Calendar getComponent2AsCalendar()
```
    Get the component2 as Calendar
    
    Returns:
    the component2 converted to Calendar or null if cannot be converted
  - getTime
```
public String getTime()
```
    Get the Time (component2).
    
    Returns:
    the Time from component2
  - getTimeAsCalendar
```
public Calendar getTimeAsCalendar()
```
    Get the Time (component2) as Calendar
    
    Returns:
    the Time from component2 converted to Calendar or null if cannot be converted
  - setComponent2
```
public Field98D setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field98D setComponent2(Calendar component2)
```
    Set the component2 from a Calendar object.
    
    Parameters:
    component2 - the Calendar with the component2 content to set
  - setTime
```
public Field98D setTime(String component2)
```
    Set the Time (component2).
    
    Parameters:
    component2 - the Time to set
  - setTime
```
public Field98D setTime(Calendar component2)
```
    Set the Time (component2) from a Calendar object.
    
    Parameters:
    component2 - Calendar with the Time content to set
    See Also:
    setComponent2(java.util.Calendar)
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsNumber
```
public Number getComponent3AsNumber()
```
    Get the component3 as Number
    
    Returns:
    the component3 converted to Number or null if cannot be converted
  - getDecimals
```
public String getDecimals()
```
    Get the Decimals (component3).
    
    Returns:
    the Decimals from component3
  - getDecimalsAsNumber
```
public Number getDecimalsAsNumber()
```
    Get the Decimals (component3) as Number
    
    Returns:
    the Decimals from component3 converted to Number or null if cannot be converted
  - setComponent3
```
public Field98D setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field98D setComponent3(Number component3)
```
    Set the component3 from a Number object.
    If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent3(String) method.
    
    Parameters:
    component3 - the Number with the component3 content to set
    See Also:
    setComponent3(String)
  - setDecimals
```
public Field98D setDecimals(String component3)
```
    Set the Decimals (component3).
    
    Parameters:
    component3 - the Decimals to set
  - setDecimals
```
public Field98D setDecimals(Number component3)
```
    Set the Decimals (component3) from a Number object.
    
    Parameters:
    component3 - Number with the Decimals content to set
    See Also:
    setComponent3(java.lang.Number)
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsCurrency
```
public Currency getComponent4AsCurrency()
```
    Get the component4 as Currency
    
    Returns:
    the component4 converted to Currency or null if cannot be converted
  - getSign
```
public String getSign()
```
    Get the Sign (component4).
    
    Returns:
    the Sign from component4
  - getSignAsCurrency
```
public Currency getSignAsCurrency()
```
    Get the Sign (component4) as Currency
    
    Returns:
    the Sign from component4 converted to Currency or null if cannot be converted
  - setComponent4
```
public Field98D setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field98D setComponent4(Currency component4)
```
    Set the component4 from a Currency object.
    
    Parameters:
    component4 - the Currency with the component4 content to set
  - setSign
```
public Field98D setSign(String component4)
```
    Set the Sign (component4).
    
    Parameters:
    component4 - the Sign to set
  - setSign
```
public Field98D setSign(Currency component4)
```
    Set the Sign (component4) from a Currency object.
    
    Parameters:
    component4 - Currency with the Sign content to set
    See Also:
    setComponent4(java.util.Currency)
  - getComponent5
```
public String getComponent5()
```
    Get the component5
    
    Returns:
    the component5
  - getComponent5AsCalendar
```
public Calendar getComponent5AsCalendar()
```
    Get the component5 as Calendar
    
    Returns:
    the component5 converted to Calendar or null if cannot be converted
  - getUTCIndicator
```
public String getUTCIndicator()
```
    Get the UTC Indicator (component5).
    
    Returns:
    the UTC Indicator from component5
  - getUTCIndicatorAsCalendar
```
public Calendar getUTCIndicatorAsCalendar()
```
    Get the UTC Indicator (component5) as Calendar
    
    Returns:
    the UTC Indicator from component5 converted to Calendar or null if cannot be converted
  - setComponent5
```
public Field98D setComponent5(String component5)
```
    Set the component5.
    
    Parameters:
    component5 - the component5 to set
  - setComponent5
```
public Field98D setComponent5(Calendar component5)
```
    Set the component5 from a Calendar object.
    
    Parameters:
    component5 - the Calendar with the component5 content to set
  - setUTCIndicator
```
public Field98D setUTCIndicator(String component5)
```
    Set the UTC Indicator (component5).
    
    Parameters:
    component5 - the UTC Indicator to set
  - setUTCIndicator
```
public Field98D setUTCIndicator(Calendar component5)
```
    Set the UTC Indicator (component5) from a Calendar object.
    
    Parameters:
    component5 - Calendar with the UTC Indicator content to set
    See Also:
    setComponent5(java.util.Calendar)
  - dates
```
public List<Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - isOptional
```
public boolean isOptional(int component)
```
    Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message.
    Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.
    
    Specified by:
    
    isOptional in class Field
    
    Parameters:
    component - component number, first component of a field is referenced as 1
    
    Returns:
    true if the component is optional for this field, false otherwise
  - isGeneric
```
public boolean isGeneric()
```
    Returns true if the field is a GENERIC FIELD as specified by the standard.
    
    Specified by:
    
    isGeneric in class Field
    
    Returns:
    true if the field is generic, false otherwise
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public String getName()
```
    Returns the field's name composed by the field number and the letter option (if any)
    
    Specified by:
    
    getName in class Field
    
    Returns:
    the static value of Field98D.NAME
  - componentsPattern
```
public final String componentsPattern()
```
    Returns the field's components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    the static value of Field98D.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field98D get(SwiftTagListBlock block)
```
    Get the first occurrence form the tag list or null if not found.
    
    Parameters:
    block - may be null or empty
    
    Returns:
    null if not found o block is null or empty
  - get
```
public static Field98D get(SwiftMessage msg)
```
    Get the first instance of Field98D in the given message.
    
    Parameters:
    msg - may be empty or null
    
    Returns:
    null if not found or msg is empty or null
    See Also:
    get(SwiftTagListBlock)
  - getAll
```
public static List<Field98D> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field98D in the given message an empty list is returned if none found.
    
    Parameters:
    msg - may be empty or null in which case an empty list is returned
    See Also:
    getAll(SwiftTagListBlock)
  - getAll
```
public static List<Field98D> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field98D from the given block an empty list is returned if none found.
    
    Parameters:
    block - may be empty or null in which case an empty list is returned
  - componentsSize
```
public int componentsSize()
```
    Returns the defined amount of components.
    This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.
    
    Specified by:
    
    componentsSize in class Field
    
    Since:
    
    7.7
  - getValueDisplay
```
public String getValueDisplay(int component,
                     Locale locale)
```
    Returns a localized suitable for showing to humans string of a field component.
    
    Specified by:
    
    getValueDisplay in class Field
    
    Parameters:
    component - number of the component to display
    locale - optional locale to format date and amounts, if null, the default locale is used
    
    Returns:
    formatted component value or null if component number is invalid or not present
    
    Throws:
    
    IllegalArgumentException - if component number is invalid for the field
    Since:
    
    7.8
  - getComponentLabels
```
protected List<String> getComponentLabels()
```
    Returns english label for components.
    The index in the list is in sync with specific field component structure.
    
    Specified by:
    
    getComponentLabels in class Field
    
    Since:
    
    7.8.4
    
    See Also:
    Field.getComponentLabel(int)

Class Field98D

SWIFT MT Field 98D

Subfields (components) Data types

Structure definition

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.field.Field

Constructor Summary

Method Summary

Methods inherited from class com.prowidesoftware.swift.model.field.Field

Methods inherited from class java.lang.Object

Field Detail

SRU

NAME

F_98D

PARSER_PATTERN

COMPONENTS_PATTERN

DATE

TIME

DECIMALS

SIGN

UTC_INDICATOR

Constructor Detail

Field98D

Field98D

Field98D

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsCalendar

getDate

getDateAsCalendar

setComponent1

setComponent1

setDate

setDate

getComponent2

getComponent2AsCalendar

getTime

getTimeAsCalendar

setComponent2

setComponent2

setTime

setTime

getComponent3

getComponent3AsNumber

getDecimals

getDecimalsAsNumber

setComponent3

setComponent3

setDecimals

setDecimals

getComponent4

getComponent4AsCurrency

getSign

getSignAsCurrency

setComponent4

setComponent4

setSign

setSign

getComponent5

getComponent5AsCalendar

getUTCIndicator

getUTCIndicatorAsCalendar

setComponent5

setComponent5

setUTCIndicator

setUTCIndicator

dates

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get