Allocation (lib-openssrf-3.1.0 1.0.0 API)

java.lang.Object
- us.gov.dod.standard.ssrf._3_1.toa.Allocation

```
public class Allocation
extends Object
```
Allocation contains the allocation of a specific frequency band to a specific radiocommunication service.
Element of FreqBand
Sub-Elements are StnClass, Variance

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors
Constructor and Description

Allocation()

Constructors
Constructor and Description
`Allocation()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TString`	`getAllocatedByFootnote()` Get "Yes" if this service is allocated to this frequency band by footnote (i.e., the only indication this service is allowed in this band is a footnote).
`TString`	`getAllocatedService()` Get a radiocommunication service recognized by an administration that is allocated to this frequency band (e.g., "Fixed Service")..
`Set<ChannelPlan>`	`getChannelPlan()` Get the ChannelPlanRef
`Set<Serial>`	`getChannelPlanRef()` Deprecated. SSRF references are managed automatically. Use `getChannelPlan()` instead.
`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<BigInteger>`	`getFootnotes()` Get a list containing each Footnote index that is applicable to the current band Allocation.
`TString`	`getPriority()` Get if this service is a primary or secondary use of this band.
`Set<StnClass>`	`getStnClass()` Get the StnClass
`Set<Variance>`	`getVariance()` Get the Variance
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetAllocatedByFootnote()` Determine if the AllocatedByFootnote is configured.
`boolean`	`isSetAllocatedService()` Determine if the AllocatedService is configured.
`boolean`	`isSetChannelPlan()` Determine if the channelPlan field is configured.
`boolean`	`isSetChannelPlanRef()` Determine if the ChannelPlanRef is configured.
`boolean`	`isSetEffectiveDate()` Determine if the EffectiveDate is configured.
`boolean`	`isSetExpirationDate()` Determine if the ExpirationDate is configured.
`boolean`	`isSetFootnotes()` Determine if the Footnotes is configured.
`boolean`	`isSetPriority()` Determine if the Priority is configured.
`boolean`	`isSetStnClass()` Determine if the StnClass is configured.
`boolean`	`isSetVariance()` Determine if the Variance is configured.
`void`	`postLoad(SSRF root)` Update the SSRF data type references in this Allocation record after loading from XML.
`void`	`prepare()` Update the SSRF data type references in this Allocation record.
`void`	`setAllocatedByFootnote(TString value)` Set "Yes" if this service is allocated to this frequency band by footnote (i.e., the only indication this service is allowed in this band is a footnote).
`void`	`setAllocatedService(TString value)` Set a radiocommunication service recognized by an administration that is allocated to this frequency band (e.g., "Fixed Service")..
`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`	`setPriority(TString value)` Set if this service is a primary or secondary use of this band.
`String`	`toString()` Get a string representation of this Allocation instance configuration.
`void`	`unsetChannelPlanRef()` Clear the ChannelPlanRef field.
`void`	`unsetFootnotes()` Clear the Footnotes field.
`void`	`unsetStnClass()` Clear the StnClass field.
`void`	`unsetVariance()` Clear the Variance field.
`Allocation`	`withAllocatedByFootnote(ListCBO value)` Set "Yes" if this service is allocated to this frequency band by footnote (i.e., the only indication this service is allowed in this band is a footnote).
`Allocation`	`withAllocatedService(ListCSN value)` Set a radiocommunication service recognized by an administration that is allocated to this frequency band (e.g., "Fixed Service").
`Allocation`	`withChannelPlan(ChannelPlan... values)` Set the ChannelPlanRef
`Allocation`	`withChannelPlan(Collection<ChannelPlan> values)` Set the ChannelPlanRef
`Allocation`	`withChannelPlanRef(Collection<Serial> values)` Deprecated. SSRF references are managed automatically. Use `withChannelPlan(ChannelPlan...)` instead.
`Allocation`	`withChannelPlanRef(Serial... values)` Deprecated. SSRF references are managed automatically. Use `withChannelPlan(ChannelPlan...)` instead.
`Allocation`	`withEffectiveDate(Calendar value)` Set the date by which the dataset is to be operational or effective.
`Allocation`	`withEffectiveDate(Date value)` Set the date by which the dataset is to be operational or effective.
`Allocation`	`withExpirationDate(Calendar value)` Set the date at which the dataset will expire.
`Allocation`	`withExpirationDate(Date value)` Set the date at which the dataset will expire.
`Allocation`	`withFootnotes(BigInteger... values)` Set a list containing each Footnote index that is applicable to the current band Allocation.
`Allocation`	`withFootnotes(Collection<BigInteger> values)` Set a list containing each Footnote index that is applicable to the current band Allocation.
`Allocation`	`withPriority(ListCPS value)` Set if this service is a primary or secondary use of this band.
`Allocation`	`withStnClass(Collection<StnClass> values)` Set the StnClass
`Allocation`	`withStnClass(StnClass... values)` Set the StnClass
`Allocation`	`withVariance(Collection<Variance> values)` Set the Variance
`Allocation`	`withVariance(Variance... values)` Set the Variance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Allocation
```
public Allocation()
```
- Method Detail
  - getAllocatedService
```
public TString getAllocatedService()
```
    Get a radiocommunication service recognized by an administration that is allocated to this frequency band (e.g., "Fixed Service")..
    
    Returns:
    
    the AllocatedService value in a TString data type
    
    Since:
    
    3.1.0
  - setAllocatedService
```
public void setAllocatedService(TString value)
```
    Set a radiocommunication service recognized by an administration that is allocated to this frequency band (e.g., "Fixed Service")..
    
    Parameters:
    
    value - the AllocatedService value in a TString data type
    
    Since:
    
    3.1.0
  - isSetAllocatedService
```
public boolean isSetAllocatedService()
```
    Determine if the AllocatedService 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
  - getPriority
```
public TString getPriority()
```
    Get if this service is a primary or secondary use of this band. ("Permitted" SHOULD only be used if the priority is unknown.).
    
    Returns:
    
    the Priority value in a TString data type
    
    Since:
    
    3.1.0
  - setPriority
```
public void setPriority(TString value)
```
    Set if this service is a primary or secondary use of this band. ("Permitted" SHOULD only be used if the priority is unknown.).
    
    Parameters:
    
    value - the Priority value in a TString data type
    
    Since:
    
    3.1.0
  - isSetPriority
```
public boolean isSetPriority()
```
    Determine if the Priority 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
  - 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
  - getAllocatedByFootnote
```
public TString getAllocatedByFootnote()
```
    Get "Yes" if this service is allocated to this frequency band by footnote (i.e., the only indication this service is allowed in this band is a footnote). Additional restrictions might exist in the footnote(s)..
    
    Returns:
    
    the AllocatedByFootnote value in a TString data type
    
    Since:
    
    3.1.0
  - setAllocatedByFootnote
```
public void setAllocatedByFootnote(TString value)
```
    Set "Yes" if this service is allocated to this frequency band by footnote (i.e., the only indication this service is allowed in this band is a footnote). Additional restrictions might exist in the footnote(s)..
    
    Parameters:
    
    value - the AllocatedByFootnote value in a TString data type
    
    Since:
    
    3.1.0
  - isSetAllocatedByFootnote
```
public boolean isSetAllocatedByFootnote()
```
    Determine if the AllocatedByFootnote 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
  - getVariance
```
public Set<Variance> getVariance()
```
    Get the Variance
    Complex element Variance indicates if the local allocation deviates from an upper level allocation (e.g. a national allocation not aligned with the ITU RR)..
    
    Returns:
    
    a Variance instance
    
    Since:
    
    3.1.0
  - isSetVariance
```
public boolean isSetVariance()
```
    Determine if the Variance is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetVariance
```
public void unsetVariance()
```
    Clear the Variance field. This sets the field to null.
  - getStnClass
```
public Set<StnClass> getStnClass()
```
    Get the StnClass
    Complex element StnClass contains the station class associated with the TOA frequency usage..
    
    Returns:
    
    a StnClass instance
    
    Since:
    
    3.1.0
  - isSetStnClass
```
public boolean isSetStnClass()
```
    Determine if the StnClass is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetStnClass
```
public void unsetStnClass()
```
    Clear the StnClass 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 references the 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.
  - getFootnotes
```
public Set<BigInteger> getFootnotes()
```
    Get a list containing each Footnote index that is applicable to the current band Allocation. Each entry in the list should be separated by a blank space..
    
    Returns:
    
    a BigInteger instance
    
    Since:
    
    3.1.0
  - isSetFootnotes
```
public boolean isSetFootnotes()
```
    Determine if the Footnotes is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetFootnotes
```
public void unsetFootnotes()
```
    Clear the Footnotes field. This sets the field to null.
  - withAllocatedService
```
public Allocation withAllocatedService(ListCSN value)
```
    Set a radiocommunication service recognized by an administration that is allocated to this frequency band (e.g., "Fixed Service").
    
    Parameters:
    
    value - An instances of type ListCSN.
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withPriority
```
public Allocation withPriority(ListCPS value)
```
    Set if this service is a primary or secondary use of this band. ("Permitted" SHOULD only be used if the priority is unknown.)
    
    Parameters:
    
    value - An instances of type ListCPS.
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withEffectiveDate
```
public Allocation 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 Allocation object instance.
    
    Since:
    
    3.1.0
  - withEffectiveDate
```
public Allocation 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 Allocation object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Allocation 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 Allocation object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Allocation 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 Allocation object instance.
    
    Since:
    
    3.1.0
  - withAllocatedByFootnote
```
public Allocation withAllocatedByFootnote(ListCBO value)
```
    Set "Yes" if this service is allocated to this frequency band by footnote (i.e., the only indication this service is allowed in this band is a footnote). Additional restrictions might exist in the footnote(s).
    
    Parameters:
    
    value - An instances of type ListCBO.
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withVariance
```
public Allocation withVariance(Variance... values)
```
    Set the Variance
    Complex element Variance indicates if the local allocation deviates from an upper level allocation (e.g. a national allocation not aligned with the ITU RR).
    
    Parameters:
    
    values - One or more instances of type Variance....
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withVariance
```
public Allocation withVariance(Collection<Variance> values)
```
    Set the Variance
    Complex element Variance indicates if the local allocation deviates from an upper level allocation (e.g. a national allocation not aligned with the ITU RR).
    
    Parameters:
    
    values - A collection of Variance instances
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withStnClass
```
public Allocation withStnClass(StnClass... values)
```
    Set the StnClass
    Complex element StnClass contains the station class associated with the TOA frequency usage.
    
    Parameters:
    
    values - One or more instances of type StnClass....
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withStnClass
```
public Allocation withStnClass(Collection<StnClass> values)
```
    Set the StnClass
    Complex element StnClass contains the station class associated with the TOA frequency usage.
    
    Parameters:
    
    values - A collection of StnClass instances
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withChannelPlanRef
```
@Deprecated
public Allocation withChannelPlanRef(Serial... values)
```
    Deprecated. SSRF references are managed automatically. Use withChannelPlan(ChannelPlan...) instead.
    
    Set the ChannelPlanRef
    Complex element ChannelPlanRef references the ChannelPlan.
    
    Parameters:
    
    values - One or more instances of type ChannelPlanRef....
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withChannelPlanRef
```
@Deprecated
public Allocation withChannelPlanRef(Collection<Serial> values)
```
    Deprecated. SSRF references are managed automatically. Use withChannelPlan(ChannelPlan...) instead.
    
    Set the ChannelPlanRef
    Complex element ChannelPlanRef references the ChannelPlan.
    
    Parameters:
    
    values - A collection of Serial instances
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withFootnotes
```
public Allocation withFootnotes(BigInteger... values)
```
    Set a list containing each Footnote index that is applicable to the current band Allocation. Each entry in the list should be separated by a blank space.
    
    Parameters:
    
    values - One or more instances of type BigInteger....
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withFootnotes
```
public Allocation withFootnotes(Collection<BigInteger> values)
```
    Set a list containing each Footnote index that is applicable to the current band Allocation. Each entry in the list should be separated by a blank space.
    
    Parameters:
    
    values - A collection of Footnotes instances
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this Allocation 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.
    Allocation requires AllocatedService, Priority.
    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
  - getChannelPlan
```
public Set<ChannelPlan> getChannelPlan()
```
    Get the ChannelPlanRef
    Complex element ChannelPlanRef references the 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 Allocation withChannelPlan(ChannelPlan... values)
```
    Set the ChannelPlanRef
    Complex element ChannelPlanRef references the ChannelPlan.
    
    Parameters:
    
    values - An instances of type ChannelPlan.
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - withChannelPlan
```
public Allocation withChannelPlan(Collection<ChannelPlan> values)
```
    Set the ChannelPlanRef
    Complex element ChannelPlanRef references the ChannelPlan.
    
    Parameters:
    
    values - An instances of type ChannelPlan.
    
    Returns:
    
    The current Allocation object instance.
    
    Since:
    
    3.1.0
  - prepare
```
public void prepare()
```
    Update the SSRF data type references in this Allocation record.
    This method builds the exported channelPlanRef field with values from the transient channelPlan field. This method should typically be called after the Allocation is configured and (optionally) before exporting an SSRF message.
    
    Since:
    
    3.1.0
  - postLoad
```
public void postLoad(SSRF root)
```
    Update the SSRF data type references in this Allocation 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 Allocation is imported from XML.
    
    Parameters:
    
    root - the SSRF root instance.
    
    Since:
    
    3.1.0

Class Allocation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Allocation

Method Detail

getAllocatedService

setAllocatedService

isSetAllocatedService

getPriority

setPriority

isSetPriority

getEffectiveDate

setEffectiveDate

isSetEffectiveDate

getExpirationDate

setExpirationDate

isSetExpirationDate

getAllocatedByFootnote

setAllocatedByFootnote

isSetAllocatedByFootnote

getVariance

isSetVariance

unsetVariance

getStnClass

isSetStnClass

unsetStnClass

getChannelPlanRef

isSetChannelPlanRef

unsetChannelPlanRef

getFootnotes

isSetFootnotes

unsetFootnotes

withAllocatedService

withPriority

withEffectiveDate

withEffectiveDate

withExpirationDate

withExpirationDate

withAllocatedByFootnote

withVariance

withVariance

withStnClass

withStnClass

withChannelPlanRef

withChannelPlanRef

withFootnotes

withFootnotes

toString

isSet

getChannelPlan

isSetChannelPlan

withChannelPlan

withChannelPlan

prepare

postLoad