Field263 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

BICContainer, DateContainer, PatternContainer, Serializable
```
public class Field263
extends Field
implements Serializable, DateContainer, BICContainer
```
Field 263

validation pattern: <SWIFTBIC>|<NON-SWIFTBIC><DATE2><HHMM><HHMM>[4!n]
parser pattern: 12!S<DATE2><HHMM><HHMM>[N]
components pattern: BEHHN

Components Data types
- component1: BIC
- component2: Calendar
- component3: Calendar
- component4: Calendar
- component5: Number
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`	`BIC` Component number for the BIC subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`DATE` Component number for the Date subfield
`static Integer`	`END_TIME` Component number for the End Time subfield
`static String`	`F_263` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 263
`static String`	`PARSER_PATTERN`
`static Integer`	`SESSION_NUMBER` Component number for the Session Number subfield
`static Integer`	`START_TIME` Component number for the Start Time subfield

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

Constructor Summary

Constructors
Constructor and Description

Field263()
Default constructor

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`List<BIC>`	`bics()` Utility method that creates a BIC for every string returned by `BICContainer.bicStrings()`
`List<String>`	`bicStrings()` Get a list of strings of BICs present in this field
`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.
`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 Field263`	`get(SwiftMessage msg)` Get the first instance of Field263 in the given message.
`static Field263`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field263>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field263 in the given message an empty list is returned if none found.
`static List<Field263>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field263 from the given block an empty list is returned if none found.
`String`	`getBIC()` Get the BIC (component1).
`BIC`	`getBICAsBIC()` Get the BIC (component1) as BIC
`String`	`getComponent1()` Get the component1
`BIC`	`getComponent1AsBIC()` Get the component1 as BIC
`String`	`getComponent2()` Get the component2
`Calendar`	`getComponent2AsCalendar()` Get the component2 as Calendar
`String`	`getComponent3()` Get the component3
`Calendar`	`getComponent3AsCalendar()` Get the component3 as Calendar
`String`	`getComponent4()` Get the component4
`Calendar`	`getComponent4AsCalendar()` Get the component4 as Calendar
`String`	`getComponent5()` Get the component5
`Number`	`getComponent5AsNumber()` Get the component5 as Number
`String`	`getDate()` Get the Date (component2).
`Calendar`	`getDateAsCalendar()` Get the Date (component2) as Calendar
`String`	`getEndTime()` Get the End Time (component4).
`Calendar`	`getEndTimeAsCalendar()` Get the End Time (component4) as Calendar
`String`	`getName()` Deprecated. use constant Field263
`String`	`getSessionNumber()` Get the Session Number (component5).
`Number`	`getSessionNumberAsNumber()` Get the Session Number (component5) as Number
`String`	`getStartTime()` Get the Start Time (component3).
`Calendar`	`getStartTimeAsCalendar()` Get the Start Time (component3) 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 Field263`	`newInstance(Field263 source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field263`	`setBIC(BIC component1)` Set the BIC (component1) as BIC
`Field263`	`setBIC(String component1)` Set the BIC (component1).
`Field263`	`setComponent1(BIC component1)` Set the component1.
`Field263`	`setComponent1(String component1)` Set the component1.
`Field263`	`setComponent2(Calendar component2)` Set the component2.
`Field263`	`setComponent2(String component2)` Set the component2.
`Field263`	`setComponent3(Calendar component3)` Set the component3.
`Field263`	`setComponent3(String component3)` Set the component3.
`Field263`	`setComponent4(Calendar component4)` Set the component4.
`Field263`	`setComponent4(String component4)` Set the component4.
`Field263`	`setComponent5(Number component5)` Set the component5.
`Field263`	`setComponent5(String component5)` Set the component5.
`Field263`	`setDate(Calendar component2)` Set the Date (component2) as Calendar
`Field263`	`setDate(String component2)` Set the Date (component2).
`Field263`	`setEndTime(Calendar component4)` Set the End Time (component4) as Calendar
`Field263`	`setEndTime(String component4)` Set the End Time (component4).
`Field263`	`setSessionNumber(Number component5)` Set the Session Number (component5) as Number
`Field263`	`setSessionNumber(String component5)` Set the Session Number (component5).
`Field263`	`setStartTime(Calendar component3)` Set the Start Time (component3) as Calendar
`Field263`	`setStartTime(String component3)` Set the Start Time (component3).
`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 263
    
    See Also:
    Constant Field Values
  - F_263
```
public static final String F_263
```
    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
  - BIC
```
public static final Integer BIC
```
    Component number for the BIC subfield
  - DATE
```
public static final Integer DATE
```
    Component number for the Date subfield
  - START_TIME
```
public static final Integer START_TIME
```
    Component number for the Start Time subfield
  - END_TIME
```
public static final Integer END_TIME
```
    Component number for the End Time subfield
  - SESSION_NUMBER
```
public static final Integer SESSION_NUMBER
```
    Component number for the Session Number subfield
- Constructor Detail
  - Field263
```
public Field263()
```
    Default constructor
  - Field263
```
public Field263(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field263 newInstance(Field263 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
  - getComponent1AsBIC
```
public BIC getComponent1AsBIC()
```
    Get the component1 as BIC
    
    Returns:
    the component1 converted to BIC or null if cannot be converted
  - getBIC
```
public String getBIC()
```
    Get the BIC (component1).
    
    Returns:
    the BIC from component1
  - getBICAsBIC
```
public BIC getBICAsBIC()
```
    Get the BIC (component1) as BIC
    
    Returns:
    the BIC from component1 converted to BIC or null if cannot be converted
  - setComponent1
```
public Field263 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field263 setComponent1(BIC component1)
```
    Set the component1.
    
    Parameters:
    component1 - the BIC with the component1 content to set
  - setBIC
```
public Field263 setBIC(String component1)
```
    Set the BIC (component1).
    
    Parameters:
    component1 - the BIC to set
  - setBIC
```
public Field263 setBIC(BIC component1)
```
    Set the BIC (component1) as BIC
    
    Parameters:
    component1 - BIC with the BIC content to set
  - 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
  - getDate
```
public String getDate()
```
    Get the Date (component2).
    
    Returns:
    the Date from component2
  - getDateAsCalendar
```
public Calendar getDateAsCalendar()
```
    Get the Date (component2) as Calendar
    
    Returns:
    the Date from component2 converted to Calendar or null if cannot be converted
  - setComponent2
```
public Field263 setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field263 setComponent2(Calendar component2)
```
    Set the component2.
    
    Parameters:
    component2 - the Calendar with the component2 content to set
  - setDate
```
public Field263 setDate(String component2)
```
    Set the Date (component2).
    
    Parameters:
    component2 - the Date to set
  - setDate
```
public Field263 setDate(Calendar component2)
```
    Set the Date (component2) as Calendar
    
    Parameters:
    component2 - Calendar with the Date content to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsCalendar
```
public Calendar getComponent3AsCalendar()
```
    Get the component3 as Calendar
    
    Returns:
    the component3 converted to Calendar or null if cannot be converted
  - getStartTime
```
public String getStartTime()
```
    Get the Start Time (component3).
    
    Returns:
    the Start Time from component3
  - getStartTimeAsCalendar
```
public Calendar getStartTimeAsCalendar()
```
    Get the Start Time (component3) as Calendar
    
    Returns:
    the Start Time from component3 converted to Calendar or null if cannot be converted
  - setComponent3
```
public Field263 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field263 setComponent3(Calendar component3)
```
    Set the component3.
    
    Parameters:
    component3 - the Calendar with the component3 content to set
  - setStartTime
```
public Field263 setStartTime(String component3)
```
    Set the Start Time (component3).
    
    Parameters:
    component3 - the Start Time to set
  - setStartTime
```
public Field263 setStartTime(Calendar component3)
```
    Set the Start Time (component3) as Calendar
    
    Parameters:
    component3 - Calendar with the Start Time content to set
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsCalendar
```
public Calendar getComponent4AsCalendar()
```
    Get the component4 as Calendar
    
    Returns:
    the component4 converted to Calendar or null if cannot be converted
  - getEndTime
```
public String getEndTime()
```
    Get the End Time (component4).
    
    Returns:
    the End Time from component4
  - getEndTimeAsCalendar
```
public Calendar getEndTimeAsCalendar()
```
    Get the End Time (component4) as Calendar
    
    Returns:
    the End Time from component4 converted to Calendar or null if cannot be converted
  - setComponent4
```
public Field263 setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field263 setComponent4(Calendar component4)
```
    Set the component4.
    
    Parameters:
    component4 - the Calendar with the component4 content to set
  - setEndTime
```
public Field263 setEndTime(String component4)
```
    Set the End Time (component4).
    
    Parameters:
    component4 - the End Time to set
  - setEndTime
```
public Field263 setEndTime(Calendar component4)
```
    Set the End Time (component4) as Calendar
    
    Parameters:
    component4 - Calendar with the End Time content to set
  - getComponent5
```
public String getComponent5()
```
    Get the component5
    
    Returns:
    the component5
  - getComponent5AsNumber
```
public Number getComponent5AsNumber()
```
    Get the component5 as Number
    
    Returns:
    the component5 converted to Number or null if cannot be converted
  - getSessionNumber
```
public String getSessionNumber()
```
    Get the Session Number (component5).
    
    Returns:
    the Session Number from component5
  - getSessionNumberAsNumber
```
public Number getSessionNumberAsNumber()
```
    Get the Session Number (component5) as Number
    
    Returns:
    the Session Number from component5 converted to Number or null if cannot be converted
  - setComponent5
```
public Field263 setComponent5(String component5)
```
    Set the component5.
    
    Parameters:
    component5 - the component5 to set
  - setComponent5
```
public Field263 setComponent5(Number component5)
```
    Set the component5.
    
    Parameters:
    component5 - the Number with the component5 content to set
  - setSessionNumber
```
public Field263 setSessionNumber(String component5)
```
    Set the Session Number (component5).
    
    Parameters:
    component5 - the Session Number to set
  - setSessionNumber
```
public Field263 setSessionNumber(Number component5)
```
    Set the Session Number (component5) as Number
    
    Parameters:
    component5 - Number with the Session Number content to set
  - dates
```
public List<Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - bics
```
public List<BIC> bics()
```
    Description copied from interface: BICContainer
    
    Utility method that creates a BIC for every string returned by BICContainer.bicStrings()
    
    Specified by:
    
    bics in interface BICContainer
  - bicStrings
```
public List<String> bicStrings()
```
    Description copied from interface: BICContainer
    
    Get a list of strings of BICs present in this field
    
    Specified by:
    
    bicStrings in interface BICContainer
    
    Returns:
    a list, with zero or more BICs in this field.
  - 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 Field263
    
    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 Field263 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 Field263 get(SwiftMessage msg)
```
    Get the first instance of Field263 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<Field263> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field263 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<Field263> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field263 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 Field263

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_263

PARSER_PATTERN

COMPONENTS_PATTERN

BIC

DATE

START_TIME

END_TIME

SESSION_NUMBER

Constructor Detail

Field263

Field263

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsBIC

getBIC

getBICAsBIC

setComponent1

setComponent1

setBIC

setBIC

getComponent2

getComponent2AsCalendar

getDate

getDateAsCalendar

setComponent2

setComponent2

setDate

setDate

getComponent3

getComponent3AsCalendar

getStartTime

getStartTimeAsCalendar

setComponent3

setComponent3

setStartTime

setStartTime

getComponent4

getComponent4AsCalendar

getEndTime

getEndTimeAsCalendar

setComponent4

setComponent4

setEndTime

setEndTime

getComponent5

getComponent5AsNumber

getSessionNumber

getSessionNumberAsNumber

setComponent5

setComponent5

setSessionNumber

setSessionNumber

dates

bics

bicStrings

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize