us.gov.dod.standard.ssrf._3_1.multiple

Class Notation

java.lang.Object

us.gov.dod.standard.ssrf._3_1.multiple.Notation

public class Notation
extends Object

Notation contains the electronic identification for a pulsed or non-pulsed electromagnetic emission. It includes but is not limited to Communications Emitter Notation (CENOT) and Electronic Intelligence Notation (ELNOT).

Element of Configuration

Sub-Elements are NotationTimeline, PotentialVictims, UsingCountries

Example:

 <Notation>
   <Code cls="U">869812</Code>
   <Type cls="U">ELNOT</Type>
   <Status cls="U">Active</Status>
   <NotationTimeline>
     <Code cls="U">869812</Code>
     <Status cls="U">Active</Status>
     <StatusChangeDateTime cls="U">2014-12-25T01:23:001Z</StatusChangeDateTime>
     <Type cls="U">ELNOT</Type>
   </NotationTimeline>
   <PotentialVictims>
     <Type cls="U">ELNOT</Type>
     <VictimName cls="U">Target 478</VictimName>
     <VictimNotation cls="U">B000Z</VictimNotation>
   </PotentialVictims>
   <UsingCountries>
     <CountryName cls="U">USA</CountryName>
     <Role cls="U">Source</Role>
   </UsingCountries>
 </Notation>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Notation()

Method Summary

Modifier and Type	Method and Description
US20	getCode() Get an alphanumeric combination that is used to identify a particular Notation/Signal..
Set<NotationTimeline>	getNotationTimeline() Get the US:NotationTimeline
Set<PotentialVictims>	getPotentialVictims() Get the US:PotentialVictims
TString	getStatus() Get the status of the future, prior, or associated, Notation..
TString	getType() Get the type of Notation..
Set<UsingCountries>	getUsingCountries() Get the US:UsingCountries
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetCode() Determine if the Code is configured.
boolean	isSetNotationTimeline() Determine if the NotationTimeline is configured.
boolean	isSetPotentialVictims() Determine if the PotentialVictims is configured.
boolean	isSetStatus() Determine if the Status is configured.
boolean	isSetType() Determine if the Type is configured.
boolean	isSetUsingCountries() Determine if the UsingCountries is configured.
void	setCode(US20 value) Set an alphanumeric combination that is used to identify a particular Notation/Signal..
void	setStatus(TString value) Set the status of the future, prior, or associated, Notation..
void	setType(TString value) Set the type of Notation..
String	toString() Get a string representation of this Notation instance configuration.
void	unsetNotationTimeline() Clear the NotationTimeline field.
void	unsetPotentialVictims() Clear the PotentialVictims field.
void	unsetUsingCountries() Clear the UsingCountries field.
Notation	withCode(String value) Set an alphanumeric combination that is used to identify a particular Notation/Signal.
Notation	withNotationTimeline(Collection<NotationTimeline> values) Set the US:NotationTimeline
Notation	withNotationTimeline(NotationTimeline... values) Set the US:NotationTimeline
Notation	withPotentialVictims(Collection<PotentialVictims> values) Set the US:PotentialVictims
Notation	withPotentialVictims(PotentialVictims... values) Set the US:PotentialVictims
Notation	withStatus(ListUNT value) Set the status of the future, prior, or associated, Notation.
Notation	withType(ListCEN value) Set the type of Notation.
Notation	withUsingCountries(Collection<UsingCountries> values) Set the US:UsingCountries
Notation	withUsingCountries(UsingCountries... values) Set the US:UsingCountries

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Notation

public Notation()

Method Detail

getCode

public US20 getCode()

Get an alphanumeric combination that is used to identify a particular Notation/Signal..

Returns:

a US20 instance

Since:

3.1.0

setCode

public void setCode(US20 value)

Set an alphanumeric combination that is used to identify a particular Notation/Signal..

Parameters:

value - a US20 instance

Since:

3.1.0

isSetCode

public boolean isSetCode()

Determine if the Code is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getType

public TString getType()

Get the type of Notation..

Returns:

the Type value in a TString data type

Since:

3.1.0

setType

public void setType(TString value)

Set the type of Notation..

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

getStatus

public TString getStatus()

Get the status of the future, prior, or associated, Notation..

Returns:

the Status value in a TString data type

Since:

3.1.0

setStatus

public void setStatus(TString value)

Set the status of the future, prior, or associated, Notation..

Parameters:

value - the Status value in a TString data type

Since:

3.1.0

isSetStatus

public boolean isSetStatus()

Determine if the Status 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

getNotationTimeline

public Set<NotationTimeline> getNotationTimeline()

Get the US:NotationTimeline

Complex element NotationTimeline (US) provides history information for a specific notation or signal..

Returns:

a NotationTimeline instance

Since:

3.1.0

isSetNotationTimeline

public boolean isSetNotationTimeline()

Determine if the NotationTimeline is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

unsetNotationTimeline

public void unsetNotationTimeline()

Clear the NotationTimeline field. This sets the field to null.

getPotentialVictims

public Set<PotentialVictims> getPotentialVictims()

Get the US:PotentialVictims

Complex element PotentialVictims (US) contains the names of systems, or the Notations of signals, which may be affected by the subject Notation/Signal..

Returns:

a PotentialVictims instance

Since:

3.1.0

isSetPotentialVictims

public boolean isSetPotentialVictims()

Determine if the PotentialVictims is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

unsetPotentialVictims

public void unsetPotentialVictims()

Clear the PotentialVictims field. This sets the field to null.

getUsingCountries

public Set<UsingCountries> getUsingCountries()

Get the US:UsingCountries

Complex element UsingCountries (US) describes the countries that manufacture (Producing), supply (Source), and use (Using) the Notation..

Returns:

a UsingCountries instance

Since:

3.1.0

isSetUsingCountries

public boolean isSetUsingCountries()

Determine if the UsingCountries is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

unsetUsingCountries

public void unsetUsingCountries()

Clear the UsingCountries field. This sets the field to null.

withCode

public Notation withCode(String value)

Set an alphanumeric combination that is used to identify a particular Notation/Signal.

Parameters:

value - An instances of type String.

Returns:

The current Notation object instance.

Since:

3.1.0

withType

public Notation withType(ListCEN value)

Set the type of Notation.

Parameters:

value - An instances of type ListCEN.

Returns:

The current Notation object instance.

Since:

3.1.0

withStatus

public Notation withStatus(ListUNT value)

Set the status of the future, prior, or associated, Notation.

Parameters:

value - An instances of type ListUNT.

Returns:

The current Notation object instance.

Since:

3.1.0

withNotationTimeline

public Notation withNotationTimeline(NotationTimeline... values)

Set the US:NotationTimeline

Complex element NotationTimeline (US) provides history information for a specific notation or signal.

Parameters:

values - One or more instances of type NotationTimeline....

Returns:

The current Notation object instance.

Since:

3.1.0

withNotationTimeline

public Notation withNotationTimeline(Collection<NotationTimeline> values)

Set the US:NotationTimeline

Complex element NotationTimeline (US) provides history information for a specific notation or signal.

Parameters:

values - A collection of NotationTimeline instances

Returns:

The current Notation object instance.

Since:

3.1.0

withPotentialVictims

public Notation withPotentialVictims(PotentialVictims... values)

Set the US:PotentialVictims

Complex element PotentialVictims (US) contains the names of systems, or the Notations of signals, which may be affected by the subject Notation/Signal.

Parameters:

values - One or more instances of type PotentialVictims....

Returns:

The current Notation object instance.

Since:

3.1.0

withPotentialVictims

public Notation withPotentialVictims(Collection<PotentialVictims> values)

Set the US:PotentialVictims

Complex element PotentialVictims (US) contains the names of systems, or the Notations of signals, which may be affected by the subject Notation/Signal.

Parameters:

values - A collection of PotentialVictims instances

Returns:

The current Notation object instance.

Since:

3.1.0

withUsingCountries

public Notation withUsingCountries(UsingCountries... values)

Set the US:UsingCountries

Complex element UsingCountries (US) describes the countries that manufacture (Producing), supply (Source), and use (Using) the Notation.

Parameters:

values - One or more instances of type UsingCountries....

Returns:

The current Notation object instance.

Since:

3.1.0

withUsingCountries

public Notation withUsingCountries(Collection<UsingCountries> values)

Set the US:UsingCountries

Complex element UsingCountries (US) describes the countries that manufacture (Producing), supply (Source), and use (Using) the Notation.

Parameters:

values - A collection of UsingCountries instances

Returns:

The current Notation object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this Notation instance configuration.

Overrides:

toString in class Object

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.

Notation requires Code, Type.

Note that this method only checks for the presence of required information; this method does not validate the information format.

Returns:

TRUE if required fields are set, otherwise FALSE