Field133 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer, Serializable
```
public class Field133
extends Field
implements Serializable
```
Field 133

validation pattern: c3!xSN
parser pattern: c3!SSN
components pattern: cSSN

Components Data types
- component1: Character
- component2: String
- component3: String
- component4: 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`	`BROADCAST_INITIATOR` Component number for the Broadcast Initiator subfield
`static Integer`	`BROADCAST_ISSUER` Component number for the Broadcast Issuer subfield
`static Integer`	`BROADCAST_NUMBER` Component number for the Broadcast Number subfield
`static String`	`COMPONENTS_PATTERN`
`static String`	`F_133` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 133
`static String`	`PARSER_PATTERN`
`static Integer`	`UNSEQUENCED_BROADCAST` Component number for the Unsequenced Broadcast subfield

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

Constructor Summary

Constructors
Constructor and Description

Field133()
Default constructor

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

Constructors
Constructor and Description
`Field133()` Default constructor
`Field133(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 Field133`	`get(SwiftMessage msg)` Get the first instance of Field133 in the given message.
`static Field133`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field133>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field133 in the given message an empty list is returned if none found.
`static List<Field133>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field133 from the given block an empty list is returned if none found.
`String`	`getBroadcastInitiator()` Get the Broadcast Initiator (component1).
`String`	`getBroadcastIssuer()` Get the Broadcast Issuer (component3).
`String`	`getBroadcastNumber()` Get the Broadcast Number (component4).
`Number`	`getBroadcastNumberAsNumber()` Get the Broadcast Number (component4) as Number
`String`	`getComponent1()` Get the component1
`String`	`getComponent2()` Get the component2
`String`	`getComponent2AsString()` Deprecated.
`String`	`getComponent3()` Get the component3
`String`	`getComponent3AsString()` Deprecated.
`String`	`getComponent4()` Get the component4
`Number`	`getComponent4AsNumber()` Get the component4 as Number
`String`	`getName()` Deprecated. use constant Field133
`String`	`getUnsequencedBroadcast()` Get the Unsequenced Broadcast (component2).
`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 Field133`	`newInstance(Field133 source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field133`	`setBroadcastInitiator(String component1)` Set the Broadcast Initiator (component1).
`Field133`	`setBroadcastIssuer(String component3)` Set the Broadcast Issuer (component3).
`Field133`	`setBroadcastNumber(Number component4)` Set the Broadcast Number (component4) as Number
`Field133`	`setBroadcastNumber(String component4)` Set the Broadcast Number (component4).
`Field133`	`setComponent1(String component1)` Set the component1.
`Field133`	`setComponent2(String component2)` Set the component2.
`Field133`	`setComponent3(String component3)` Set the component3.
`Field133`	`setComponent4(Number component4)` Set the component4.
`Field133`	`setComponent4(String component4)` Set the component4.
`Field133`	`setUnsequencedBroadcast(String component2)` Set the Unsequenced Broadcast (component2).
`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 133
    
    See Also:
    Constant Field Values
  - F_133
```
public static final String F_133
```
    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
  - BROADCAST_INITIATOR
```
public static final Integer BROADCAST_INITIATOR
```
    Component number for the Broadcast Initiator subfield
  - UNSEQUENCED_BROADCAST
```
public static final Integer UNSEQUENCED_BROADCAST
```
    Component number for the Unsequenced Broadcast subfield
  - BROADCAST_ISSUER
```
public static final Integer BROADCAST_ISSUER
```
    Component number for the Broadcast Issuer subfield
  - BROADCAST_NUMBER
```
public static final Integer BROADCAST_NUMBER
```
    Component number for the Broadcast Number subfield
- Constructor Detail
  - Field133
```
public Field133()
```
    Default constructor
  - Field133
```
public Field133(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field133 newInstance(Field133 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
  - getBroadcastInitiator
```
public String getBroadcastInitiator()
```
    Get the Broadcast Initiator (component1).
    
    Returns:
    the Broadcast Initiator from component1
  - setComponent1
```
public Field133 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setBroadcastInitiator
```
public Field133 setBroadcastInitiator(String component1)
```
    Set the Broadcast Initiator (component1).
    
    Parameters:
    component1 - the Broadcast Initiator to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsString
```
@Deprecated
public String getComponent2AsString()
```
    Deprecated.
    
    Same as getComponent(2)
  - getUnsequencedBroadcast
```
public String getUnsequencedBroadcast()
```
    Get the Unsequenced Broadcast (component2).
    
    Returns:
    the Unsequenced Broadcast from component2
  - setComponent2
```
public Field133 setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setUnsequencedBroadcast
```
public Field133 setUnsequencedBroadcast(String component2)
```
    Set the Unsequenced Broadcast (component2).
    
    Parameters:
    component2 - the Unsequenced Broadcast to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsString
```
@Deprecated
public String getComponent3AsString()
```
    Deprecated.
    
    Same as getComponent(3)
  - getBroadcastIssuer
```
public String getBroadcastIssuer()
```
    Get the Broadcast Issuer (component3).
    
    Returns:
    the Broadcast Issuer from component3
  - setComponent3
```
public Field133 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setBroadcastIssuer
```
public Field133 setBroadcastIssuer(String component3)
```
    Set the Broadcast Issuer (component3).
    
    Parameters:
    component3 - the Broadcast Issuer to set
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsNumber
```
public Number getComponent4AsNumber()
```
    Get the component4 as Number
    
    Returns:
    the component4 converted to Number or null if cannot be converted
  - getBroadcastNumber
```
public String getBroadcastNumber()
```
    Get the Broadcast Number (component4).
    
    Returns:
    the Broadcast Number from component4
  - getBroadcastNumberAsNumber
```
public Number getBroadcastNumberAsNumber()
```
    Get the Broadcast Number (component4) as Number
    
    Returns:
    the Broadcast Number from component4 converted to Number or null if cannot be converted
  - setComponent4
```
public Field133 setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field133 setComponent4(Number component4)
```
    Set the component4.
    
    Parameters:
    component4 - the Number with the component4 content to set
  - setBroadcastNumber
```
public Field133 setBroadcastNumber(String component4)
```
    Set the Broadcast Number (component4).
    
    Parameters:
    component4 - the Broadcast Number to set
  - setBroadcastNumber
```
public Field133 setBroadcastNumber(Number component4)
```
    Set the Broadcast Number (component4) as Number
    
    Parameters:
    component4 - Number with the Broadcast Number content 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 Field133
    
    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 Field133 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 Field133 get(SwiftMessage msg)
```
    Get the first instance of Field133 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<Field133> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field133 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<Field133> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field133 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 Field133

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_133

PARSER_PATTERN

COMPONENTS_PATTERN

BROADCAST_INITIATOR

UNSEQUENCED_BROADCAST

BROADCAST_ISSUER

BROADCAST_NUMBER

Constructor Detail

Field133

Field133

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getBroadcastInitiator

setComponent1

setBroadcastInitiator

getComponent2

getComponent2AsString

getUnsequencedBroadcast

setComponent2

setUnsequencedBroadcast

getComponent3

getComponent3AsString

getBroadcastIssuer

setComponent3

setBroadcastIssuer

getComponent4

getComponent4AsNumber

getBroadcastNumber

getBroadcastNumberAsNumber

setComponent4

setComponent4

setBroadcastNumber

setBroadcastNumber

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize