us.gov.dod.standard.ssrf._3_1.forceelement

Class Assets

java.lang.Object

us.gov.dod.standard.ssrf._3_1.forceelement.Assets

public class Assets
extends Object

Assets indicates the authorised and available quantity of the equipment, RF systems, or other Force Elements used or owned by the Force Element.

Element of ForceElement

Example:

 <Assets>
   <Serial cls="U">USA:AF:FE:123</Serial>
   <Authorised cls="U">10</Authorised>
   <Available cls="U">5</Available>
 </Assets>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Assets()

Method Summary

Modifier and Type	Method and Description
Common<?>	getAsset() Get a reference to a Transmitter, Receiver, Antenna, RFSystem used by this ForceElement, or to a ForceElement carried by or belonging to this ForceElement..
UN9	getAuthorised() Get the authorised quantity of the referenced equipment or system..
UN9	getAvailable() Get the available quantity of the referenced equipment or system..
Serial	getSerial() Deprecated. SSRF references are managed automatically. Use getAsset() instead.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAsset() Determine if the asset field is configured.
boolean	isSetAuthorised() Determine if the Authorised is configured.
boolean	isSetAvailable() Determine if the Available is configured.
boolean	isSetSerial() Determine if the Serial is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this Assets record after loading from XML.
void	prepare() Update the SSRF data type references in this Assets record.
void	setAuthorised(UN9 value) Set the authorised quantity of the referenced equipment or system..
void	setAvailable(UN9 value) Set the available quantity of the referenced equipment or system..
void	setSerial(Serial value) Deprecated. SSRF references are managed automatically. Use #setAsset(Common) instead.
String	toString() Get a string representation of this Assets instance configuration.
Assets	withAsset(Common<?> value) Set a reference to a Transmitter, Receiver, Antenna, RFSystem used by this ForceElement, or to a ForceElement carried by or belonging to this ForceElement.
Assets	withAuthorised(Integer value) Set the authorised quantity of the referenced equipment or system.
Assets	withAvailable(Integer value) Set the available quantity of the referenced equipment or system.
Assets	withSerial(Serial value) Deprecated. SSRF references are managed automatically. Use withAsset(Common) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

Assets

public Assets()

Method Detail

getSerial

@Deprecated
public Serial getSerial()

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

Get a reference to a Transmitter, Receiver, Antenna, RFSystem used by this ForceElement, or to a ForceElement carried by or belonging to this ForceElement..

Returns:

a Serial instance

Since:

3.1.0

setSerial

@Deprecated
public void setSerial(Serial value)

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

Set a reference to a Transmitter, Receiver, Antenna, RFSystem used by this ForceElement, or to a ForceElement carried by or belonging to this ForceElement..

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

getAuthorised

public UN9 getAuthorised()

Get the authorised quantity of the referenced equipment or system..

Returns:

a UN9 instance

Since:

3.1.0

setAuthorised

public void setAuthorised(UN9 value)

Set the authorised quantity of the referenced equipment or system..

Parameters:

value - a UN9 instance

Since:

3.1.0

isSetAuthorised

public boolean isSetAuthorised()

Determine if the Authorised is configured.

Returns:

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

getAvailable

public UN9 getAvailable()

Get the available quantity of the referenced equipment or system..

Returns:

a UN9 instance

Since:

3.1.0

setAvailable

public void setAvailable(UN9 value)

Set the available quantity of the referenced equipment or system..

Parameters:

value - a UN9 instance

Since:

3.1.0

isSetAvailable

public boolean isSetAvailable()

Determine if the Available is configured.

Returns:

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

withSerial

@Deprecated
public Assets withSerial(Serial value)

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

Set a reference to a Transmitter, Receiver, Antenna, RFSystem used by this ForceElement, or to a ForceElement carried by or belonging to this ForceElement.

Parameters:

value - An instances of type Serial.

Returns:

The current Assets object instance.

Since:

3.1.0

withAuthorised

public Assets withAuthorised(Integer value)

Set the authorised quantity of the referenced equipment or system.

Parameters:

value - An instances of type Integer.

Returns:

The current Assets object instance.

Since:

3.1.0

withAvailable

public Assets withAvailable(Integer value)

Set the available quantity of the referenced equipment or system.

Parameters:

value - An instances of type Integer.

Returns:

The current Assets object instance.

Since:

3.1.0

toString

public String toString()

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

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

getAsset

public Common<?> getAsset()

Get a reference to a Transmitter, Receiver, Antenna, RFSystem used by this ForceElement, or to a ForceElement carried by or belonging to this ForceElement..

Returns:

a Common instance

Since:

3.1.0

isSetAsset

public boolean isSetAsset()

Determine if the asset field is configured.

Returns:

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

withAsset

public Assets withAsset(Common<?> value)

Set a reference to a Transmitter, Receiver, Antenna, RFSystem used by this ForceElement, or to a ForceElement carried by or belonging to this ForceElement.

Parameters:

value - An instances of type Common.

Returns:

The current Assets object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this Assets record.

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

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

Since:

3.1.0