Field280 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer, Serializable
```
@Generated
public class Field280
extends Field
implements Serializable
```
Field 280

validation pattern: <HHMM><MIR><1!a><?>
parser pattern: <HHMM><MIR>cS
components pattern: HRLS

Components Data types
- component1: Calendar
- component2: MIR
- component3: Boolean
- component4: String
NOTE: this source code has been generated from template This class complies with standard release SRU2016
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_280` same as NAME, intended to be clear when using static imports
`static Integer`	`INPUT_TIME` Component number for the Input Time subfield
`static Integer`	`MIR` Component number for the MIR subfield
`static String`	`NAME` Constant with the field name 280
`static String`	`PARSER_PATTERN`
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.

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

Constructor Summary

Constructors
Constructor and Description
`Field280()` Default constructor.
`Field280(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field280(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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field280`	`get(SwiftMessage msg)` Get the first instance of Field280 in the given message.
`static Field280`	`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<Field280>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field280 in the given message an empty list is returned if none found.
`static List<Field280>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field280 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
`MIR`	`getComponent2AsMIR()` Get the component2 as MIR
`String`	`getComponent3()` Get the component3
`Boolean`	`getComponent3AsBoolean()` Get the component3 as Boolean
`String`	`getComponent4()` Get the component4
`String`	`getComponent4AsString()` Deprecated.
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getError()` Get the Error (component4).
`String`	`getInputTime()` Get the Input Time (component1).
`Calendar`	`getInputTimeAsCalendar()` Get the Input Time (component1) as Calendar
`String`	`getMIR()` Get the MIR (component2).
`MIR`	`getMIRAsMIR()` Get the MIR (component2) as MIR
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`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 Field280`	`newInstance(Field280 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()`
`Field280`	`setAccepted(Boolean component3)` Set the Accepted (component3) from a Boolean object.
`Field280`	`setAccepted(String component3)` Set the Accepted (component3).
`Field280`	`setComponent1(Calendar component1)` Set the component1 from a Calendar object.
`Field280`	`setComponent1(String component1)` Set the component1.
`Field280`	`setComponent2(MIR component2)` Set the component2 from a MIR object.
`Field280`	`setComponent2(String component2)` Set the component2.
`Field280`	`setComponent3(Boolean component3)` Set the component3 from a Boolean object.
`Field280`	`setComponent3(String component3)` Set the component3.
`Field280`	`setComponent4(String component4)` Set the component4.
`Field280`	`setError(String component4)` Set the Error (component4).
`Field280`	`setInputTime(Calendar component1)` Set the Input Time (component1) from a Calendar object.
`Field280`	`setInputTime(String component1)` Set the Input Time (component1).
`Field280`	`setMIR(MIR component2)` Set the MIR (component2) from a MIR object.
`Field280`	`setMIR(String component2)` Set the MIR (component2).
`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
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, 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 280
    
    See Also:
    Constant Field Values
  - F_280
```
public static final String F_280
```
    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
  - INPUT_TIME
```
public static final Integer INPUT_TIME
```
    Component number for the Input Time subfield
  - MIR
```
public static final Integer MIR
```
    Component number for the MIR 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
  - Field280
```
public Field280()
```
    Default constructor. Creates a new field setting all components to null.
  - Field280
```
public Field280(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
  - Field280
```
public Field280(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 components value is overwritten.
    
    Overrides:
    
    parse in class Field
    
    Parameters:
    value - complete field value including separators and CRLF
    Since:
    
    7.8
  - newInstance
```
public static Field280 newInstance(Field280 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
  - getInputTime
```
public String getInputTime()
```
    Get the Input Time (component1).
    
    Returns:
    the Input Time from component1
  - getInputTimeAsCalendar
```
public Calendar getInputTimeAsCalendar()
```
    Get the Input Time (component1) as Calendar
    
    Returns:
    the Input Time from component1 converted to Calendar or null if cannot be converted
  - setComponent1
```
public Field280 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field280 setComponent1(Calendar component1)
```
    Set the component1 from a Calendar object.
    
    Parameters:
    component1 - the Calendar with the component1 content to set
  - setInputTime
```
public Field280 setInputTime(String component1)
```
    Set the Input Time (component1).
    
    Parameters:
    component1 - the Input Time to set
  - setInputTime
```
public Field280 setInputTime(Calendar component1)
```
    Set the Input Time (component1) from a Calendar object.
    
    Parameters:
    component1 - Calendar with the Input Time content to set
    See Also:
    setComponent1(java.util.Calendar)
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsMIR
```
public MIR getComponent2AsMIR()
```
    Get the component2 as MIR
    
    Returns:
    the component2 converted to MIR or null if cannot be converted
  - getMIR
```
public String getMIR()
```
    Get the MIR (component2).
    
    Returns:
    the MIR from component2
  - getMIRAsMIR
```
public MIR getMIRAsMIR()
```
    Get the MIR (component2) as MIR
    
    Returns:
    the MIR from component2 converted to MIR or null if cannot be converted
  - setComponent2
```
public Field280 setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field280 setComponent2(MIR component2)
```
    Set the component2 from a MIR object.
    
    Parameters:
    component2 - the MIR with the component2 content to set
  - setMIR
```
public Field280 setMIR(String component2)
```
    Set the MIR (component2).
    
    Parameters:
    component2 - the MIR to set
  - setMIR
```
public Field280 setMIR(MIR component2)
```
    Set the MIR (component2) from a MIR object.
    
    Parameters:
    component2 - MIR with the MIR content to set
    See Also:
    setComponent2(com.prowidesoftware.swift.model.MIR)
  - 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 Field280 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field280 setComponent3(Boolean component3)
```
    Set the component3 from a Boolean object.
    
    Parameters:
    component3 - the Boolean with the component3 content to set
  - setAccepted
```
public Field280 setAccepted(String component3)
```
    Set the Accepted (component3).
    
    Parameters:
    component3 - the Accepted to set
  - setAccepted
```
public Field280 setAccepted(Boolean component3)
```
    Set the Accepted (component3) from a Boolean object.
    
    Parameters:
    component3 - Boolean with the Accepted content to set
    See Also:
    setComponent3(java.lang.Boolean)
  - 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 Field280 setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setError
```
public Field280 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
  - 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 Field280.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 Field280.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field280 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 Field280 get(SwiftMessage msg)
```
    Get the first instance of Field280 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<Field280> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field280 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<Field280> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field280 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 Field280

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

SRU

NAME

F_280

PARSER_PATTERN

COMPONENTS_PATTERN

INPUT_TIME

MIR

ACCEPTED

ERROR

Constructor Detail

Field280

Field280

Field280

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsCalendar

getInputTime

getInputTimeAsCalendar

setComponent1

setComponent1

setInputTime

setInputTime

getComponent2

getComponent2AsMIR

getMIR

getMIRAsMIR

setComponent2

setComponent2

setMIR

setMIR

getComponent3

getComponent3AsBoolean

getAccepted

getAcceptedAsBoolean

setComponent3

setComponent3

setAccepted

setAccepted

getComponent4

getComponent4AsString

getError

setComponent4

setError

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels