public class Allotment extends Common<Allotment>
Sub-Elements are
AllotFreq
, Emission
, POCInformation
, Project
Example:
<Allotment cls="U"> <Serial cls="U">USA::AL:123</Serial> <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime> <Title cls="U">Allotment Title Here</Title> <UsageType cls="U">Request Permanent</UsageType> <DateResponseRequired cls="U">2011-12-25</DateResponseRequired> <EffectiveDate cls="U">2012-01-01</EffectiveDate> <ExpirationDate cls="U">2106-01-01</ExpirationDate> <ReviewDate cls="U">2104-01-01</ReviewDate> <Requirement cls="U">Need reply ASAP</Requirement> <AllotFreq> <FreqMin cls="U">30</FreqMin> <FreqMax cls="U">35</FreqMax> <PairedFreqMin cls=āUā>20.5</PairedFreqMin> <TuningStep cls="U">0.050</TuningStep> <LocationRestriction cls="U">DEU::LO:25001</LocationRestriction> </AllotFreq> <Emission> <EmsClass cls="U">G1D</EmsClass> <NecessaryBw cls="U">2.5</NecessaryBw> <Power cls="U">1.2</Power> </Emission> <LocationRef cls="U">DEU::LO:25</LocationRef> </Allotment>
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 and Description |
---|
Allotment()
No arg constructor.
|
Modifier and Type | Method and Description |
---|---|
Set<AllotFreq> |
getAllotFreq()
Get the AllotFreq
|
D |
getDateResponseRequired()
Get the date by which the frequency assignment or Spectrum Supportability
Reply is required by the user in order to complete necessary advanced
operation coordination..
|
D |
getEffectiveDate()
Get the date by which the dataset is to be operational or effective..
|
Set<Emission> |
getEmission()
Get the Emission
|
D |
getExpirationDate()
Get the date at which the dataset will expire.
|
Set<Location> |
getLocation()
Get the LocationRef
|
Set<Serial> |
getLocationRef()
Deprecated.
SSRF references are managed automatically. Use
getLocation() instead. |
Set<POCInformation> |
getPOCInformation()
Get the POCInformation
|
Set<Project> |
getProject()
Get the Project
|
MEMO |
getRequirement()
Get any amplifying information on the requirement..
|
D |
getReviewDate()
Get the date by which the dataset is to be reviewed.
|
S100 |
getTitle()
Get an identifying name for this Allotment or Assignment..
|
TString |
getUsageType()
Get the type of assignment request or approved assignment/allotment.
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetAllotFreq()
Determine if the AllotFreq is configured.
|
boolean |
isSetDateResponseRequired()
Determine if the DateResponseRequired is configured.
|
boolean |
isSetEffectiveDate()
Determine if the EffectiveDate is configured.
|
boolean |
isSetEmission()
Determine if the Emission is configured.
|
boolean |
isSetExpirationDate()
Determine if the ExpirationDate is configured.
|
boolean |
isSetLocation()
Determine if the location field is configured.
|
boolean |
isSetLocationRef()
Determine if the LocationRef is configured.
|
boolean |
isSetPOCInformation()
Determine if the POCInformation is configured.
|
boolean |
isSetProject()
Determine if the Project is configured.
|
boolean |
isSetRequirement()
Determine if the Requirement is configured.
|
boolean |
isSetReviewDate()
Determine if the ReviewDate is configured.
|
boolean |
isSetTitle()
Determine if the Title is configured.
|
boolean |
isSetUsageType()
Determine if the UsageType is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this Allotment record after loading
from XML.
|
void |
prepare()
Update the SSRF data type references in this Allotment record.
|
void |
setDateResponseRequired(D value)
Set the date by which the frequency assignment or Spectrum Supportability
Reply is required by the user in order to complete necessary advanced
operation coordination..
|
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 |
setRequirement(MEMO value)
Set any amplifying information on the requirement..
|
void |
setReviewDate(D value)
Set the date by which the dataset is to be reviewed.
|
void |
setTitle(S100 value)
Set an identifying name for this Allotment or Assignment..
|
void |
setUsageType(TString value)
Set the type of assignment request or approved assignment/allotment.
|
String |
toString()
Get a string representation of this Allotment instance configuration.
|
void |
unsetAllotFreq()
Clear the AllotFreq field.
|
void |
unsetEmission()
Clear the Emission field.
|
void |
unsetLocationRef()
Clear the LocationRef field.
|
void |
unsetPOCInformation()
Clear the POCInformation field.
|
void |
unsetProject()
Clear the Project field.
|
Allotment |
withAllotFreq(AllotFreq... values)
Set the AllotFreq
|
Allotment |
withAllotFreq(Collection<AllotFreq> values)
Set the AllotFreq
|
Allotment |
withDateResponseRequired(Calendar value)
Set the date by which the frequency assignment or Spectrum Supportability
Reply is required by the user in order to complete necessary advanced
operation coordination.
|
Allotment |
withDateResponseRequired(Date value)
Set the date by which the frequency assignment or Spectrum Supportability
Reply is required by the user in order to complete necessary advanced
operation coordination.
|
Allotment |
withEffectiveDate(Calendar value)
Set the date by which the dataset is to be operational or effective.
|
Allotment |
withEffectiveDate(Date value)
Set the date by which the dataset is to be operational or effective.
|
Allotment |
withEmission(Collection<Emission> values)
Set the Emission
|
Allotment |
withEmission(Emission... values)
Set the Emission
|
Allotment |
withExpirationDate(Calendar value)
Set the date at which the dataset will expire.
|
Allotment |
withExpirationDate(Date value)
Set the date at which the dataset will expire.
|
Allotment |
withLocation(Collection<Location> values)
Set the LocationRef
|
Allotment |
withLocation(Location... values)
Set the LocationRef
|
Allotment |
withLocationRef(Collection<Serial> values)
Deprecated.
SSRF references are managed automatically. Use
withLocation(Location...) instead. |
Allotment |
withLocationRef(Serial... values)
Deprecated.
SSRF references are managed automatically. Use
withLocation(Location...) instead. |
Allotment |
withPOCInformation(Collection<POCInformation> values)
Set the POCInformation
|
Allotment |
withPOCInformation(POCInformation... values)
Set the POCInformation
|
Allotment |
withProject(Collection<Project> values)
Set the Project
|
Allotment |
withProject(Project... values)
Set the Project
|
Allotment |
withRequirement(String value)
Set any amplifying information on the requirement.
|
Allotment |
withReviewDate(Calendar value)
Set the date by which the dataset is to be reviewed.
|
Allotment |
withReviewDate(Date value)
Set the date by which the dataset is to be reviewed.
|
Allotment |
withTitle(String value)
Set an identifying name for this Allotment or Assignment.
|
Allotment |
withUsageType(ListCUT value)
Set the type of assignment request or approved assignment/allotment.
|
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
public Allotment()
public S100 getTitle()
S100
instancepublic void setTitle(S100 value)
value
- a S100
instancepublic boolean isSetTitle()
public TString getUsageType()
TString
data typepublic void setUsageType(TString value)
value
- the UsageType value in a TString
data typepublic boolean isSetUsageType()
If configured this method also inspects the TString
wrapped value.
public D getDateResponseRequired()
D
instancepublic void setDateResponseRequired(D value)
value
- a D
instancepublic boolean isSetDateResponseRequired()
public D getEffectiveDate()
D
instancepublic void setEffectiveDate(D value)
value
- a D
instancepublic boolean isSetEffectiveDate()
public D getExpirationDate()
D
instancepublic void setExpirationDate(D value)
value
- a D
instancepublic boolean isSetExpirationDate()
public D getReviewDate()
D
instancepublic void setReviewDate(D value)
value
- a D
instancepublic boolean isSetReviewDate()
public MEMO getRequirement()
MEMO
instancepublic void setRequirement(MEMO value)
value
- a MEMO
instancepublic boolean isSetRequirement()
public Set<Project> getProject()
Complex element Project provides the Project, OPLAN, COMPLAN or Exercise name, or any other project name associated to the dataset..
Project
instancepublic boolean isSetProject()
public void unsetProject()
public Set<POCInformation> getPOCInformation()
Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset..
POCInformation
instancepublic boolean isSetPOCInformation()
public void unsetPOCInformation()
@Deprecated public Set<Serial> getLocationRef()
getLocation()
instead.Complex element LocationRef references a Location dataset..
Serial
instancepublic boolean isSetLocationRef()
public void unsetLocationRef()
public Set<Emission> getEmission()
Complex element Emission defines the limits of the authorized bandwidth and power within the allotment..
Emission
instancepublic boolean isSetEmission()
public void unsetEmission()
public Set<AllotFreq> getAllotFreq()
Complex element AllotFreq defines a frequency or range of frequencies belonging to the Allotment..
AllotFreq
instancepublic boolean isSetAllotFreq()
public void unsetAllotFreq()
public Allotment withTitle(String value)
value
- An instances of type String
.public Allotment withUsageType(ListCUT value)
value
- An instances of type ListCUT
.public Allotment withDateResponseRequired(Calendar value)
value
- An instances of type Calendar
.public Allotment withDateResponseRequired(Date value)
value
- An instances of type Date
.public Allotment withEffectiveDate(Calendar value)
value
- An instances of type Calendar
.public Allotment withEffectiveDate(Date value)
value
- An instances of type Date
.public Allotment withExpirationDate(Calendar value)
value
- An instances of type Calendar
.public Allotment withExpirationDate(Date value)
value
- An instances of type Date
.public Allotment withReviewDate(Calendar value)
value
- An instances of type Calendar
.public Allotment withReviewDate(Date value)
value
- An instances of type Date
.public Allotment withRequirement(String value)
value
- An instances of type String
.public Allotment withProject(Project... values)
Complex element Project provides the Project, OPLAN, COMPLAN or Exercise name, or any other project name associated to the dataset.
values
- One or more instances of type Project...
.public Allotment withProject(Collection<Project> values)
Complex element Project provides the Project, OPLAN, COMPLAN or Exercise name, or any other project name associated to the dataset.
values
- A collection of Project
instancespublic Allotment withPOCInformation(POCInformation... values)
Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset.
values
- One or more instances of type POCInformation...
.public Allotment withPOCInformation(Collection<POCInformation> values)
Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset.
values
- A collection of POCInformation
instances@Deprecated public Allotment withLocationRef(Serial... values)
withLocation(Location...)
instead.Complex element LocationRef references a Location dataset.
values
- One or more instances of type LocationRef...
.@Deprecated public Allotment withLocationRef(Collection<Serial> values)
withLocation(Location...)
instead.Complex element LocationRef references a Location dataset.
values
- A collection of Serial
instancespublic Allotment withEmission(Emission... values)
Complex element Emission defines the limits of the authorized bandwidth and power within the allotment.
values
- One or more instances of type Emission...
.public Allotment withEmission(Collection<Emission> values)
Complex element Emission defines the limits of the authorized bandwidth and power within the allotment.
values
- A collection of Emission
instancespublic Allotment withAllotFreq(AllotFreq... values)
Complex element AllotFreq defines a frequency or range of frequencies belonging to the Allotment.
values
- One or more instances of type AllotFreq...
.public Allotment withAllotFreq(Collection<AllotFreq> values)
Complex element AllotFreq defines a frequency or range of frequencies belonging to the Allotment.
values
- A collection of AllotFreq
instancespublic String toString()
public boolean isSet()
Allotment
requires
cls
, Serial
, EntryDateTime
and AllotFreq
, EffectiveDate
.
Note that this method only checks for the presence of required information; this method does not validate the information format.
public Set<Location> getLocation()
Complex element LocationRef references a Location dataset..
Location
instancepublic boolean isSetLocation()
public Allotment withLocation(Location... values)
Complex element LocationRef references a Location dataset.
values
- An instances of type Location
.public Allotment withLocation(Collection<Location> values)
Complex element LocationRef references a Location dataset.
values
- An instances of type Location
.public void prepare()
This method builds the exported locationRef
field with values from
the transient location
field. This method should typically be
called after the Allotment is configured and (optionally) before exporting
an SSRF message.
public void postLoad(SSRF root)
This method builds the transient location
with values from the
imported locationRef
field. This method should typically be called
after the Allotment is imported from XML.
Copyright © 2016 OpenSSRF.org. All rights reserved.