Field98B (Prowide Integrator API Reference)

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

All Implemented Interfaces:

GenericField, PatternContainer, Serializable
```
public class Field98B
extends Field
implements Serializable, GenericField
```
Field 98B

validation pattern: :4!c/[8c]/4!c
parser pattern: :S/[S]/S
components pattern: SSS

Components Data types
- component1: String
- component2: String
- component3: String
NOTE: this source code has been generated from template
Author:

www.prowidesoftware.com

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Integer`	`CODE` Component number for the Code subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`DATA_SOURCE_SCHEME` Component number for the Data Source Scheme subfield
`static String`	`F_98B` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 98B
`static String`	`PARSER_PATTERN`
`static Integer`	`QUALIFIER` Component number for the Qualifier subfield

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

Constructor Summary

Constructors
Constructor and Description

Field98B()
Default constructor

Field98B(String value)
Creates the field parsing the parameter value into fields' components

Constructors
Constructor and Description
`Field98B()` Default constructor
`Field98B(String value)` Creates the field parsing the parameter value into fields' components

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`componentsPattern()`
`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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field98B`	`get(SwiftMessage msg)` Get the first instance of Field98B in the given message.
`static Field98B`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field98B>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field98B in the given message an empty list is returned if none found.
`static List<Field98B>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field98B from the given block an empty list is returned if none found.
`String`	`getCode()` Get the Code (component3).
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated.
`String`	`getComponent2()` Get the component2
`String`	`getComponent2AsString()` Deprecated.
`String`	`getComponent3()` Get the component3
`String`	`getComponent3AsString()` Deprecated.
`String`	`getConditionalQualifier()` Gets the conditional qualifier. The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
`String`	`getDataSourceScheme()` Get the Data Source Scheme (component2).
`String`	`getDSS()` Returns the issuer code (or Data Source Scheme or DSS).
`String`	`getName()` Deprecated. use constant Field98B
`String`	`getQualifier()` Get the Qualifier (component1).
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`boolean`	`isDSSPresent()` Checks if the issuer code (or Data Source Scheme or DSS) is present.
`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 Field98B`	`newInstance(Field98B source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field98B`	`setCode(String component3)` Set the Code (component3).
`Field98B`	`setComponent1(String component1)` Set the component1.
`Field98B`	`setComponent2(String component2)` Set the component2.
`Field98B`	`setComponent3(String component3)` Set the component3.
`Field98B`	`setDataSourceScheme(String component2)` Set the Data Source Scheme (component2).
`Field98B`	`setQualifier(String component1)` Set the Qualifier (component1).
`static Tag`	`tag(String value)` Create a Tag with this field name and the given value.

Methods inherited from class com.prowidesoftware.swift.model.field.Field
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString

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

- Field Detail
  - NAME
```
public static final String NAME
```
    Constant with the field name 98B
    
    See Also:
    Constant Field Values
  - F_98B
```
public static final String F_98B
```
    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
  - QUALIFIER
```
public static final Integer QUALIFIER
```
    Component number for the Qualifier subfield
  - DATA_SOURCE_SCHEME
```
public static final Integer DATA_SOURCE_SCHEME
```
    Component number for the Data Source Scheme subfield
  - CODE
```
public static final Integer CODE
```
    Component number for the Code subfield
- Constructor Detail
  - Field98B
```
public Field98B()
```
    Default constructor
  - Field98B
```
public Field98B(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field98B newInstance(Field98B 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)
    
    Overrides:
    
    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
  - getComponent1AsString
```
@Deprecated
public String getComponent1AsString()
```
    Deprecated.
    
    Same as getComponent(1)
  - getQualifier
```
public String getQualifier()
```
    Get the Qualifier (component1).
    
    Returns:
    the Qualifier from component1
  - setComponent1
```
public Field98B setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setQualifier
```
public Field98B setQualifier(String component1)
```
    Set the Qualifier (component1).
    
    Parameters:
    component1 - the Qualifier to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsString
```
@Deprecated
public String getComponent2AsString()
```
    Deprecated.
    
    Same as getComponent(2)
  - getDataSourceScheme
```
public String getDataSourceScheme()
```
    Get the Data Source Scheme (component2).
    
    Returns:
    the Data Source Scheme from component2
  - setComponent2
```
public Field98B setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setDataSourceScheme
```
public Field98B setDataSourceScheme(String component2)
```
    Set the Data Source Scheme (component2).
    
    Parameters:
    component2 - the Data Source Scheme to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsString
```
@Deprecated
public String getComponent3AsString()
```
    Deprecated.
    
    Same as getComponent(3)
  - getCode
```
public String getCode()
```
    Get the Code (component3).
    
    Returns:
    the Code from component3
  - setComponent3
```
public Field98B setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setCode
```
public Field98B setCode(String component3)
```
    Set the Code (component3).
    
    Parameters:
    component3 - the Code to set
  - 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
  - getDSS
```
public String getDSS()
```
    Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.
    
    Specified by:
    
    getDSS in interface GenericField
    
    Overrides:
    
    getDSS in class Field
    
    Returns:
    DSS component value or null if the DSS is not set or not available for this field.
  - isDSSPresent
```
public boolean isDSSPresent()
```
    Checks if the issuer code (or Data Source Scheme or DSS) is present.
    
    Specified by:
    
    isDSSPresent in interface GenericField
    
    Overrides:
    
    isDSSPresent in class Field
    
    Returns:
    true if DSS is present, false otherwise.
    See Also:
    getDSS()
  - getConditionalQualifier
```
public String getConditionalQualifier()
```
    Gets the conditional qualifier.
    The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
    
    Specified by:
    
    getConditionalQualifier in interface GenericField
    
    Overrides:
    
    getConditionalQualifier in class Field
    
    Returns:
    for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this kind of field.
  - componentsPattern
```
public String componentsPattern()
```
    Specified by:
    
    componentsPattern in interface PatternContainer
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public String getName()
```
    Deprecated. use constant Field98B
    
    Description copied from class: Field
    
    Returns the field's name composed by the field number and the letter option (if any)
    
    Specified by:
    
    getName in class Field
  - get
```
public static Field98B 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 Field98B get(SwiftMessage msg)
```
    Get the first instance of Field98B 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<Field98B> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field98B 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<Field98B> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field98B 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

Class Field98B

Components Data types

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

NAME

F_98B

PARSER_PATTERN

COMPONENTS_PATTERN

QUALIFIER

DATA_SOURCE_SCHEME

CODE

Constructor Detail

Field98B

Field98B

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getQualifier

setComponent1

setQualifier

getComponent2

getComponent2AsString

getDataSourceScheme

setComponent2

setDataSourceScheme

getComponent3

getComponent3AsString

getCode

setComponent3

setCode

isOptional

isGeneric

getDSS

isDSSPresent

getConditionalQualifier

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize