public class ForceElement extends Common<ForceElement>
Sub-Elements are
Assets
, Nomenclature
, POCInformation
, StockNum
Example:
<ForceElement> <Serial cls="U">USA:NA:FE:123</Serial> <Type cls="U">PLatform</Type> <OwningCountry cls="U">USA</OwningCountry> <Identifier> <Level cls="U">Primary</Level> <Name cls="U">USS Nimitz</Name> </Identifier> <Assets_etc/> </ForceElement>
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 |
---|
ForceElement()
No arg constructor.
|
Modifier and Type | Method and Description |
---|---|
Set<Assets> |
getAssets()
Get the Assets
|
TString |
getCmdLevel()
Get the organisational level of the force element according to stratum,
echelon or point at which authority or control is maintained..
|
TString |
getMissionCode()
Get the mission code representing the primary mission of the Force Element
(e.g.,Training, Finance, etc)..
|
Set<Nomenclature> |
getNomenclature()
Get the Nomenclature
|
TString |
getOwningCountry()
Get the owning country or body of the ForceElement..
|
Organisation |
getOwningOrganisation()
Get .
|
Serial |
getOwningOrganisationRef()
Get a reference to the organisation that owns the ForceElement..
|
TString |
getPlatform()
Get the type of platform..
|
Set<POCInformation> |
getPOCInformation()
Get the POCInformation
|
D |
getReviewDate()
Get the date by which the dataset is to be reviewed.
|
TString |
getRole()
Get the code used to document the main role of the Force Element.
|
Set<StockNum> |
getStockNum()
Get the US:StockNum
|
TString |
getType()
Get if the Force Element is a Unit or a Platform..
|
S20 |
getUIC()
Get an organisational identifier that may be used to uniquely identify an
organisation in operational planning systems and other non-spectrum
information systems..
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetAssets()
Determine if the Assets is configured.
|
boolean |
isSetCmdLevel()
Determine if the CmdLevel is configured.
|
boolean |
isSetMissionCode()
Determine if the MissionCode is configured.
|
boolean |
isSetNomenclature()
Determine if the Nomenclature is configured.
|
boolean |
isSetOwningCountry()
Determine if the OwningCountry is configured.
|
boolean |
isSetOwningOrganisation()
Determine if the owningOrganisation field is configured.
|
boolean |
isSetOwningOrganisationRef()
Determine if the OwningOrganisation is configured.
|
boolean |
isSetPlatform()
Determine if the Platform is configured.
|
boolean |
isSetPOCInformation()
Determine if the POCInformation is configured.
|
boolean |
isSetReviewDate()
Determine if the ReviewDate is configured.
|
boolean |
isSetRole()
Determine if the Role is configured.
|
boolean |
isSetStockNum()
Determine if the StockNum is configured.
|
boolean |
isSetType()
Determine if the Type is configured.
|
boolean |
isSetUIC()
Determine if the UIC is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this ForceElement record after
loading from XML.
|
void |
prepare()
Update the SSRF data type references in this ForceElement record.
|
void |
setCmdLevel(TString value)
Set the organisational level of the force element according to stratum,
echelon or point at which authority or control is maintained..
|
void |
setMissionCode(TString value)
Set the mission code representing the primary mission of the Force Element
(e.g.,Training, Finance, etc)..
|
void |
setOwningCountry(TString value)
Set the owning country or body of the ForceElement..
|
void |
setOwningOrganisationRef(Serial value)
Set a reference to the organisation that owns the ForceElement..
|
void |
setPlatform(TString value)
Set the type of platform..
|
void |
setReviewDate(D value)
Set the date by which the dataset is to be reviewed.
|
void |
setRole(TString value)
Set the code used to document the main role of the Force Element.
|
void |
setType(TString value)
Set if the Force Element is a Unit or a Platform..
|
void |
setUIC(S20 value)
Set an organisational identifier that may be used to uniquely identify an
organisation in operational planning systems and other non-spectrum
information systems..
|
String |
toString()
Get a string representation of this ForceElement instance configuration.
|
void |
unsetAssets()
Clear the Assets field.
|
void |
unsetNomenclature()
Clear the Nomenclature field.
|
void |
unsetPOCInformation()
Clear the POCInformation field.
|
void |
unsetStockNum()
Clear the StockNum field.
|
ForceElement |
withAssets(Assets... values)
Set the Assets
|
ForceElement |
withAssets(Collection<Assets> values)
Set the Assets
|
ForceElement |
withCmdLevel(ListCLC value)
Set the organisational level of the force element according to stratum,
echelon or point at which authority or control is maintained.
|
ForceElement |
withMissionCode(ListCMC value)
Set the mission code representing the primary mission of the Force Element
(e.g.,Training, Finance, etc).
|
ForceElement |
withNomenclature(Collection<Nomenclature> values)
Set the Nomenclature
|
ForceElement |
withNomenclature(Nomenclature... values)
Set the Nomenclature
|
ForceElement |
withOwningCountry(ListCAO value)
Set the owning country or body of the ForceElement.
|
ForceElement |
withOwningOrganisation(Organisation value)
Set
|
ForceElement |
withOwningOrganisationRef(Serial value)
Set a reference to the organisation that owns the ForceElement.
|
ForceElement |
withPlatform(ListCET value)
Set the type of platform.
|
ForceElement |
withPOCInformation(Collection<POCInformation> values)
Set the POCInformation
|
ForceElement |
withPOCInformation(POCInformation... values)
Set the POCInformation
|
ForceElement |
withReviewDate(Calendar value)
Set the date by which the dataset is to be reviewed.
|
ForceElement |
withReviewDate(Date value)
Set the date by which the dataset is to be reviewed.
|
ForceElement |
withRole(ListCSR value)
Set the code used to document the main role of the Force Element.
|
ForceElement |
withStockNum(Collection<StockNum> values)
Set the US:StockNum
|
ForceElement |
withStockNum(StockNum... values)
Set the US:StockNum
|
ForceElement |
withType(ListCFE value)
Set if the Force Element is a Unit or a Platform.
|
ForceElement |
withUIC(String value)
Set an organisational identifier that may be used to uniquely identify an
organisation in operational planning systems and other non-spectrum
information systems.
|
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 ForceElement()
public D getReviewDate()
D
instancepublic void setReviewDate(D value)
value
- a D
instancepublic boolean isSetReviewDate()
public TString getType()
TString
data typepublic void setType(TString value)
value
- the Type value in a TString
data typepublic boolean isSetType()
If configured this method also inspects the TString
wrapped value.
public S20 getUIC()
S20
instancepublic void setUIC(S20 value)
value
- a S20
instancepublic boolean isSetUIC()
public TString getOwningCountry()
TString
data typepublic void setOwningCountry(TString value)
value
- the OwningCountry value in a TString
data typepublic boolean isSetOwningCountry()
If configured this method also inspects the TString
wrapped value.
public Serial getOwningOrganisationRef()
Serial
instancepublic void setOwningOrganisationRef(Serial value)
value
- a Serial
instancepublic boolean isSetOwningOrganisationRef()
public TString getRole()
TString
data typepublic void setRole(TString value)
value
- the Role value in a TString
data typepublic boolean isSetRole()
If configured this method also inspects the TString
wrapped value.
public TString getPlatform()
TString
data typepublic void setPlatform(TString value)
value
- the Platform value in a TString
data typepublic boolean isSetPlatform()
If configured this method also inspects the TString
wrapped value.
public TString getMissionCode()
TString
data typepublic void setMissionCode(TString value)
value
- the MissionCode value in a TString
data typepublic boolean isSetMissionCode()
If configured this method also inspects the TString
wrapped value.
public TString getCmdLevel()
TString
data typepublic void setCmdLevel(TString value)
value
- the CmdLevel value in a TString
data typepublic boolean isSetCmdLevel()
If configured this method also inspects the TString
wrapped value.
public Set<POCInformation> getPOCInformation()
Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset..
POCInformation
instancepublic boolean isSetPOCInformation()
public void unsetPOCInformation()
public Set<Assets> getAssets()
Complex element Assets indicates the authorised and available quantity of the equipment, RF systems, or other Force Elements used or owned by the Force Element..
Assets
instancepublic boolean isSetAssets()
public void unsetAssets()
public Set<Nomenclature> getNomenclature()
Complex element Nomenclature identifies either the standard military, government, nomenclature or the commercial model number of an equipment. Each device or group of devices may have several types of nomenclatures, e.g. both a military nomenclature and a commercial model number..
Nomenclature
instancepublic boolean isSetNomenclature()
public void unsetNomenclature()
public Set<StockNum> getStockNum()
Complex element StockNum (US) provides the equipment stock number and indicates the type of stock number..
StockNum
instancepublic boolean isSetStockNum()
public void unsetStockNum()
public ForceElement withReviewDate(Calendar value)
value
- An instances of type Calendar
.public ForceElement withReviewDate(Date value)
value
- An instances of type Date
.public ForceElement withType(ListCFE value)
value
- An instances of type ListCFE
.public ForceElement withUIC(String value)
value
- An instances of type String
.public ForceElement withOwningCountry(ListCAO value)
value
- An instances of type ListCAO
.public ForceElement withOwningOrganisationRef(Serial value)
value
- An instances of type Serial
.public ForceElement withRole(ListCSR value)
value
- An instances of type ListCSR
.public ForceElement withPlatform(ListCET value)
value
- An instances of type ListCET
.public ForceElement withMissionCode(ListCMC value)
value
- An instances of type ListCMC
.public ForceElement withCmdLevel(ListCLC value)
value
- An instances of type ListCLC
.public ForceElement 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 ForceElement withPOCInformation(Collection<POCInformation> values)
Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset.
values
- A collection of POCInformation
instancespublic ForceElement withAssets(Assets... values)
Complex element Assets indicates the authorised and available quantity of the equipment, RF systems, or other Force Elements used or owned by the Force Element.
values
- One or more instances of type Assets...
.public ForceElement withAssets(Collection<Assets> values)
Complex element Assets indicates the authorised and available quantity of the equipment, RF systems, or other Force Elements used or owned by the Force Element.
values
- A collection of Assets
instancespublic ForceElement withNomenclature(Nomenclature... values)
Complex element Nomenclature identifies either the standard military, government, nomenclature or the commercial model number of an equipment. Each device or group of devices may have several types of nomenclatures, e.g. both a military nomenclature and a commercial model number.
values
- One or more instances of type Nomenclature...
.public ForceElement withNomenclature(Collection<Nomenclature> values)
Complex element Nomenclature identifies either the standard military, government, nomenclature or the commercial model number of an equipment. Each device or group of devices may have several types of nomenclatures, e.g. both a military nomenclature and a commercial model number.
values
- A collection of Nomenclature
instancespublic ForceElement withStockNum(StockNum... values)
Complex element StockNum (US) provides the equipment stock number and indicates the type of stock number.
values
- One or more instances of type StockNum...
.public ForceElement withStockNum(Collection<StockNum> values)
Complex element StockNum (US) provides the equipment stock number and indicates the type of stock number.
values
- A collection of StockNum
instancespublic String toString()
toString
in class Common<ForceElement>
public boolean isSet()
ForceElement
requires
cls
, Serial
, EntryDateTime
and Nomenclature
, Type
.
Note that this method only checks for the presence of required information; this method does not validate the information format.
isSet
in class Common<ForceElement>
public Organisation getOwningOrganisation()
Organisation
instancepublic boolean isSetOwningOrganisation()
public ForceElement withOwningOrganisation(Organisation value)
value
- An instances of type Organisation
.public void prepare()
This method builds the exported owningOrganisationRef
field with
values from the transient owningOrganisation
field. This method
should typically be called after the ForceElement is configured and
(optionally) before exporting an SSRF message.
prepare
in class Common<ForceElement>
public void postLoad(SSRF root)
This method builds the transient owningOrganisation
with values
from the imported owningOrganisationRef
field. This method should
typically be called after the ForceElement is imported from XML. * @param
root the SSRF root instance.
postLoad
in class Common<ForceElement>
root
- the SSRF root instanceCopyright © 2016 OpenSSRF.org. All rights reserved.