public class FEDeployment extends Common<FEDeployment>
Sub-Elements are AtWayPoint
, Project
Example:
<FEDeployment cls="U"> <Serial cls="U">NLD::FD:123</Serial> <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime> <FERef cls="U">NLD::FE:222</FERef> <Type cls="U">Location-Current</Type> <Months cls="U">1-2</Months> <Years cls="U">2012</Years> <LocationRef cls="U">NLD::LO:333</LocationRef> </FEDeployment>
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 |
---|
FEDeployment()
No arg constructor.
|
Modifier and Type | Method and Description |
---|---|
Set<AtWaypoint> |
getAtWaypoint()
Get the AtWayPoint
|
DaysOfMonth |
getDaysOfMonth()
Get the day of month [1-31] that the Force element is planned for
deployment..
|
DaysOfWeek |
getDaysOfWeek()
Get the weekday [0-7 where 0 and 7 are for Sunday, 1 for Monday, etc] that
the Force element is planned for deployment..
|
Duration_UN4 |
getDuration()
Get the number of minutes for which an event will live.
|
Serial |
getFERef()
Get the dataset identifier of the ForceElement being deployed..
|
ForceElement |
getForceElement()
Get the dataset identifier of the ForceElement being deployed..
|
Hours |
getHours()
Get the hours of a day [0-23] (UTC time) that the Force element is planned
for deployment..
|
Location |
getLocation()
Get the unique reference serial of an existing Location dataset..
|
Serial |
getLocationRef()
Get the serial of the referenced Location..
|
MinSec |
getMinutes()
Get the minutes of an hour [0-59] that the Force element is planned for
deployment..
|
Months |
getMonths()
Get the month of year [1-12] that the Force element is planned for
deployment..
|
UN6 |
getNum()
Get the quantity of Force Element referenced in FERef..
|
Set<Project> |
getProject()
Get the Project
|
MinSec |
getSeconds()
Get the seconds of hour [0-59] that the Force element is planned for
deployment..
|
TString |
getType()
Get the type of deployment..
|
Years |
getYears()
Get the 4-digit year [1900..2100] that the Force element is planned for
deployment..
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetAtWaypoint()
Determine if the AtWaypoint is configured.
|
boolean |
isSetDaysOfMonth()
Determine if the DaysOfMonth is configured.
|
boolean |
isSetDaysOfWeek()
Determine if the DaysOfWeek is configured.
|
boolean |
isSetDuration()
Determine if the Duration is configured.
|
boolean |
isSetFERef()
Determine if the FERef is configured.
|
boolean |
isSetForceElement()
Determine if the forceElement field is configured.
|
boolean |
isSetHours()
Determine if the Hours is configured.
|
boolean |
isSetLocation()
Determine if the location field is configured.
|
boolean |
isSetLocationRef()
Determine if the LocationRef is configured.
|
boolean |
isSetMinutes()
Determine if the Minutes is configured.
|
boolean |
isSetMonths()
Determine if the Months is configured.
|
boolean |
isSetNum()
Determine if the Num is configured.
|
boolean |
isSetProject()
Determine if the Project is configured.
|
boolean |
isSetSeconds()
Determine if the Seconds is configured.
|
boolean |
isSetType()
Determine if the Type is configured.
|
boolean |
isSetYears()
Determine if the Years is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this FEDeployment record after
loading from XML.
|
void |
prepare()
Update the SSRF data type references in this FEDeployment record.
|
void |
setDaysOfMonth(DaysOfMonth value)
Set the day of month [1-31] that the Force element is planned for
deployment..
|
void |
setDaysOfWeek(DaysOfWeek value)
Set the weekday [0-7 where 0 and 7 are for Sunday, 1 for Monday, etc] that
the Force element is planned for deployment..
|
void |
setDuration(Duration_UN4 value)
Set the number of minutes for which an event will live.
|
void |
setFERef(Serial value)
Set the dataset identifier of the ForceElement being deployed..
|
void |
setHours(Hours value)
Set the hours of a day [0-23] (UTC time) that the Force element is planned
for deployment..
|
void |
setLocationRef(Serial value)
Set the serial of the referenced Location..
|
void |
setMinutes(MinSec value)
Set the minutes of an hour [0-59] that the Force element is planned for
deployment..
|
void |
setMonths(Months value)
Set the month of year [1-12] that the Force element is planned for
deployment..
|
void |
setNum(UN6 value)
Set the quantity of Force Element referenced in FERef..
|
void |
setSeconds(MinSec value)
Set the seconds of hour [0-59] that the Force element is planned for
deployment..
|
void |
setType(TString value)
Set the type of deployment..
|
void |
setYears(Years value)
Set the 4-digit year [1900..2100] that the Force element is planned for
deployment..
|
String |
toString()
Get a string representation of this FEDeployment instance configuration.
|
void |
unsetAtWaypoint()
Clear the AtWaypoint field.
|
void |
unsetProject()
Clear the Project field.
|
FEDeployment |
withAtWaypoint(AtWaypoint... values)
Set the AtWayPoint
|
FEDeployment |
withAtWaypoint(Collection<AtWaypoint> values)
Set the AtWayPoint
|
FEDeployment |
withDaysOfMonth(String value)
Set the day of month [1-31] that the Force element is planned for
deployment.
|
FEDeployment |
withDaysOfWeek(String value)
Set the weekday [0-7 where 0 and 7 are for Sunday, 1 for Monday, etc] that
the Force element is planned for deployment.
|
FEDeployment |
withDuration(Integer value)
Set the number of minutes for which an event will live.
|
FEDeployment |
withFERef(Serial value)
Set the dataset identifier of the ForceElement being deployed.
|
FEDeployment |
withForceElement(ForceElement value)
Set the dataset identifier of the ForceElement being deployed.
|
FEDeployment |
withHours(String value)
Set the hours of a day [0-23] (UTC time) that the Force element is planned
for deployment.
|
FEDeployment |
withLocation(Location value)
Set the unique reference serial of an existing Location dataset.
|
FEDeployment |
withLocationRef(Serial value)
Set the serial of the referenced Location.
|
FEDeployment |
withMinutes(String value)
Set the minutes of an hour [0-59] that the Force element is planned for
deployment.
|
FEDeployment |
withMonths(String value)
Set the month of year [1-12] that the Force element is planned for
deployment.
|
FEDeployment |
withNum(Integer value)
Set the quantity of Force Element referenced in FERef.
|
FEDeployment |
withProject(Collection<Project> values)
Set the Project
|
FEDeployment |
withProject(Project... values)
Set the Project
|
FEDeployment |
withSeconds(String value)
Set the seconds of hour [0-59] that the Force element is planned for
deployment.
|
FEDeployment |
withType(ListCFD value)
Set the type of deployment.
|
FEDeployment |
withYears(String value)
Set the 4-digit year [1900..2100] that the Force element is planned for
deployment.
|
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 FEDeployment()
public Serial getFERef()
Serial
instancepublic void setFERef(Serial value)
value
- a Serial
instancepublic boolean isSetFERef()
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 UN6 getNum()
UN6
instancepublic void setNum(UN6 value)
value
- a UN6
instancepublic boolean isSetNum()
public MinSec getSeconds()
MinSec
instancepublic void setSeconds(MinSec value)
value
- a MinSec
instancepublic boolean isSetSeconds()
public MinSec getMinutes()
MinSec
instancepublic void setMinutes(MinSec value)
value
- a MinSec
instancepublic boolean isSetMinutes()
public Hours getHours()
Hours
instancepublic void setHours(Hours value)
value
- a Hours
instancepublic boolean isSetHours()
public DaysOfMonth getDaysOfMonth()
DaysOfMonth
instancepublic void setDaysOfMonth(DaysOfMonth value)
value
- a DaysOfMonth
instancepublic boolean isSetDaysOfMonth()
public Months getMonths()
Months
instancepublic void setMonths(Months value)
value
- a Months
instancepublic boolean isSetMonths()
public DaysOfWeek getDaysOfWeek()
DaysOfWeek
instancepublic void setDaysOfWeek(DaysOfWeek value)
value
- a DaysOfWeek
instancepublic boolean isSetDaysOfWeek()
public Years getYears()
Years
instancepublic void setYears(Years value)
value
- a Years
instancepublic boolean isSetYears()
public Duration_UN4 getDuration()
Transmission for 2 minutes every 10 minutes from 0900 to 1700 every weekday
for the year 2007:
On the 5-minute mark, every 3rd hour, Monday-Friday
On the 20 and 50-minute marks, every hour, every month except June,
Monday-Friday
Duration_UN4
instancepublic void setDuration(Duration_UN4 value)
Transmission for 2 minutes every 10 minutes from 0900 to 1700 every weekday
for the year 2007:
On the 5-minute mark, every 3rd hour, Monday-Friday
On the 20 and 50-minute marks, every hour, every month except June,
Monday-Friday
value
- a Duration_UN4
instancepublic boolean isSetDuration()
public Serial getLocationRef()
Serial
instancepublic void setLocationRef(Serial value)
value
- a Serial
instancepublic boolean isSetLocationRef()
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<AtWaypoint> getAtWaypoint()
Complex element AtWayPoint defines a point in time at which a Force Element is at a given waypoint along a route..
AtWaypoint
instancepublic boolean isSetAtWaypoint()
public void unsetAtWaypoint()
public FEDeployment withFERef(Serial value)
value
- An instances of type Serial
.public FEDeployment withType(ListCFD value)
value
- An instances of type ListCFD
.public FEDeployment withNum(Integer value)
value
- An instances of type Integer
.public FEDeployment withSeconds(String value)
value
- An instances of type String
.public FEDeployment withMinutes(String value)
value
- An instances of type String
.public FEDeployment withHours(String value)
value
- An instances of type String
.public FEDeployment withDaysOfMonth(String value)
value
- An instances of type String
.public FEDeployment withMonths(String value)
value
- An instances of type String
.public FEDeployment withDaysOfWeek(String value)
value
- An instances of type String
.public FEDeployment withYears(String value)
value
- An instances of type String
.public FEDeployment withDuration(Integer value)
Transmission for 2 minutes every 10 minutes from 0900 to 1700 every weekday
for the year 2007:
On the 5-minute mark, every 3rd hour, Monday-Friday
On the 20 and 50-minute marks, every hour, every month except June,
Monday-Friday
value
- An instances of type Integer
.public FEDeployment withLocationRef(Serial value)
value
- An instances of type Serial
.public FEDeployment 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 FEDeployment 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 FEDeployment withAtWaypoint(AtWaypoint... values)
Complex element AtWayPoint defines a point in time at which a Force Element is at a given waypoint along a route.
values
- One or more instances of type AtWaypoint...
.public FEDeployment withAtWaypoint(Collection<AtWaypoint> values)
Complex element AtWayPoint defines a point in time at which a Force Element is at a given waypoint along a route.
values
- A collection of AtWaypoint
instancespublic String toString()
toString
in class Common<FEDeployment>
public boolean isSet()
FEDeployment
requires
cls
, Serial
, EntryDateTime
and FERef
, 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<FEDeployment>
public ForceElement getForceElement()
ForceElement
instancepublic boolean isSetForceElement()
public FEDeployment withForceElement(ForceElement value)
value
- An instances of type ForceElement
.public Location getLocation()
Location
instancepublic boolean isSetLocation()
public FEDeployment withLocation(Location value)
value
- An instances of type Location
.public void prepare()
This method builds the exported feRef
field with values from the
transient forceElement
field. This method should typically be
called after the FEDeployment is configured and (optionally) before
exporting an SSRF message.
prepare
in class Common<FEDeployment>
public void postLoad(SSRF root)
This method builds the transient forceElement
with values from the
imported feRef
field. This method should typically be called after
the FEDeployment is imported from XML. * @param root the SSRF root
instance.
postLoad
in class Common<FEDeployment>
root
- the SSRF root instanceCopyright © 2016 OpenSSRF.org. All rights reserved.