Field281 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer, Serializable
```
public class Field281
extends Field
implements Serializable
```
Field 281

validation pattern: <HHMM><MOR><Y|N>[3!c]
parser pattern: <HHMM><MOR>cS
components pattern: HVLS

Components Data types
- component1: Calendar
- component2: MOR
- component3: Boolean
- component4: 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`	`ACCEPTED` Component number for the Accepted subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`ERROR` Component number for the Error subfield
`static String`	`F_281` same as NAME, intended to be clear when using static imports
`static Integer`	`MOR` Component number for the MOR subfield
`static String`	`NAME` Constant with the field name 281
`static Integer`	`OUTPUT_TIME` Component number for the Output Time subfield
`static String`	`PARSER_PATTERN`

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

Constructor Summary

Constructors
Constructor and Description

Field281()
Default constructor

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

Constructors
Constructor and Description
`Field281()` Default constructor
`Field281(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 Field281`	`get(SwiftMessage msg)` Get the first instance of Field281 in the given message.
`static Field281`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`String`	`getAccepted()` Get the Accepted (component3).
`Boolean`	`getAcceptedAsBoolean()` Get the Accepted (component3) as Boolean
`static List<Field281>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field281 in the given message an empty list is returned if none found.
`static List<Field281>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field281 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
`MOR`	`getComponent2AsMOR()` Get the component2 as MOR
`String`	`getComponent3()` Get the component3
`Boolean`	`getComponent3AsBoolean()` Get the component3 as Boolean
`String`	`getComponent4()` Get the component4
`String`	`getComponent4AsString()` Deprecated.
`String`	`getError()` Get the Error (component4).
`String`	`getMOR()` Get the MOR (component2).
`MOR`	`getMORAsMOR()` Get the MOR (component2) as MOR
`String`	`getName()` Deprecated. use constant Field281
`String`	`getOutputTime()` Get the Output Time (component1).
`Calendar`	`getOutputTimeAsCalendar()` Get the Output Time (component1) as Calendar
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`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 Field281`	`newInstance(Field281 source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field281`	`setAccepted(Boolean component3)` Set the Accepted (component3) as Boolean
`Field281`	`setAccepted(String component3)` Set the Accepted (component3).
`Field281`	`setComponent1(Calendar component1)` Set the component1.
`Field281`	`setComponent1(String component1)` Set the component1.
`Field281`	`setComponent2(MOR component2)` Set the component2.
`Field281`	`setComponent2(String component2)` Set the component2.
`Field281`	`setComponent3(Boolean component3)` Set the component3.
`Field281`	`setComponent3(String component3)` Set the component3.
`Field281`	`setComponent4(String component4)` Set the component4.
`Field281`	`setError(String component4)` Set the Error (component4).
`Field281`	`setMOR(MOR component2)` Set the MOR (component2) as MOR
`Field281`	`setMOR(String component2)` Set the MOR (component2).
`Field281`	`setOutputTime(Calendar component1)` Set the Output Time (component1) as Calendar
`Field281`	`setOutputTime(String component1)` Set the Output Time (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, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isDSSPresent, 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 281
    
    See Also:
    Constant Field Values
  - F_281
```
public static final String F_281
```
    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
  - OUTPUT_TIME
```
public static final Integer OUTPUT_TIME
```
    Component number for the Output Time subfield
  - MOR
```
public static final Integer MOR
```
    Component number for the MOR subfield
  - ACCEPTED
```
public static final Integer ACCEPTED
```
    Component number for the Accepted subfield
  - ERROR
```
public static final Integer ERROR
```
    Component number for the Error subfield
- Constructor Detail
  - Field281
```
public Field281()
```
    Default constructor
  - Field281
```
public Field281(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field281 newInstance(Field281 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
  - getComponent1AsCalendar
```
public Calendar getComponent1AsCalendar()
```
    Get the component1 as Calendar
    
    Returns:
    the component1 converted to Calendar or null if cannot be converted
  - getOutputTime
```
public String getOutputTime()
```
    Get the Output Time (component1).
    
    Returns:
    the Output Time from component1
  - getOutputTimeAsCalendar
```
public Calendar getOutputTimeAsCalendar()
```
    Get the Output Time (component1) as Calendar
    
    Returns:
    the Output Time from component1 converted to Calendar or null if cannot be converted
  - setComponent1
```
public Field281 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field281 setComponent1(Calendar component1)
```
    Set the component1.
    
    Parameters:
    component1 - the Calendar with the component1 content to set
  - setOutputTime
```
public Field281 setOutputTime(String component1)
```
    Set the Output Time (component1).
    
    Parameters:
    component1 - the Output Time to set
  - setOutputTime
```
public Field281 setOutputTime(Calendar component1)
```
    Set the Output Time (component1) as Calendar
    
    Parameters:
    component1 - Calendar with the Output Time content to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsMOR
```
public MOR getComponent2AsMOR()
```
    Get the component2 as MOR
    
    Returns:
    the component2 converted to MOR or null if cannot be converted
  - getMOR
```
public String getMOR()
```
    Get the MOR (component2).
    
    Returns:
    the MOR from component2
  - getMORAsMOR
```
public MOR getMORAsMOR()
```
    Get the MOR (component2) as MOR
    
    Returns:
    the MOR from component2 converted to MOR or null if cannot be converted
  - setComponent2
```
public Field281 setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field281 setComponent2(MOR component2)
```
    Set the component2.
    
    Parameters:
    component2 - the MOR with the component2 content to set
  - setMOR
```
public Field281 setMOR(String component2)
```
    Set the MOR (component2).
    
    Parameters:
    component2 - the MOR to set
  - setMOR
```
public Field281 setMOR(MOR component2)
```
    Set the MOR (component2) as MOR
    
    Parameters:
    component2 - MOR with the MOR content to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsBoolean
```
public Boolean getComponent3AsBoolean()
```
    Get the component3 as Boolean
    
    Returns:
    the component3 converted to Boolean or null if cannot be converted
  - getAccepted
```
public String getAccepted()
```
    Get the Accepted (component3).
    
    Returns:
    the Accepted from component3
  - getAcceptedAsBoolean
```
public Boolean getAcceptedAsBoolean()
```
    Get the Accepted (component3) as Boolean
    
    Returns:
    the Accepted from component3 converted to Boolean or null if cannot be converted
  - setComponent3
```
public Field281 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field281 setComponent3(Boolean component3)
```
    Set the component3.
    
    Parameters:
    component3 - the Boolean with the component3 content to set
  - setAccepted
```
public Field281 setAccepted(String component3)
```
    Set the Accepted (component3).
    
    Parameters:
    component3 - the Accepted to set
  - setAccepted
```
public Field281 setAccepted(Boolean component3)
```
    Set the Accepted (component3) as Boolean
    
    Parameters:
    component3 - Boolean with the Accepted content to set
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsString
```
@Deprecated
public String getComponent4AsString()
```
    Deprecated.
    
    Same as getComponent(4)
  - getError
```
public String getError()
```
    Get the Error (component4).
    
    Returns:
    the Error from component4
  - setComponent4
```
public Field281 setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setError
```
public Field281 setError(String component4)
```
    Set the Error (component4).
    
    Parameters:
    component4 - the Error 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
  - 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 Field281
    
    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 Field281 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 Field281 get(SwiftMessage msg)
```
    Get the first instance of Field281 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<Field281> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field281 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<Field281> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field281 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 Field281

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_281

PARSER_PATTERN

COMPONENTS_PATTERN

OUTPUT_TIME

MOR

ACCEPTED

ERROR

Constructor Detail

Field281

Field281

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsCalendar

getOutputTime

getOutputTimeAsCalendar

setComponent1

setComponent1

setOutputTime

setOutputTime

getComponent2

getComponent2AsMOR

getMOR

getMORAsMOR

setComponent2

setComponent2

setMOR

setMOR

getComponent3

getComponent3AsBoolean

getAccepted

getAcceptedAsBoolean

setComponent3

setComponent3

setAccepted

setAccepted

getComponent4

getComponent4AsString

getError

setComponent4

setError

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize