us.gov.dod.standard.ssrf._3_1.toa

Class Footnote

java.lang.Object

us.gov.dod.standard.ssrf._3_1.toa.Footnote

public class Footnote
extends Object

Footnote contains the text and identifier of a Footnote, FCC Rule Part Number, Band User (e.g., "Military", "Civil Support Team"). or Band Application (e.g., "Wind Profiler").

Element of TOA

Example:

 < Footnote cls="U" idx="007">
        <NoteType>Band Application</NoteType>
        <Identifier></Identifier>
        <Text>Sprocket 77</Text>
 </Footnote >
 < Footnote cls="U" idx="117">
        <NoteType>Footnote-National</NoteType>
        <Identifier>US251</Identifier>
        <Text>The band 12.75-13.25 GHz is also allocated to the space research (deep space) (space-to-Earth) service for reception only at Goldstone, CA (35° 20' N, 116° 53' W).
        </Text>
 </Footnote >
 < Footnote cls="U" idx="572">
        <NoteType>Footnote-ITU</NoteType>
        <Identifier>5.54</Identifier>
        <Text>Administrations conducting scientific research using frequencies below 9 kHz are urged to advise other administrations that may be concerned in order that such research may be afforded all practicable protection from harmful interference.
        </Text>
 </Footnote >
 < Footnote cls="U" idx="4545">
        <NoteType>FCC Part</NoteType>
        <Identifier>(90)</Identifier>
        <Text>Private Land Mobile</Text>
    </Footnote >
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Footnote()

Method Summary

Modifier and Type	Method and Description
TString	getFootnoteType() Get the type or source of the Footnote..
S255	getIdentifier() Get an identifier for this Footnote (e.g., US2, 5.441).
BigInteger	getIdx() Get a unique index for each Footnote used by this Dataset.
MEMO	getText() Get the textual specification of the footnote, band user or band application..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetFootnoteType() Determine if the FootnoteType is configured.
boolean	isSetIdentifier() Determine if the Identifier is configured.
boolean	isSetIdx() Determine if the Idx is configured.
boolean	isSetText() Determine if the Text is configured.
void	setFootnoteType(TString value) Set the type or source of the Footnote..
void	setIdentifier(S255 value) Set an identifier for this Footnote (e.g., US2, 5.441).
void	setIdx(BigInteger value) Set a unique index for each Footnote used by this Dataset.
void	setText(MEMO value) Set the textual specification of the footnote, band user or band application..
String	toString() Get a string representation of this Footnote instance configuration.
Footnote	withFootnoteType(ListCTA value) Set the type or source of the Footnote.
Footnote	withIdentifier(String value) Set an identifier for this Footnote (e.g., US2, 5.441).
Footnote	withIdx(BigInteger value) Set a unique index for each Footnote used by this Dataset.
Footnote	withText(String value) Set the textual specification of the footnote, band user or band application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Footnote

public Footnote()

Method Detail

getFootnoteType

public TString getFootnoteType()

Get the type or source of the Footnote..

Returns:

the FootnoteType value in a TString data type

Since:

3.1.0

setFootnoteType

public void setFootnoteType(TString value)

Set the type or source of the Footnote..

Parameters:

value - the FootnoteType value in a TString data type

Since:

3.1.0

isSetFootnoteType

public boolean isSetFootnoteType()

Determine if the FootnoteType is configured.

If configured this method also inspects the TString wrapped value.

Returns:

TRUE if the field is set, FALSE if the field is null

getIdentifier

public S255 getIdentifier()

Get an identifier for this Footnote (e.g., US2, 5.441). This Data Item is optional if NoteType is Band User or Band Application..

Returns:

a S255 instance

Since:

3.1.0

setIdentifier

public void setIdentifier(S255 value)

Set an identifier for this Footnote (e.g., US2, 5.441). This Data Item is optional if NoteType is Band User or Band Application..

Parameters:

value - a S255 instance

Since:

3.1.0

isSetIdentifier

public boolean isSetIdentifier()

Determine if the Identifier is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getText

public MEMO getText()

Get the textual specification of the footnote, band user or band application..

Returns:

a MEMO instance

Since:

3.1.0

setText

public void setText(MEMO value)

Set the textual specification of the footnote, band user or band application..

Parameters:

value - a MEMO instance

Since:

3.1.0

isSetText

public boolean isSetText()

Determine if the Text is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getIdx

public BigInteger getIdx()

Get a unique index for each Footnote used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted. .

Returns:

a BigInteger instance

Since:

3.1.0

setIdx

public void setIdx(BigInteger value)

Set a unique index for each Footnote used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted. .

Parameters:

value - a BigInteger instance

Since:

3.1.0

isSetIdx

public boolean isSetIdx()

Determine if the Idx is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

withFootnoteType

public Footnote withFootnoteType(ListCTA value)

Set the type or source of the Footnote.

Parameters:

value - An instances of type ListCTA.

Returns:

The current Footnote object instance.

Since:

3.1.0

withIdentifier

public Footnote withIdentifier(String value)

Set an identifier for this Footnote (e.g., US2, 5.441). This Data Item is optional if NoteType is Band User or Band Application.

Parameters:

value - An instances of type String.

Returns:

The current Footnote object instance.

Since:

3.1.0

withText

public Footnote withText(String value)

Set the textual specification of the footnote, band user or band application.

Parameters:

value - An instances of type String.

Returns:

The current Footnote object instance.

Since:

3.1.0

withIdx

public Footnote withIdx(BigInteger value)

Set a unique index for each Footnote used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted.

Parameters:

value - An instances of type BigInteger.

Returns:

The current Footnote object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this Footnote instance configuration.

Overrides:

toString in class Object

Returns:

The current object instance configuration as a non-null String

isSet

public boolean isSet()

Determine if the required fields in this SSRF data type instance are set.

Footnote requires FootnoteType, Identifier, Text, idx.

Note that this method only checks for the presence of required information; this method does not validate the information format.

Returns:

TRUE if required fields are set, otherwise FALSE