SSReply (lib-openssrf-3.1.0 1.0.0 API)

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

All Implemented Interfaces:: Comparable<SSReply>

public class SSReply
extends Common<SSReply>

SSReply is the XML root for all parameters of a Host Nation Declaration of Spectrum Supportability. It inherits attributes and sub-elements from element Common.

Sub-Elements are CommentSource, Configuration, StageLocation

Example:

 <SSReply cls="U">
   <Serial cls="U">FRA::HD:123</Serial>
   <EntryDateTime cls="U">2012-02-25T00:00:00Z</EntryDateTime>
   <SSRequestRef cls="U">USA::SR:123</SSRequestRef>
   <ReplyingCountry cls="U">FRA</ReplyingCountry>
   <SupportabilityCode cls="U">Supported with Restrictions</SupportabilityCode>
   <EffectiveDate cls="U">2012-02-25</EffectiveDate>
   <CommentSource>
     <Source cls="U">CAA</Source>
     <Comment idx="1" cls="U">IAW frequency clearance agreement FR MoD/FR CAA.</
     Comment>
   </CommentSource>
 </SSReply>

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

SSReply()
No arg constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S11`	`getApprovalSPSNum()` Get the Certification of Spectrum Support Spectrum Planning Subcommittee (SPS) document identifier assigned by NTIA.
`Set<CommentSource>`	`getCommentSource()` Get the CommentSource
`Set<Configuration>`	`getConfiguration()` Get the Configuration
`S15`	`getCoordinationNum()` Get the US Military Communications-Electronics Board (MCEB) identifier assigned to the equipment or system.
`D`	`getDateReceivedByCountry()` Get the date the request was received by the Host Nation Administration..
`S20`	`getDistributionGroups()` Get In Data Item DistributionGroups (US), identify to whom the signed certification should be distributed (e.g., "J-12 Holders")..
`D`	`getEffectiveDate()` Get the date by which the dataset is to be operational or effective..
`S50`	`getERPNumber()` Get the Emergency Readiness Plan (ERP) Number.
`D`	`getExpirationDate()` Get the date at which the dataset will expire.
`S50`	`getFASNumber()` Get the Interdepartment Radio Advisory Committee (IRAC) Frequency Assignment Subcommittee (FAS) identifier assigned by NTIA..
`S50`	`getIRACNumber()` Get the Interdepartment Radio Advisory Committee (IRAC) document number of the NTIA Certification of Spectrum Support document.
`S100`	`getReplyingAuthority()` Get the name of the organization providing the reply..
`TString`	`getReplyingCountry()` Get the code of the country providing the reply..
`D`	`getReviewDate()` Get the date by which the dataset is to be reviewed.
`SSRequest`	`getSsRequest()` Get the dataset identifier of the SSRequest being replied to..
`Serial`	`getSSRequestRef()` Get the dataset identifier of the SSRequest being replied to..
`Set<StageLocation>`	`getStageLocation()` Get the StageLocation
`TString`	`getSupportabilityCode()` Get the overall result of the national analysis.
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetApprovalSPSNum()` Determine if the ApprovalSPSNum is configured.
`boolean`	`isSetCommentSource()` Determine if the CommentSource is configured.
`boolean`	`isSetConfiguration()` Determine if the Configuration is configured.
`boolean`	`isSetCoordinationNum()` Determine if the CoordinationNum is configured.
`boolean`	`isSetDateReceivedByCountry()` Determine if the DateReceivedByCountry is configured.
`boolean`	`isSetDistributionGroups()` Determine if the DistributionGroups is configured.
`boolean`	`isSetEffectiveDate()` Determine if the EffectiveDate is configured.
`boolean`	`isSetERPNumber()` Determine if the ERPNumber is configured.
`boolean`	`isSetExpirationDate()` Determine if the ExpirationDate is configured.
`boolean`	`isSetFASNumber()` Determine if the FASNumber is configured.
`boolean`	`isSetIRACNumber()` Determine if the IRACNumber is configured.
`boolean`	`isSetReplyingAuthority()` Determine if the ReplyingAuthority is configured.
`boolean`	`isSetReplyingCountry()` Determine if the ReplyingCountry is configured.
`boolean`	`isSetReviewDate()` Determine if the ReviewDate is configured.
`boolean`	`isSetSsRequest()` Determine if the ssRequest field is configured.
`boolean`	`isSetSSRequestRef()` Determine if the SSRequestRef is configured.
`boolean`	`isSetStageLocation()` Determine if the StageLocation is configured.
`boolean`	`isSetSupportabilityCode()` Determine if the SupportabilityCode is configured.
`void`	`postLoad(SSRF root)` Update the SSRF data type references in this SSReply record after loading from XML.
`void`	`prepare()` Update the SSRF data type references in this SSReply record.
`void`	`setApprovalSPSNum(S11 value)` Set the Certification of Spectrum Support Spectrum Planning Subcommittee (SPS) document identifier assigned by NTIA.
`void`	`setCoordinationNum(S15 value)` Set the US Military Communications-Electronics Board (MCEB) identifier assigned to the equipment or system.
`void`	`setDateReceivedByCountry(D value)` Set the date the request was received by the Host Nation Administration..
`void`	`setDistributionGroups(S20 value)` Set In Data Item DistributionGroups (US), identify to whom the signed certification should be distributed (e.g., "J-12 Holders")..
`void`	`setEffectiveDate(D value)` Set the date by which the dataset is to be operational or effective..
`void`	`setERPNumber(S50 value)` Set the Emergency Readiness Plan (ERP) Number.
`void`	`setExpirationDate(D value)` Set the date at which the dataset will expire.
`void`	`setFASNumber(S50 value)` Set the Interdepartment Radio Advisory Committee (IRAC) Frequency Assignment Subcommittee (FAS) identifier assigned by NTIA..
`void`	`setIRACNumber(S50 value)` Set the Interdepartment Radio Advisory Committee (IRAC) document number of the NTIA Certification of Spectrum Support document.
`void`	`setReplyingAuthority(S100 value)` Set the name of the organization providing the reply..
`void`	`setReplyingCountry(TString value)` Set the code of the country providing the reply..
`void`	`setReviewDate(D value)` Set the date by which the dataset is to be reviewed.
`void`	`setSSRequestRef(Serial value)` Set the dataset identifier of the SSRequest being replied to..
`void`	`setSupportabilityCode(TString value)` Set the overall result of the national analysis.
`String`	`toString()` Get a string representation of this SSReply instance configuration.
`void`	`unsetCommentSource()` Clear the CommentSource field.
`void`	`unsetConfiguration()` Clear the Configuration field.
`void`	`unsetStageLocation()` Clear the StageLocation field.
`SSReply`	`withApprovalSPSNum(String value)` Set the Certification of Spectrum Support Spectrum Planning Subcommittee (SPS) document identifier assigned by NTIA.
`SSReply`	`withCommentSource(Collection<CommentSource> values)` Set the CommentSource
`SSReply`	`withCommentSource(CommentSource... values)` Set the CommentSource
`SSReply`	`withConfiguration(Collection<Configuration> values)` Set the Configuration
`SSReply`	`withConfiguration(Configuration... values)` Set the Configuration
`SSReply`	`withCoordinationNum(String value)` Set the US Military Communications-Electronics Board (MCEB) identifier assigned to the equipment or system.
`SSReply`	`withDateReceivedByCountry(Calendar value)` Set the date the request was received by the Host Nation Administration.
`SSReply`	`withDateReceivedByCountry(Date value)` Set the date the request was received by the Host Nation Administration.
`SSReply`	`withDistributionGroups(String value)` Set In Data Item DistributionGroups (US), identify to whom the signed certification should be distributed (e.g., "J-12 Holders").
`SSReply`	`withEffectiveDate(Calendar value)` Set the date by which the dataset is to be operational or effective.
`SSReply`	`withEffectiveDate(Date value)` Set the date by which the dataset is to be operational or effective.
`SSReply`	`withERPNumber(String value)` Set the Emergency Readiness Plan (ERP) Number.
`SSReply`	`withExpirationDate(Calendar value)` Set the date at which the dataset will expire.
`SSReply`	`withExpirationDate(Date value)` Set the date at which the dataset will expire.
`SSReply`	`withFASNumber(String value)` Set the Interdepartment Radio Advisory Committee (IRAC) Frequency Assignment Subcommittee (FAS) identifier assigned by NTIA.
`SSReply`	`withIRACNumber(String value)` Set the Interdepartment Radio Advisory Committee (IRAC) document number of the NTIA Certification of Spectrum Support document.
`SSReply`	`withReplyingAuthority(String value)` Set the name of the organization providing the reply.
`SSReply`	`withReplyingCountry(ListCAO value)` Set the code of the country providing the reply.
`SSReply`	`withReviewDate(Calendar value)` Set the date by which the dataset is to be reviewed.
`SSReply`	`withReviewDate(Date value)` Set the date by which the dataset is to be reviewed.
`SSReply`	`withSsRequest(SSRequest value)` Set the dataset identifier of the SSRequest being replied to.
`SSReply`	`withSSRequestRef(Serial value)` Set the dataset identifier of the SSRequest being replied to.
`SSReply`	`withStageLocation(Collection<StageLocation> values)` Set the StageLocation
`SSReply`	`withStageLocation(StageLocation... values)` Set the StageLocation
`SSReply`	`withSupportabilityCode(ListCCD value)` Set the overall result of the national analysis.

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
  - SSReply
```
public SSReply()
```
    No arg constructor. Initializes the Common required fields.
- Method Detail
  - getSSRequestRef
```
public Serial getSSRequestRef()
```
    Get the dataset identifier of the SSRequest being replied to..
    
    Returns:
    
    a Serial instance
    
    Since:
    
    3.1.0
  - setSSRequestRef
```
public void setSSRequestRef(Serial value)
```
    Set the dataset identifier of the SSRequest being replied to..
    
    Parameters:
    
    value - a Serial instance
    
    Since:
    
    3.1.0
  - isSetSSRequestRef
```
public boolean isSetSSRequestRef()
```
    Determine if the SSRequestRef is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getReplyingCountry
```
public TString getReplyingCountry()
```
    Get the code of the country providing the reply..
    
    Returns:
    
    the ReplyingCountry value in a TString data type
    
    Since:
    
    3.1.0
  - setReplyingCountry
```
public void setReplyingCountry(TString value)
```
    Set the code of the country providing the reply..
    
    Parameters:
    
    value - the ReplyingCountry value in a TString data type
    
    Since:
    
    3.1.0
  - isSetReplyingCountry
```
public boolean isSetReplyingCountry()
```
    Determine if the ReplyingCountry 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
  - getSupportabilityCode
```
public TString getSupportabilityCode()
```
    Get the overall result of the national analysis. - If replying "Supported with Restrictions", use Comments for general restrictions only. Specific restrictions on authorised/excluded location should be expressed using the LocationRef. Specific restrictions on tuning ranges and power limits should be expressed using the Configuration. - If replying "Supported with Recommendations", use Comments to express these recommendations..
    
    Returns:
    
    the SupportabilityCode value in a TString data type
    
    Since:
    
    3.1.0
  - setSupportabilityCode
```
public void setSupportabilityCode(TString value)
```
    Set the overall result of the national analysis. - If replying "Supported with Restrictions", use Comments for general restrictions only. Specific restrictions on authorised/excluded location should be expressed using the LocationRef. Specific restrictions on tuning ranges and power limits should be expressed using the Configuration. - If replying "Supported with Recommendations", use Comments to express these recommendations..
    
    Parameters:
    
    value - the SupportabilityCode value in a TString data type
    
    Since:
    
    3.1.0
  - isSetSupportabilityCode
```
public boolean isSetSupportabilityCode()
```
    Determine if the SupportabilityCode 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
  - getDateReceivedByCountry
```
public D getDateReceivedByCountry()
```
    Get the date the request was received by the Host Nation Administration..
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setDateReceivedByCountry
```
public void setDateReceivedByCountry(D value)
```
    Set the date the request was received by the Host Nation Administration..
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetDateReceivedByCountry
```
public boolean isSetDateReceivedByCountry()
```
    Determine if the DateReceivedByCountry is configured.
    
    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
  - getReviewDate
```
public D getReviewDate()
```
    Get the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicates when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment..
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setReviewDate
```
public void setReviewDate(D value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicates when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment..
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetReviewDate
```
public boolean isSetReviewDate()
```
    Determine if the ReviewDate is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getApprovalSPSNum
```
public S11 getApprovalSPSNum()
```
    Get the Certification of Spectrum Support Spectrum Planning Subcommittee (SPS) document identifier assigned by NTIA. This is not the same as the application SPS number..
    
    Returns:
    
    a S11 instance
    
    Since:
    
    3.1.0
  - setApprovalSPSNum
```
public void setApprovalSPSNum(S11 value)
```
    Set the Certification of Spectrum Support Spectrum Planning Subcommittee (SPS) document identifier assigned by NTIA. This is not the same as the application SPS number..
    
    Parameters:
    
    value - a S11 instance
    
    Since:
    
    3.1.0
  - isSetApprovalSPSNum
```
public boolean isSetApprovalSPSNum()
```
    Determine if the ApprovalSPSNum is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getERPNumber
```
public S50 getERPNumber()
```
    Get the Emergency Readiness Plan (ERP) Number. Certification applications are assigned an ERP Number by the Emergency Planning Subcommittee (EPS) of the Interdepartment Radio Advisory Committee (IRAC) if the system involves national security and emergency preparedness (NSEP)..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setERPNumber
```
public void setERPNumber(S50 value)
```
    Set the Emergency Readiness Plan (ERP) Number. Certification applications are assigned an ERP Number by the Emergency Planning Subcommittee (EPS) of the Interdepartment Radio Advisory Committee (IRAC) if the system involves national security and emergency preparedness (NSEP)..
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetERPNumber
```
public boolean isSetERPNumber()
```
    Determine if the ERPNumber is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getFASNumber
```
public S50 getFASNumber()
```
    Get the Interdepartment Radio Advisory Committee (IRAC) Frequency Assignment Subcommittee (FAS) identifier assigned by NTIA..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setFASNumber
```
public void setFASNumber(S50 value)
```
    Set the Interdepartment Radio Advisory Committee (IRAC) Frequency Assignment Subcommittee (FAS) identifier assigned by NTIA..
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetFASNumber
```
public boolean isSetFASNumber()
```
    Determine if the FASNumber is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getIRACNumber
```
public S50 getIRACNumber()
```
    Get the Interdepartment Radio Advisory Committee (IRAC) document number of the NTIA Certification of Spectrum Support document. This number is assigned by NTIA..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setIRACNumber
```
public void setIRACNumber(S50 value)
```
    Set the Interdepartment Radio Advisory Committee (IRAC) document number of the NTIA Certification of Spectrum Support document. This number is assigned by NTIA..
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetIRACNumber
```
public boolean isSetIRACNumber()
```
    Determine if the IRACNumber is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getReplyingAuthority
```
public S100 getReplyingAuthority()
```
    Get the name of the organization providing the reply..
    
    Returns:
    
    a S100 instance
    
    Since:
    
    3.1.0
  - setReplyingAuthority
```
public void setReplyingAuthority(S100 value)
```
    Set the name of the organization providing the reply..
    
    Parameters:
    
    value - a S100 instance
    
    Since:
    
    3.1.0
  - isSetReplyingAuthority
```
public boolean isSetReplyingAuthority()
```
    Determine if the ReplyingAuthority is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getDistributionGroups
```
public S20 getDistributionGroups()
```
    Get In Data Item DistributionGroups (US), identify to whom the signed certification should be distributed (e.g., "J-12 Holders")..
    
    Returns:
    
    a S20 instance
    
    Since:
    
    3.1.0
  - setDistributionGroups
```
public void setDistributionGroups(S20 value)
```
    Set In Data Item DistributionGroups (US), identify to whom the signed certification should be distributed (e.g., "J-12 Holders")..
    
    Parameters:
    
    value - a S20 instance
    
    Since:
    
    3.1.0
  - isSetDistributionGroups
```
public boolean isSetDistributionGroups()
```
    Determine if the DistributionGroups is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getCoordinationNum
```
public S15 getCoordinationNum()
```
    Get the US Military Communications-Electronics Board (MCEB) identifier assigned to the equipment or system. (e.g., J/F 12/12345). An SSRequest coordination number usually ends with an even digit (e.g., /2, /4), while an SSReply coordination number usually ends with an odd digit (e.g., /3, /5). When certifying equipment, both SSRequest and SSReply SHOULD have a coordination number..
    
    Returns:
    
    a S15 instance
    
    Since:
    
    3.1.0
  - setCoordinationNum
```
public void setCoordinationNum(S15 value)
```
    Set the US Military Communications-Electronics Board (MCEB) identifier assigned to the equipment or system. (e.g., J/F 12/12345). An SSRequest coordination number usually ends with an even digit (e.g., /2, /4), while an SSReply coordination number usually ends with an odd digit (e.g., /3, /5). When certifying equipment, both SSRequest and SSReply SHOULD have a coordination number..
    
    Parameters:
    
    value - a S15 instance
    
    Since:
    
    3.1.0
  - isSetCoordinationNum
```
public boolean isSetCoordinationNum()
```
    Determine if the CoordinationNum is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getCommentSource
```
public Set<CommentSource> getCommentSource()
```
    Get the CommentSource
    Complex element CommentSource is used to provide comments to a SSRequest. It can also be used to certify supportability..
    
    Returns:
    
    a CommentSource instance
    
    Since:
    
    3.1.0
  - isSetCommentSource
```
public boolean isSetCommentSource()
```
    Determine if the CommentSource is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetCommentSource
```
public void unsetCommentSource()
```
    Clear the CommentSource field. This sets the field to null.
  - getStageLocation
```
public Set<StageLocation> getStageLocation()
```
    Get the StageLocation
    Complex element StageLocation defines locations where the equipment or system is allowed or forbidden from use..
    
    Returns:
    
    a StageLocation instance
    
    Since:
    
    3.1.0
  - isSetStageLocation
```
public boolean isSetStageLocation()
```
    Determine if the StageLocation is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetStageLocation
```
public void unsetStageLocation()
```
    Clear the StageLocation field. This sets the field to null.
  - getConfiguration
```
public Set<Configuration> getConfiguration()
```
    Get the Configuration
    Complex element Configuration identifies each operational configuration that is required in a SSRequest, granted by a Host Nation in a SSReply, or authorised in a frequency Assignment or Allotment dataset. It also identifies the functional use of the assigned frequency at a particular transmitting station. Finally, it may indicate if the receiver station is used primarily as a repeater. A direct coupling between the station's receiver and the station's transmitter allows the incoming signal to be retransmitted exactly as received..
    
    Returns:
    
    a Configuration instance
    
    Since:
    
    3.1.0
  - isSetConfiguration
```
public boolean isSetConfiguration()
```
    Determine if the Configuration is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetConfiguration
```
public void unsetConfiguration()
```
    Clear the Configuration field. This sets the field to null.
  - withSSRequestRef
```
public SSReply withSSRequestRef(Serial value)
```
    Set the dataset identifier of the SSRequest being replied to.
    
    Parameters:
    
    value - An instances of type Serial.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withReplyingCountry
```
public SSReply withReplyingCountry(ListCAO value)
```
    Set the code of the country providing the reply.
    
    Parameters:
    
    value - An instances of type ListCAO.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withSupportabilityCode
```
public SSReply withSupportabilityCode(ListCCD value)
```
    Set the overall result of the national analysis. - If replying "Supported with Restrictions", use Comments for general restrictions only. Specific restrictions on authorised/excluded location should be expressed using the LocationRef. Specific restrictions on tuning ranges and power limits should be expressed using the Configuration. - If replying "Supported with Recommendations", use Comments to express these recommendations.
    
    Parameters:
    
    value - An instances of type ListCCD.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withDateReceivedByCountry
```
public SSReply withDateReceivedByCountry(Calendar value)
```
    Set the date the request was received by the Host Nation Administration.
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withDateReceivedByCountry
```
public SSReply withDateReceivedByCountry(Date value)
```
    Set the date the request was received by the Host Nation Administration.
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withEffectiveDate
```
public SSReply 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 SSReply object instance.
    
    Since:
    
    3.1.0
  - withEffectiveDate
```
public SSReply 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 SSReply object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public SSReply 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 SSReply object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public SSReply 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 SSReply object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public SSReply withReviewDate(Calendar value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicates when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment.
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public SSReply withReviewDate(Date value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicates when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment.
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withApprovalSPSNum
```
public SSReply withApprovalSPSNum(String value)
```
    Set the Certification of Spectrum Support Spectrum Planning Subcommittee (SPS) document identifier assigned by NTIA. This is not the same as the application SPS number.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withERPNumber
```
public SSReply withERPNumber(String value)
```
    Set the Emergency Readiness Plan (ERP) Number. Certification applications are assigned an ERP Number by the Emergency Planning Subcommittee (EPS) of the Interdepartment Radio Advisory Committee (IRAC) if the system involves national security and emergency preparedness (NSEP).
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withFASNumber
```
public SSReply withFASNumber(String value)
```
    Set the Interdepartment Radio Advisory Committee (IRAC) Frequency Assignment Subcommittee (FAS) identifier assigned by NTIA.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withIRACNumber
```
public SSReply withIRACNumber(String value)
```
    Set the Interdepartment Radio Advisory Committee (IRAC) document number of the NTIA Certification of Spectrum Support document. This number is assigned by NTIA.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withReplyingAuthority
```
public SSReply withReplyingAuthority(String value)
```
    Set the name of the organization providing the reply.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withDistributionGroups
```
public SSReply withDistributionGroups(String value)
```
    Set In Data Item DistributionGroups (US), identify to whom the signed certification should be distributed (e.g., "J-12 Holders").
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withCoordinationNum
```
public SSReply withCoordinationNum(String value)
```
    Set the US Military Communications-Electronics Board (MCEB) identifier assigned to the equipment or system. (e.g., J/F 12/12345). An SSRequest coordination number usually ends with an even digit (e.g., /2, /4), while an SSReply coordination number usually ends with an odd digit (e.g., /3, /5). When certifying equipment, both SSRequest and SSReply SHOULD have a coordination number.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withCommentSource
```
public SSReply withCommentSource(CommentSource... values)
```
    Set the CommentSource
    Complex element CommentSource is used to provide comments to a SSRequest. It can also be used to certify supportability.
    
    Parameters:
    
    values - One or more instances of type CommentSource....
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withCommentSource
```
public SSReply withCommentSource(Collection<CommentSource> values)
```
    Set the CommentSource
    Complex element CommentSource is used to provide comments to a SSRequest. It can also be used to certify supportability.
    
    Parameters:
    
    values - A collection of CommentSource instances
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withStageLocation
```
public SSReply withStageLocation(StageLocation... values)
```
    Set the StageLocation
    Complex element StageLocation defines locations where the equipment or system is allowed or forbidden from use.
    
    Parameters:
    
    values - One or more instances of type StageLocation....
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withStageLocation
```
public SSReply withStageLocation(Collection<StageLocation> values)
```
    Set the StageLocation
    Complex element StageLocation defines locations where the equipment or system is allowed or forbidden from use.
    
    Parameters:
    
    values - A collection of StageLocation instances
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withConfiguration
```
public SSReply withConfiguration(Configuration... values)
```
    Set the Configuration
    Complex element Configuration identifies each operational configuration that is required in a SSRequest, granted by a Host Nation in a SSReply, or authorised in a frequency Assignment or Allotment dataset. It also identifies the functional use of the assigned frequency at a particular transmitting station. Finally, it may indicate if the receiver station is used primarily as a repeater. A direct coupling between the station's receiver and the station's transmitter allows the incoming signal to be retransmitted exactly as received.
    
    Parameters:
    
    values - One or more instances of type Configuration....
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - withConfiguration
```
public SSReply withConfiguration(Collection<Configuration> values)
```
    Set the Configuration
    Complex element Configuration identifies each operational configuration that is required in a SSRequest, granted by a Host Nation in a SSReply, or authorised in a frequency Assignment or Allotment dataset. It also identifies the functional use of the assigned frequency at a particular transmitting station. Finally, it may indicate if the receiver station is used primarily as a repeater. A direct coupling between the station's receiver and the station's transmitter allows the incoming signal to be retransmitted exactly as received.
    
    Parameters:
    
    values - A collection of Configuration instances
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this SSReply instance configuration.
    
    Overrides:
    
    toString in class Common<SSReply>
    
    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.
    SSReply requires cls, Serial, EntryDateTime and EffectiveDate, ReplyingCountry, SupportabilityCode.
    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<SSReply>
    
    Returns:
    
    TRUE if required fields are set, otherwise FALSE
  - getSsRequest
```
public SSRequest getSsRequest()
```
    Get the dataset identifier of the SSRequest being replied to..
    
    Returns:
    
    a SSRequest instance
    
    Since:
    
    3.1.0
  - isSetSsRequest
```
public boolean isSetSsRequest()
```
    Determine if the ssRequest field is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - withSsRequest
```
public SSReply withSsRequest(SSRequest value)
```
    Set the dataset identifier of the SSRequest being replied to.
    
    Parameters:
    
    value - An instances of type SSRequest.
    
    Returns:
    
    The current SSReply object instance.
    
    Since:
    
    3.1.0
  - prepare
```
public void prepare()
```
    Update the SSRF data type references in this SSReply record.
    This method builds the exported ssRequestRef field with values from the transient ssRequest field. This method should typically be called after the SSReply is configured and (optionally) before exporting an SSRF message.
    
    Overrides:
    
    prepare in class Common<SSReply>
    
    Since:
    
    3.1.0
  - postLoad
```
public void postLoad(SSRF root)
```
    Update the SSRF data type references in this SSReply record after loading from XML.
    This method builds the transient ssRequest with values from the imported ssRequestRef field. This method should typically be called after the SSReply is imported from XML. * @param root the SSRF root instance.
    
    Overrides:
    
    postLoad in class Common<SSReply>
    
    Parameters:
    
    root - the SSRF root instance
    
    Since:
    
    3.1.0

Class SSReply

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

SSReply

Method Detail

getSSRequestRef

setSSRequestRef

isSetSSRequestRef

getReplyingCountry

setReplyingCountry

isSetReplyingCountry

getSupportabilityCode

setSupportabilityCode

isSetSupportabilityCode

getDateReceivedByCountry

setDateReceivedByCountry

isSetDateReceivedByCountry

getEffectiveDate

setEffectiveDate

isSetEffectiveDate

getExpirationDate

setExpirationDate

isSetExpirationDate

getReviewDate

setReviewDate

isSetReviewDate

getApprovalSPSNum

setApprovalSPSNum

isSetApprovalSPSNum

getERPNumber

setERPNumber

isSetERPNumber

getFASNumber

setFASNumber

isSetFASNumber

getIRACNumber

setIRACNumber

isSetIRACNumber

getReplyingAuthority

setReplyingAuthority

isSetReplyingAuthority

getDistributionGroups

setDistributionGroups

isSetDistributionGroups

getCoordinationNum

setCoordinationNum

isSetCoordinationNum

getCommentSource

isSetCommentSource

unsetCommentSource

getStageLocation

isSetStageLocation

unsetStageLocation

getConfiguration

isSetConfiguration

unsetConfiguration

withSSRequestRef

withReplyingCountry

withSupportabilityCode

withDateReceivedByCountry

withDateReceivedByCountry

withEffectiveDate

withEffectiveDate

withExpirationDate

withExpirationDate

withReviewDate

withReviewDate

withApprovalSPSNum

withERPNumber

withFASNumber

withIRACNumber

withReplyingAuthority

withDistributionGroups

withCoordinationNum

withCommentSource