us.gov.dod.standard.ssrf._3_1

Class TOA

java.lang.Object

us.gov.dod.standard.ssrf._3_1.Common<TOA>

us.gov.dod.standard.ssrf._3_1.TOA

All Implemented Interfaces:

Comparable<TOA>

public class TOA
extends Common<TOA>

TOA is the XML root for all parameters of a Table of Allocations. It inherits attributes and sub-elements from element Common.

Sub-Elements are Country, Footnote, FreqBand

Example:

 <TOA cls="U">
   <Serial cls="U">USA:NTIA:TA:1</Serial>
   <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime>
   <Administration cls="U">NTIA</Administration>
   <FreqBand>
     <FreqMin cls="U">230</FreqMin>
     <FreqMax cls="U">400</FreqMax>
     <Allocation>
       <AllocatedService cls="U">Mobile Service</AllocatedService>
       <Priority cls="U">Primary</Priority>
     </Allocation>
   </FreqBand>
 </TOA>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Field Summary

Fields inherited from class us.gov.dod.standard.ssrf._3_1.Common

approvedBy, approvedDateTime, caseNum, cls, description, entryBy, entryByRole, entryDateTime, extReferenceRef, extReferences, idref, lastChangeBy, lastChangeByRole, lastChangeDateTime, lastObservedBy, lastReviewBy, lastReviewByRole, lastReviewDate, legacyReleasability, modAllowedBy, modAllowedByRole, observedFirstDateTime, observedLastDateTime, owner, ownerRole, quality, recommendedValue, redacted, releasability, remarkRef, remarks, securityClass, serial, state

Constructor Summary

Constructors

Constructor and Description
TOA() No arg constructor.

Method Summary

Modifier and Type	Method and Description
S50	getAdministration() Get the nation or regulatory body that administers this Table of Allocations..
Set<ChannelPlan>	getChannelPlan() Get the ChannelPlanRef
Set<Serial>	getChannelPlanRef() Deprecated. SSRF references are managed automatically. Use getChannelPlan() instead.
Set<Country>	getCountry() Get the Country
D	getEffectiveDate() Get the date by which the dataset is to be operational or effective..
D	getExpirationDate() Get the date at which the dataset will expire.
Set<Footnote>	getFootnote() Get the Footnote
Set<FreqBand>	getFreqBand() Get the FreqBand
S100	getTitle() Get an identifying name for this Table of Allocations..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAdministration() Determine if the Administration is configured.
boolean	isSetChannelPlan() Determine if the channelPlan field is configured.
boolean	isSetChannelPlanRef() Determine if the ChannelPlanRef is configured.
boolean	isSetCountry() Determine if the Country is configured.
boolean	isSetEffectiveDate() Determine if the EffectiveDate is configured.
boolean	isSetExpirationDate() Determine if the ExpirationDate is configured.
boolean	isSetFootnote() Determine if the Footnote is configured.
boolean	isSetFreqBand() Determine if the FreqBand is configured.
boolean	isSetTitle() Determine if the Title is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this TOA record after loading from XML.
void	prepare() Update the SSRF data type references in this TOA record.
void	setAdministration(S50 value) Set the nation or regulatory body that administers this Table of Allocations..
void	setEffectiveDate(D value) Set the date by which the dataset is to be operational or effective..
void	setExpirationDate(D value) Set the date at which the dataset will expire.
void	setTitle(S100 value) Set an identifying name for this Table of Allocations..
String	toString() Get a string representation of this TOA instance configuration.
void	unsetChannelPlanRef() Clear the ChannelPlanRef field.
void	unsetCountry() Clear the Country field.
void	unsetFootnote() Clear the Footnote field.
void	unsetFreqBand() Clear the FreqBand field.
TOA	withAdministration(String value) Set the nation or regulatory body that administers this Table of Allocations.
TOA	withChannelPlan(ChannelPlan... values) Set the ChannelPlanRef
TOA	withChannelPlan(Collection<ChannelPlan> values) Set the ChannelPlanRef
TOA	withChannelPlanRef(Collection<Serial> values) Deprecated. SSRF references are managed automatically. Use withChannelPlan(ChannelPlan...) instead.
TOA	withChannelPlanRef(Serial... values) Deprecated. SSRF references are managed automatically. Use withChannelPlan(ChannelPlan...) instead.
TOA	withCountry(Collection<Country> values) Set the Country
TOA	withCountry(Country... values) Set the Country
TOA	withEffectiveDate(Calendar value) Set the date by which the dataset is to be operational or effective.
TOA	withEffectiveDate(Date value) Set the date by which the dataset is to be operational or effective.
TOA	withExpirationDate(Calendar value) Set the date at which the dataset will expire.
TOA	withExpirationDate(Date value) Set the date at which the dataset will expire.
TOA	withFootnote(Collection<Footnote> values) Set the Footnote
TOA	withFootnote(Footnote... values) Set the Footnote
TOA	withFreqBand(Collection<FreqBand> values) Set the FreqBand
TOA	withFreqBand(FreqBand... values) Set the FreqBand
TOA	withTitle(String value) Set an identifying name for this Table of Allocations.

Methods inherited from class us.gov.dod.standard.ssrf._3_1.Common

compareTo, equals, getApprovedBy, getApprovedDateTime, getCaseNum, getCls, getDescription, getEntryBy, getEntryByRole, getEntryDateTime, getExtReferenceRef, getExtReferences, getIdref, getLastChangeBy, getLastChangeByRole, getLastChangeDateTime, getLastObservedBy, getLastReviewBy, getLastReviewByRole, getLastReviewDate, getLegacyReleasability, getModAllowedBy, getModAllowedByRole, getObservedFirstDateTime, getObservedLastDateTime, getOwner, getOwnerRole, getQuality, getRecommendedValue, getRedacted, getReleasability, getRemarkRef, getRemarks, getSecurityClass, getSerial, getState, hashCode, isSetApprovedBy, isSetApprovedDateTime, isSetCaseNum, isSetCls, isSetDescription, isSetEntryBy, isSetEntryByRole, isSetEntryDateTime, isSetExtReferenceRef, isSetExtReferences, isSetIdref, isSetLastChangeBy, isSetLastChangeByRole, isSetLastChangeDateTime, isSetLastObservedBy, isSetLastReviewBy, isSetLastReviewByRole, isSetLastReviewDate, isSetLegacyReleasability, isSetModAllowedBy, isSetModAllowedByRole, isSetObservedFirstDateTime, isSetObservedLastDateTime, isSetOwner, isSetOwnerRole, isSetQuality, isSetRecommendedValue, isSetRedacted, isSetReleasability, isSetRemarkRef, isSetRemarks, isSetSecurityClass, isSetSerial, isSetState, setApprovedBy, setApprovedDateTime, setCls, setDescription, setEntryBy, setEntryDateTime, setIdref, setLastChangeBy, setLastChangeDateTime, setLastObservedBy, setLastReviewBy, setLastReviewDate, setLegacyReleasability, setModAllowedBy, setObservedFirstDateTime, setObservedLastDateTime, setOwner, setQuality, setRecommendedValue, setRedacted, setSecurityClass, setSerial, setState, unsetCaseNum, unsetExtReferenceRef, unsetExtReferences, unsetReleasability, unsetRemarkRef, unsetRemarks, withApprovedBy, withApprovedDateTime, withApprovedDateTime, withCaseNum, withCaseNum, withCls, withDescription, withEntryBy, withEntryByRole, withEntryDateTime, withExtReferenceRef, withExtReferenceRef, withExtReferences, withExtReferences, withExtReferences, withIdref, withLastChangeBy, withLastChangeByRole, withLastChangeDateTime, withLastChangeDateTime, withLastObservedBy, withLastReviewBy, withLastReviewByRole, withLastReviewDate, withLastReviewDate, withLegacyReleasability, withModAllowedBy, withModAllowedByRole, withObservedFirstDateTime, withObservedFirstDateTime, withObservedLastDateTime, withObservedLastDateTime, withOwner, withOwnerRole, withQuality, withRecommendedValue, withRedacted, withReleasability, withReleasability, withRemarkRef, withRemarkRef, withRemarkRef, withRemarks, withRemarks, withSecurityClass, withSerial, withState

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TOA

public TOA()

No arg constructor. Initializes the Common required fields.

Method Detail

getAdministration

public S50 getAdministration()

Get the nation or regulatory body that administers this Table of Allocations..

Returns:

a S50 instance

Since:

3.1.0

setAdministration

public void setAdministration(S50 value)

Set the nation or regulatory body that administers this Table of Allocations..

Parameters:

value - a S50 instance

Since:

3.1.0

isSetAdministration

public boolean isSetAdministration()

Determine if the Administration is configured.

Returns:

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

getEffectiveDate

public D getEffectiveDate()

Get the date by which the dataset is to be operational or effective..

Returns:

a D instance

Since:

3.1.0

setEffectiveDate

public void setEffectiveDate(D value)

Set the date by which the dataset is to be operational or effective..

Parameters:

value - a D instance

Since:

3.1.0

isSetEffectiveDate

public boolean isSetEffectiveDate()

Determine if the EffectiveDate is configured.

Returns:

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

getExpirationDate

public D getExpirationDate()

Get the date at which the dataset will expire. The Expiration date should be less than five years from current date..

Returns:

a D instance

Since:

3.1.0

setExpirationDate

public void setExpirationDate(D value)

Set the date at which the dataset will expire. The Expiration date should be less than five years from current date..

Parameters:

value - a D instance

Since:

3.1.0

isSetExpirationDate

public boolean isSetExpirationDate()

Determine if the ExpirationDate is configured.

Returns:

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

getTitle

public S100 getTitle()

Get an identifying name for this Table of Allocations..

Returns:

a S100 instance

Since:

3.1.0

setTitle

public void setTitle(S100 value)

Set an identifying name for this Table of Allocations..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetTitle

public boolean isSetTitle()

Determine if the Title is configured.

Returns:

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

getFootnote

public Set<Footnote> getFootnote()

Get the Footnote

Complex element 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")..

Returns:

a Footnote instance

Since:

3.1.0

isSetFootnote

public boolean isSetFootnote()

Determine if the Footnote is configured.

Returns:

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

unsetFootnote

public void unsetFootnote()

Clear the Footnote field. This sets the field to null.

getChannelPlanRef

@Deprecated
public Set<Serial> getChannelPlanRef()

Deprecated. SSRF references are managed automatically. Use getChannelPlan() instead.

Get the ChannelPlanRef

Complex element ChannelPlanRef refers to a ChannelPlan..

Returns:

a Serial instance

Since:

3.1.0

isSetChannelPlanRef

public boolean isSetChannelPlanRef()

Determine if the ChannelPlanRef is configured.

Returns:

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

unsetChannelPlanRef

public void unsetChannelPlanRef()

Clear the ChannelPlanRef field. This sets the field to null.

getCountry

public Set<Country> getCountry()

Get the Country

Complex element Country indicates the country or area for which this Table of Allocations is in force..

Returns:

a Country instance

Since:

3.1.0

isSetCountry

public boolean isSetCountry()

Determine if the Country is configured.

Returns:

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

unsetCountry

public void unsetCountry()

Clear the Country field. This sets the field to null.

getFreqBand

public Set<FreqBand> getFreqBand()

Get the FreqBand

Complex element FreqBand contains the allocation of a specific frequency band to radiocommunication services. It may also provide additional information such as the specification of the rights and responsibilities of a user..

Returns:

a FreqBand instance

Since:

3.1.0

isSetFreqBand

public boolean isSetFreqBand()

Determine if the FreqBand is configured.

Returns:

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

unsetFreqBand

public void unsetFreqBand()

Clear the FreqBand field. This sets the field to null.

withAdministration

public TOA withAdministration(String value)

Set the nation or regulatory body that administers this Table of Allocations.

Parameters:

value - An instances of type String.

Returns:

The current TOA object instance.

Since:

3.1.0

withEffectiveDate

public TOA withEffectiveDate(Calendar value)

Set the date by which the dataset is to be operational or effective.

Parameters:

value - An instances of type Calendar.

Returns:

The current TOA object instance.

Since:

3.1.0

withEffectiveDate

public TOA withEffectiveDate(Date value)

Set the date by which the dataset is to be operational or effective.

Parameters:

value - An instances of type Date.

Returns:

The current TOA object instance.

Since:

3.1.0

withExpirationDate

public TOA withExpirationDate(Calendar value)

Set the date at which the dataset will expire. The Expiration date should be less than five years from current date.

Parameters:

value - An instances of type Calendar.

Returns:

The current TOA object instance.

Since:

3.1.0

withExpirationDate

public TOA withExpirationDate(Date value)

Set the date at which the dataset will expire. The Expiration date should be less than five years from current date.

Parameters:

value - An instances of type Date.

Returns:

The current TOA object instance.

Since:

3.1.0

withTitle

public TOA withTitle(String value)

Set an identifying name for this Table of Allocations.

Parameters:

value - An instances of type String.

Returns:

The current TOA object instance.

Since:

3.1.0

withFootnote

public TOA withFootnote(Footnote... values)

Set the Footnote

Complex element 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").

Parameters:

values - One or more instances of type Footnote....

Returns:

The current TOA object instance.

Since:

3.1.0

withFootnote

public TOA withFootnote(Collection<Footnote> values)

Set the Footnote

Complex element 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").

Parameters:

values - A collection of Footnote instances

Returns:

The current TOA object instance.

Since:

3.1.0

withChannelPlanRef

@Deprecated
public TOA withChannelPlanRef(Serial... values)

Deprecated. SSRF references are managed automatically. Use withChannelPlan(ChannelPlan...) instead.

Set the ChannelPlanRef

Complex element ChannelPlanRef refers to a ChannelPlan.

Parameters:

values - One or more instances of type ChannelPlanRef....

Returns:

The current TOA object instance.

Since:

3.1.0

withChannelPlanRef

@Deprecated
public TOA withChannelPlanRef(Collection<Serial> values)

Deprecated. SSRF references are managed automatically. Use withChannelPlan(ChannelPlan...) instead.

Set the ChannelPlanRef

Complex element ChannelPlanRef refers to a ChannelPlan.

Parameters:

values - A collection of Serial instances

Returns:

The current TOA object instance.

Since:

3.1.0

withCountry

public TOA withCountry(Country... values)

Set the Country

Complex element Country indicates the country or area for which this Table of Allocations is in force.

Parameters:

values - One or more instances of type Country....

Returns:

The current TOA object instance.

Since:

3.1.0

withCountry

public TOA withCountry(Collection<Country> values)

Set the Country

Complex element Country indicates the country or area for which this Table of Allocations is in force.

Parameters:

values - A collection of Country instances

Returns:

The current TOA object instance.

Since:

3.1.0

withFreqBand

public TOA withFreqBand(FreqBand... values)

Set the FreqBand

Complex element FreqBand contains the allocation of a specific frequency band to radiocommunication services. It may also provide additional information such as the specification of the rights and responsibilities of a user.

Parameters:

values - One or more instances of type FreqBand....

Returns:

The current TOA object instance.

Since:

3.1.0

withFreqBand

public TOA withFreqBand(Collection<FreqBand> values)

Set the FreqBand

Complex element FreqBand contains the allocation of a specific frequency band to radiocommunication services. It may also provide additional information such as the specification of the rights and responsibilities of a user.

Parameters:

values - A collection of FreqBand instances

Returns:

The current TOA object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this TOA instance configuration.

Overrides:

toString in class Common<TOA>

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.

TOA requires cls, Serial, EntryDateTime and Administration, FreqBand.

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

Overrides:

isSet in class Common<TOA>

Returns:

TRUE if required fields are set, otherwise FALSE

getChannelPlan

public Set<ChannelPlan> getChannelPlan()

Get the ChannelPlanRef

Complex element ChannelPlanRef refers to a ChannelPlan..

Returns:

a ChannelPlan instance

Since:

3.1.0

isSetChannelPlan

public boolean isSetChannelPlan()

Determine if the channelPlan field is configured.

Returns:

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

withChannelPlan

public TOA withChannelPlan(ChannelPlan... values)

Set the ChannelPlanRef

Complex element ChannelPlanRef refers to a ChannelPlan.

Parameters:

values - An instances of type ChannelPlan.

Returns:

The current TOA object instance.

Since:

3.1.0

withChannelPlan

public TOA withChannelPlan(Collection<ChannelPlan> values)

Set the ChannelPlanRef

Complex element ChannelPlanRef refers to a ChannelPlan.

Parameters:

values - An instances of type ChannelPlan.

Returns:

The current TOA object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this TOA record.

This method builds the exported channelPlanRef field with values from the transient channelPlan field. This method should typically be called after the TOA is configured and (optionally) before exporting an SSRF message.

Overrides:

prepare in class Common<TOA>

Since:

3.1.0

postLoad

public void postLoad(SSRF root)

Update the SSRF data type references in this TOA record after loading from XML.

This method builds the transient channelPlan with values from the imported channelPlanRef field. This method should typically be called after the TOA is imported from XML.

Overrides:

postLoad in class Common<TOA>

Parameters:

root - the SSRF root instance.

Since:

3.1.0