us.gov.dod.standard.ssrf._3_1.allotment

Class POCInformation

java.lang.Object

us.gov.dod.standard.ssrf._3_1.allotment.POCInformation

public class POCInformation
extends Object

POCInformation contains a reference to a Contact, Organisation or Role dataset.

Element of Allotment, Antenna, Assignment, ForceElement, IntfReport, JRFLEntry, Location, RFSystem, Receiver, SSRequest, Station, Transmitter

Example:

 <POCInformation>
   <Serial cls="U">USA:123:CN:98765</Serial>
   <Type cls="U">Project Engineer</Type>
   <Description cls="U">Bldg 120, Room 410</Description>
 </POCInformation>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
POCInformation()

Method Summary

Modifier and Type	Method and Description
MEMO	getDescription() Get free text Contact information for legacy applications.
Common<?>	getPoc() Get the dataset identifier of the Contact, Organisation, or Role..
Serial	getSerial() Deprecated. SSRF references are managed automatically. Use getPoc() instead.
TString	getType() Get the function of the referenced Contact or Organisation within the current dataset..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetDescription() Determine if the Description is configured.
boolean	isSetPoc() Determine if the poc field is configured.
boolean	isSetSerial() Determine if the Serial is configured.
boolean	isSetType() Determine if the Type is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this POCInformation record after loading from XML.
void	prepare() Update the SSRF data type references in this POCInformation record.
void	setDescription(MEMO value) Set free text Contact information for legacy applications.
void	setSerial(Serial value) Deprecated. SSRF references are managed automatically. Use #setPoc(Common) instead.
void	setType(TString value) Set the function of the referenced Contact or Organisation within the current dataset..
String	toString() Get a string representation of this POCInformation instance configuration.
POCInformation	withDescription(String value) Set free text Contact information for legacy applications.
POCInformation	withPoc(Common<?> value) Set the dataset identifier of the Contact, Organisation, or Role.
POCInformation	withSerial(Serial value) Deprecated. SSRF references are managed automatically. Use withPoc(Common) instead.
POCInformation	withType(ListCCI value) Set the function of the referenced Contact or Organisation within the current dataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

POCInformation

public POCInformation()

Method Detail

getType

public TString getType()

Get the function of the referenced Contact or Organisation within the current dataset..

Returns:

the Type value in a TString data type

Since:

3.1.0

setType

public void setType(TString value)

Set the function of the referenced Contact or Organisation within the current dataset..

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

getSerial

@Deprecated
public Serial getSerial()

Deprecated. SSRF references are managed automatically. Use getPoc() instead.

Get the dataset identifier of the Contact, Organisation, or Role..

Returns:

a Serial instance

Since:

3.1.0

setSerial

@Deprecated
public void setSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use #setPoc(Common) instead.

Set the dataset identifier of the Contact, Organisation, or Role..

Parameters:

value - a Serial instance

Since:

3.1.0

isSetSerial

public boolean isSetSerial()

Determine if the Serial is configured.

Returns:

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

getDescription

public MEMO getDescription()

Get free text Contact information for legacy applications. When building new records, enter the contact information in the structured Contact, Role, or Organisation dataset..

Returns:

a MEMO instance

Since:

3.1.0

setDescription

public void setDescription(MEMO value)

Set free text Contact information for legacy applications. When building new records, enter the contact information in the structured Contact, Role, or Organisation dataset..

Parameters:

value - a MEMO instance

Since:

3.1.0

isSetDescription

public boolean isSetDescription()

Determine if the Description is configured.

Returns:

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

withType

public POCInformation withType(ListCCI value)

Set the function of the referenced Contact or Organisation within the current dataset.

Parameters:

value - An instances of type ListCCI.

Returns:

The current POCInformation object instance.

Since:

3.1.0

withSerial

@Deprecated
public POCInformation withSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use withPoc(Common) instead.

Set the dataset identifier of the Contact, Organisation, or Role.

Parameters:

value - An instances of type Serial.

Returns:

The current POCInformation object instance.

Since:

3.1.0

withDescription

public POCInformation withDescription(String value)

Set free text Contact information for legacy applications. When building new records, enter the contact information in the structured Contact, Role, or Organisation dataset.

Parameters:

value - An instances of type String.

Returns:

The current POCInformation object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this POCInformation 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.

POCInformation requires 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

getPoc

public Common<?> getPoc()

Get the dataset identifier of the Contact, Organisation, or Role..

Returns:

a Common instance

Since:

3.1.0

isSetPoc

public boolean isSetPoc()

Determine if the poc field is configured.

Returns:

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

withPoc

public POCInformation withPoc(Common<?> value)

Set the dataset identifier of the Contact, Organisation, or Role.

Parameters:

value - An instances of type Common.

Returns:

The current POCInformation object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this POCInformation record.

This method builds the exported serial field with values from the transient poc field. This method should typically be called after the POCInformation is configured and (optionally) before exporting an SSRF message.

Since:

3.1.0

postLoad

public void postLoad(SSRF root)

Update the SSRF data type references in this POCInformation record after loading from XML.

This method builds the transient poc with values from the imported serial field. This method should typically be called after the POCInformation is imported from XML. * @param root the SSRF root instance.

Since:

3.1.0