FEDeployment (lib-openssrf-3.1.0 1.0.0 API)

java.lang.Object
- us.gov.dod.standard.ssrf._3_1.Common<FEDeployment>
- - us.gov.dod.standard.ssrf._3_1.FEDeployment

All Implemented Interfaces:: Comparable<FEDeployment>

public class FEDeployment
extends Common<FEDeployment>

FEDeployment describes the deployment of a force element to a location. Each deployment has a period of time for which the deployment is valid described by the start and end date/time.

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>

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

FEDeployment()
No arg constructor.

Constructors
Constructor and Description
`FEDeployment()` No arg constructor.

Method Summary

All Methods Instance Methods Concrete Methods
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.

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
  - FEDeployment
```
public FEDeployment()
```
    No arg constructor. Initializes the Common required fields.
- Method Detail
  - getFERef
```
public Serial getFERef()
```
    Get the dataset identifier of the ForceElement being deployed..
    
    Returns:
    
    a Serial instance
    
    Since:
    
    3.1.0
  - setFERef
```
public void setFERef(Serial value)
```
    Set the dataset identifier of the ForceElement being deployed..
    
    Parameters:
    
    value - a Serial instance
    
    Since:
    
    3.1.0
  - isSetFERef
```
public boolean isSetFERef()
```
    Determine if the FERef is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getType
```
public TString getType()
```
    Get the type of deployment..
    
    Returns:
    
    the Type value in a TString data type
    
    Since:
    
    3.1.0
  - setType
```
public void setType(TString value)
```
    Set the type of deployment..
    
    Parameters:
    
    value - the Type value in a TString data type
    
    Since:
    
    3.1.0
  - isSetType
```
public boolean isSetType()
```
    Determine if the Type 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
  - getNum
```
public UN6 getNum()
```
    Get the quantity of Force Element referenced in FERef..
    
    Returns:
    
    a UN6 instance
    
    Since:
    
    3.1.0
  - setNum
```
public void setNum(UN6 value)
```
    Set the quantity of Force Element referenced in FERef..
    
    Parameters:
    
    value - a UN6 instance
    
    Since:
    
    3.1.0
  - isSetNum
```
public boolean isSetNum()
```
    Determine if the Num is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getSeconds
```
public MinSec getSeconds()
```
    Get the seconds of hour [0-59] that the Force element is planned for deployment..
    
    Returns:
    
    a MinSec instance
    
    Since:
    
    3.1.0
  - setSeconds
```
public void setSeconds(MinSec value)
```
    Set the seconds of hour [0-59] that the Force element is planned for deployment..
    
    Parameters:
    
    value - a MinSec instance
    
    Since:
    
    3.1.0
  - isSetSeconds
```
public boolean isSetSeconds()
```
    Determine if the Seconds is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getMinutes
```
public MinSec getMinutes()
```
    Get the minutes of an hour [0-59] that the Force element is planned for deployment..
    
    Returns:
    
    a MinSec instance
    
    Since:
    
    3.1.0
  - setMinutes
```
public void setMinutes(MinSec value)
```
    Set the minutes of an hour [0-59] that the Force element is planned for deployment..
    
    Parameters:
    
    value - a MinSec instance
    
    Since:
    
    3.1.0
  - isSetMinutes
```
public boolean isSetMinutes()
```
    Determine if the Minutes is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getHours
```
public Hours getHours()
```
    Get the hours of a day [0-23] (UTC time) that the Force element is planned for deployment..
    
    Returns:
    
    a Hours instance
    
    Since:
    
    3.1.0
  - setHours
```
public void setHours(Hours value)
```
    Set the hours of a day [0-23] (UTC time) that the Force element is planned for deployment..
    
    Parameters:
    
    value - a Hours instance
    
    Since:
    
    3.1.0
  - isSetHours
```
public boolean isSetHours()
```
    Determine if the Hours is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getDaysOfMonth
```
public DaysOfMonth getDaysOfMonth()
```
    Get the day of month [1-31] that the Force element is planned for deployment..
    
    Returns:
    
    a DaysOfMonth instance
    
    Since:
    
    3.1.0
  - setDaysOfMonth
```
public void setDaysOfMonth(DaysOfMonth value)
```
    Set the day of month [1-31] that the Force element is planned for deployment..
    
    Parameters:
    
    value - a DaysOfMonth instance
    
    Since:
    
    3.1.0
  - isSetDaysOfMonth
```
public boolean isSetDaysOfMonth()
```
    Determine if the DaysOfMonth is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getMonths
```
public Months getMonths()
```
    Get the month of year [1-12] that the Force element is planned for deployment..
    
    Returns:
    
    a Months instance
    
    Since:
    
    3.1.0
  - setMonths
```
public void setMonths(Months value)
```
    Set the month of year [1-12] that the Force element is planned for deployment..
    
    Parameters:
    
    value - a Months instance
    
    Since:
    
    3.1.0
  - isSetMonths
```
public boolean isSetMonths()
```
    Determine if the Months is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getDaysOfWeek
```
public 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..
    
    Returns:
    
    a DaysOfWeek instance
    
    Since:
    
    3.1.0
  - setDaysOfWeek
```
public 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..
    
    Parameters:
    
    value - a DaysOfWeek instance
    
    Since:
    
    3.1.0
  - isSetDaysOfWeek
```
public boolean isSetDaysOfWeek()
```
    Determine if the DaysOfWeek is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getYears
```
public Years getYears()
```
    Get the 4-digit year [1900..2100] that the Force element is planned for deployment..
    
    Returns:
    
    a Years instance
    
    Since:
    
    3.1.0
  - setYears
```
public void setYears(Years value)
```
    Set the 4-digit year [1900..2100] that the Force element is planned for deployment..
    
    Parameters:
    
    value - a Years instance
    
    Since:
    
    3.1.0
  - isSetYears
```
public boolean isSetYears()
```
    Determine if the Years is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getDuration
```
public Duration_UN4 getDuration()
```
    Get the number of minutes for which an event will live. Examples: Hours data item: 8 = one value: 08h00Z 5,6,9 = multiple values: 05h00Z, 06h00Z, 09h00Z 5-8 = range between 05h00Z and 08h00Z, inclusive star/2 = every 2nd hour, starting at midnight: 00h00Z, 02h00Z, 04h00Z, etc. 3-12/3 = every 3rd hour between 0300 and 1200, inclusive: 03h00Z, 06h00Z, 09h00Z, and 12h00Z
    Transmission for 2 minutes every 10 minutes from 0900 to 1700 every weekday for the year 2007: star/10 9-17 0-4 2007 2
    On the 5-minute mark, every 3rd hour, Monday-Friday 5 star/3 1-5
    On the 20 and 50-minute marks, every hour, every month except June, Monday-Friday 20,50 1-5,7-12 1-5.
    
    Returns:
    
    a Duration_UN4 instance
    
    Since:
    
    3.1.0
  - setDuration
```
public void setDuration(Duration_UN4 value)
```
    Set the number of minutes for which an event will live. Examples: Hours data item: 8 = one value: 08h00Z 5,6,9 = multiple values: 05h00Z, 06h00Z, 09h00Z 5-8 = range between 05h00Z and 08h00Z, inclusive star/2 = every 2nd hour, starting at midnight: 00h00Z, 02h00Z, 04h00Z, etc. 3-12/3 = every 3rd hour between 0300 and 1200, inclusive: 03h00Z, 06h00Z, 09h00Z, and 12h00Z
    Transmission for 2 minutes every 10 minutes from 0900 to 1700 every weekday for the year 2007: star/10 9-17 0-4 2007 2
    On the 5-minute mark, every 3rd hour, Monday-Friday 5 star/3 1-5
    On the 20 and 50-minute marks, every hour, every month except June, Monday-Friday 20,50 1-5,7-12 1-5.
    
    Parameters:
    
    value - a Duration_UN4 instance
    
    Since:
    
    3.1.0
  - isSetDuration
```
public boolean isSetDuration()
```
    Determine if the Duration is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getLocationRef
```
public Serial getLocationRef()
```
    Get the serial of the referenced Location..
    
    Returns:
    
    a Serial instance
    
    Since:
    
    3.1.0
  - setLocationRef
```
public void setLocationRef(Serial value)
```
    Set the serial of the referenced Location..
    
    Parameters:
    
    value - a Serial instance
    
    Since:
    
    3.1.0
  - isSetLocationRef
```
public boolean isSetLocationRef()
```
    Determine if the LocationRef is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getProject
```
public Set<Project> getProject()
```
    Get the Project
    Complex element Project provides the Project, OPLAN, COMPLAN or Exercise name, or any other project name associated to the dataset..
    
    Returns:
    
    a Project instance
    
    Since:
    
    3.1.0
  - isSetProject
```
public boolean isSetProject()
```
    Determine if the Project is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetProject
```
public void unsetProject()
```
    Clear the Project field. This sets the field to null.
  - getAtWaypoint
```
public Set<AtWaypoint> getAtWaypoint()
```
    Get the AtWayPoint
    Complex element AtWayPoint defines a point in time at which a Force Element is at a given waypoint along a route..
    
    Returns:
    
    a AtWaypoint instance
    
    Since:
    
    3.1.0
  - isSetAtWaypoint
```
public boolean isSetAtWaypoint()
```
    Determine if the AtWaypoint is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetAtWaypoint
```
public void unsetAtWaypoint()
```
    Clear the AtWaypoint field. This sets the field to null.
  - withFERef
```
public FEDeployment withFERef(Serial value)
```
    Set the dataset identifier of the ForceElement being deployed.
    
    Parameters:
    
    value - An instances of type Serial.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withType
```
public FEDeployment withType(ListCFD value)
```
    Set the type of deployment.
    
    Parameters:
    
    value - An instances of type ListCFD.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withNum
```
public FEDeployment withNum(Integer value)
```
    Set the quantity of Force Element referenced in FERef.
    
    Parameters:
    
    value - An instances of type Integer.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withSeconds
```
public FEDeployment withSeconds(String value)
```
    Set the seconds of hour [0-59] that the Force element is planned for deployment.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withMinutes
```
public FEDeployment withMinutes(String value)
```
    Set the minutes of an hour [0-59] that the Force element is planned for deployment.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withHours
```
public FEDeployment withHours(String value)
```
    Set the hours of a day [0-23] (UTC time) that the Force element is planned for deployment.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withDaysOfMonth
```
public FEDeployment withDaysOfMonth(String value)
```
    Set the day of month [1-31] that the Force element is planned for deployment.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withMonths
```
public FEDeployment withMonths(String value)
```
    Set the month of year [1-12] that the Force element is planned for deployment.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withDaysOfWeek
```
public 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.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withYears
```
public FEDeployment withYears(String value)
```
    Set the 4-digit year [1900..2100] that the Force element is planned for deployment.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withDuration
```
public FEDeployment withDuration(Integer value)
```
    Set the number of minutes for which an event will live. Examples: Hours data item: 8 = one value: 08h00Z 5,6,9 = multiple values: 05h00Z, 06h00Z, 09h00Z 5-8 = range between 05h00Z and 08h00Z, inclusive star/2 = every 2nd hour, starting at midnight: 00h00Z, 02h00Z, 04h00Z, etc. 3-12/3 = every 3rd hour between 0300 and 1200, inclusive: 03h00Z, 06h00Z, 09h00Z, and 12h00Z
    Transmission for 2 minutes every 10 minutes from 0900 to 1700 every weekday for the year 2007: star/10 9-17 0-4 2007 2
    On the 5-minute mark, every 3rd hour, Monday-Friday 5 star/3 1-5
    On the 20 and 50-minute marks, every hour, every month except June, Monday-Friday 20,50 1-5,7-12 1-5
    
    Parameters:
    
    value - An instances of type Integer.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withLocationRef
```
public FEDeployment withLocationRef(Serial value)
```
    Set the serial of the referenced Location.
    
    Parameters:
    
    value - An instances of type Serial.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withProject
```
public FEDeployment withProject(Project... values)
```
    Set the Project
    Complex element Project provides the Project, OPLAN, COMPLAN or Exercise name, or any other project name associated to the dataset.
    
    Parameters:
    
    values - One or more instances of type Project....
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withProject
```
public FEDeployment withProject(Collection<Project> values)
```
    Set the Project
    Complex element Project provides the Project, OPLAN, COMPLAN or Exercise name, or any other project name associated to the dataset.
    
    Parameters:
    
    values - A collection of Project instances
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withAtWaypoint
```
public FEDeployment withAtWaypoint(AtWaypoint... values)
```
    Set the AtWayPoint
    Complex element AtWayPoint defines a point in time at which a Force Element is at a given waypoint along a route.
    
    Parameters:
    
    values - One or more instances of type AtWaypoint....
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - withAtWaypoint
```
public FEDeployment withAtWaypoint(Collection<AtWaypoint> values)
```
    Set the AtWayPoint
    Complex element AtWayPoint defines a point in time at which a Force Element is at a given waypoint along a route.
    
    Parameters:
    
    values - A collection of AtWaypoint instances
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this FEDeployment instance configuration.
    
    Overrides:
    
    toString in class Common<FEDeployment>
    
    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.
    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.
    
    Overrides:
    
    isSet in class Common<FEDeployment>
    
    Returns:
    
    TRUE if required fields are set, otherwise FALSE
  - getForceElement
```
public ForceElement getForceElement()
```
    Get the dataset identifier of the ForceElement being deployed..
    
    Returns:
    
    a ForceElement instance
    
    Since:
    
    3.1.0
  - isSetForceElement
```
public boolean isSetForceElement()
```
    Determine if the forceElement field is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - withForceElement
```
public FEDeployment withForceElement(ForceElement value)
```
    Set the dataset identifier of the ForceElement being deployed.
    
    Parameters:
    
    value - An instances of type ForceElement.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - getLocation
```
public Location getLocation()
```
    Get the unique reference serial of an existing Location dataset..
    
    Returns:
    
    a Location instance
    
    Since:
    
    3.1.0
  - isSetLocation
```
public boolean isSetLocation()
```
    Determine if the location field is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - withLocation
```
public FEDeployment withLocation(Location value)
```
    Set the unique reference serial of an existing Location dataset.
    
    Parameters:
    
    value - An instances of type Location.
    
    Returns:
    
    The current FEDeployment object instance.
    
    Since:
    
    3.1.0
  - prepare
```
public void prepare()
```
    Update the SSRF data type references in this FEDeployment record.
    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.
    
    Overrides:
    
    prepare in class Common<FEDeployment>
    
    Since:
    
    3.1.0
  - postLoad
```
public void postLoad(SSRF root)
```
    Update the SSRF data type references in this FEDeployment record after loading from XML.
    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.
    
    Overrides:
    
    postLoad in class Common<FEDeployment>
    
    Parameters:
    
    root - the SSRF root instance
    
    Since:
    
    3.1.0

Class FEDeployment

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

FEDeployment

Method Detail

getFERef

setFERef

isSetFERef

getType

setType

isSetType

getNum

setNum

isSetNum

getSeconds

setSeconds

isSetSeconds

getMinutes

setMinutes

isSetMinutes

getHours

setHours

isSetHours

getDaysOfMonth

setDaysOfMonth

isSetDaysOfMonth

getMonths

setMonths

isSetMonths

getDaysOfWeek

setDaysOfWeek

isSetDaysOfWeek

getYears

setYears

isSetYears

getDuration

setDuration

isSetDuration

getLocationRef

setLocationRef

isSetLocationRef

getProject

isSetProject

unsetProject

getAtWaypoint

isSetAtWaypoint

unsetAtWaypoint

withFERef

withType

withNum

withSeconds

withMinutes

withHours

withDaysOfMonth

withMonths

withDaysOfWeek

withYears

withDuration

withLocationRef

withProject

withProject

withAtWaypoint

withAtWaypoint

toString

isSet

getForceElement

isSetForceElement

withForceElement

getLocation

isSetLocation

withLocation

prepare

postLoad