us.gov.dod.standard.ssrf._3_1.rfsystem

Class RelatedSystem

java.lang.Object

us.gov.dod.standard.ssrf._3_1.rfsystem.RelatedSystem

public class RelatedSystem
extends Object

RelatedSystem identifies a System linked to the current System, and the relation (parent, child, sibling).

Element of RFSystem

Example:

 <RelatedSystem>
   <Relation cls="U">HasChild</Relation>
   <Serial cls="U">USA:AR:TR:05008827</Serial>
 </RelatedSystem>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
RelatedSystem()

Method Summary

Modifier and Type	Method and Description
TString	getRelation() Get the relationship between the two systems..
RFSystem	getRfSystem() Get the reference of the System associated with the current System..
Serial	getSerial() Deprecated. SSRF references are managed automatically. Use getRfSystem() instead.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetRelation() Determine if the Relation is configured.
boolean	isSetRfSystem() Determine if the rfSystem field is configured.
boolean	isSetSerial() Determine if the Serial is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this RelatedSystem record after loading from XML.
void	prepare() Update the SSRF data type references in this RelatedSystem record.
void	setRelation(TString value) Set the relationship between the two systems..
void	setSerial(Serial value) Deprecated. SSRF references are managed automatically. Use #setRfSystem(RFSystem) instead.
String	toString() Get a string representation of this RelatedSystem instance configuration.
RelatedSystem	withRelation(ListCFR value) Set the relationship between the two systems.
RelatedSystem	withRfSystem(RFSystem value) Set the reference of the System associated with the current System.
RelatedSystem	withSerial(Serial value) Deprecated. SSRF references are managed automatically. Use withRfSystem(RFSystem) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedSystem

public RelatedSystem()

Method Detail

getRelation

public TString getRelation()

Get the relationship between the two systems..

Returns:

the Relation value in a TString data type

Since:

3.1.0

setRelation

public void setRelation(TString value)

Set the relationship between the two systems..

Parameters:

value - the Relation value in a TString data type

Since:

3.1.0

isSetRelation

public boolean isSetRelation()

Determine if the Relation 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 getRfSystem() instead.

Get the reference of the System associated with the current System..

Returns:

a Serial instance

Since:

3.1.0

setSerial

@Deprecated
public void setSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use #setRfSystem(RFSystem) instead.

Set the reference of the System associated with the current System..

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

withRelation

public RelatedSystem withRelation(ListCFR value)

Set the relationship between the two systems.

Parameters:

value - An instances of type ListCFR.

Returns:

The current RelatedSystem object instance.

Since:

3.1.0

withSerial

@Deprecated
public RelatedSystem withSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use withRfSystem(RFSystem) instead.

Set the reference of the System associated with the current System.

Parameters:

value - An instances of type Serial.

Returns:

The current RelatedSystem object instance.

Since:

3.1.0

toString

public String toString()

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

RelatedSystem requires Relation, Serial.

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

getRfSystem

public RFSystem getRfSystem()

Get the reference of the System associated with the current System..

Returns:

a RFSystem instance

Since:

3.1.0

isSetRfSystem

public boolean isSetRfSystem()

Determine if the rfSystem field is configured.

Returns:

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

withRfSystem

public RelatedSystem withRfSystem(RFSystem value)

Set the reference of the System associated with the current System.

Parameters:

value - An instances of type RFSystem.

Returns:

The current RelatedSystem object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this RelatedSystem record.

This method builds the exported serial field with values from the transient rfSystem field. This method should typically be called after the RelatedSystem 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 RelatedSystem record after loading from XML.

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

Since:

3.1.0