us.gov.dod.standard.ssrf._3_1.organisation

Class RelatedOrganisation

java.lang.Object

us.gov.dod.standard.ssrf._3_1.organisation.RelatedOrganisation

public class RelatedOrganisation
extends Object

RelatedOrganisation identifies an Organisation linked to the current Organisation, the type of relation (reporting, budget, etc) and the relation (parent, child, sibling).

Element of Organisation

Example:

 <RelatedOrganisation>
   <Type cls="U">Reporting</Type>
   <Relation cls="U">Child</Relation>
   <Serial cls="U">USA:AR:OR:05008827</Serial>
 </RelatedOrganisation>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
RelatedOrganisation()

Method Summary

Modifier and Type	Method and Description
Organisation	getOrganisation() Get the unique reference of the Organisation associated with the current Organisation..
TString	getRelation() Get the relationship between the two organisations..
Serial	getSerial() Deprecated. SSRF references are managed automatically. Use getOrganisation() instead.
TString	getType() Get the type of relationship..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetOrganisation() Determine if the organisation field is configured.
boolean	isSetRelation() Determine if the Relation 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 RelatedOrganisation record after loading from XML.
void	prepare() Update the SSRF data type references in this RelatedOrganisation record.
void	setRelation(TString value) Set the relationship between the two organisations..
void	setSerial(Serial value) Deprecated. SSRF references are managed automatically. Use #setOrganisation(Organisation) instead.
void	setType(TString value) Set the type of relationship..
String	toString() Get a string representation of this RelatedOrganisation instance configuration.
RelatedOrganisation	withOrganisation(Organisation value) Set the unique reference of the Organisation associated with the current Organisation.
RelatedOrganisation	withRelation(ListCFR value) Set the relationship between the two organisations.
RelatedOrganisation	withSerial(Serial value) Deprecated. SSRF references are managed automatically. Use withOrganisation(Organisation) instead.
RelatedOrganisation	withType(ListCFT value) Set the type of relationship.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedOrganisation

public RelatedOrganisation()

Method Detail

getType

public TString getType()

Get the type of relationship..

Returns:

the Type value in a TString data type

Since:

3.1.0

setType

public void setType(TString value)

Set the type of relationship..

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

getRelation

public TString getRelation()

Get the relationship between the two organisations..

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 organisations..

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 getOrganisation() instead.

Get the unique reference of the Organisation associated with the current Organisation..

Returns:

a Serial instance

Since:

3.1.0

setSerial

@Deprecated
public void setSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use #setOrganisation(Organisation) instead.

Set the unique reference of the Organisation associated with the current Organisation..

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

withType

public RelatedOrganisation withType(ListCFT value)

Set the type of relationship.

Parameters:

value - An instances of type ListCFT.

Returns:

The current RelatedOrganisation object instance.

Since:

3.1.0

withRelation

public RelatedOrganisation withRelation(ListCFR value)

Set the relationship between the two organisations.

Parameters:

value - An instances of type ListCFR.

Returns:

The current RelatedOrganisation object instance.

Since:

3.1.0

withSerial

@Deprecated
public RelatedOrganisation withSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use withOrganisation(Organisation) instead.

Set the unique reference of the Organisation associated with the current Organisation.

Parameters:

value - An instances of type Serial.

Returns:

The current RelatedOrganisation object instance.

Since:

3.1.0

toString

public String toString()

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

RelatedOrganisation 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

getOrganisation

public Organisation getOrganisation()

Get the unique reference of the Organisation associated with the current Organisation..

Returns:

a Organisation instance

Since:

3.1.0

isSetOrganisation

public boolean isSetOrganisation()

Determine if the organisation field is configured.

Returns:

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

withOrganisation

public RelatedOrganisation withOrganisation(Organisation value)

Set the unique reference of the Organisation associated with the current Organisation.

Parameters:

value - An instances of type Organisation.

Returns:

The current RelatedOrganisation object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this RelatedOrganisation record.

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

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

Since:

3.1.0