us.gov.dod.standard.ssrf._3_1.common

Class Remarks

java.lang.Object

us.gov.dod.standard.ssrf._3_1.common.Remarks

public class Remarks
extends Object

Remarks is a free text field that provides a place to add additional additional information applicable to a data item.

In certain situations, technical data must be included in free text in order to clearly explain a technical or operational consideration; in these instances, the data must also be entered in the data element(s) specifically established for it.

Element of Common

Example:

 <Remarks cls="C" idx="1">This is a JTIDS Class 2H terminal</Remarks>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Remarks()

Method Summary

Modifier and Type	Method and Description
ListCCL	getCls() Get the classification of the current data item.
BigInteger	getIdx() Get a unique index for each Remark used by this Dataset.
String	getValue() Get a value that is most probably correct..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetCls() Determine if the Cls is configured.
boolean	isSetIdx() Determine if the Idx is configured.
boolean	isSetValue() Determine if the Value is configured.
void	setCls(ListCCL value) Set the classification of the current data item.
void	setIdx(BigInteger value) Set a unique index for each Remark used by this Dataset.
void	setValue(String value) Set a value that is most probably correct..
String	toString() Get a string representation of this Remarks instance configuration.
Remarks	withCls(ListCCL value) Set the classification of the current data item.
Remarks	withIdx(BigInteger value) Set a unique index for each Remark used by this Dataset.
Remarks	withValue(String value) Set a value that is most probably correct.

Methods inherited from class java.lang.Object

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

Constructor Detail

Remarks

public Remarks()

Method Detail

getValue

public String getValue()

Get a value that is most probably correct..

Returns:

a String instance

Since:

3.1.0

setValue

public void setValue(String value)

Set a value that is most probably correct..

Parameters:

value - a String instance

Since:

3.1.0

isSetValue

public boolean isSetValue()

Determine if the Value is configured.

Returns:

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

getCls

public ListCCL getCls()

Get the classification of the current data item. This attribute is REQUIRED on each data item, even if the classification is "U"..

Returns:

a ListCCL instance

Since:

3.1.0

setCls

public void setCls(ListCCL value)

Set the classification of the current data item. This attribute is REQUIRED on each data item, even if the classification is "U"..

Parameters:

value - a ListCCL instance

Since:

3.1.0

isSetCls

public boolean isSetCls()

Determine if the Cls is configured.

Returns:

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

getIdx

public BigInteger getIdx()

Get a unique index for each Remark used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted. .

Returns:

a BigInteger instance

Since:

3.1.0

setIdx

public void setIdx(BigInteger value)

Set a unique index for each Remark used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted. .

Parameters:

value - a BigInteger instance

Since:

3.1.0

isSetIdx

public boolean isSetIdx()

Determine if the Idx is configured.

Returns:

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

withValue

public Remarks withValue(String value)

Set a value that is most probably correct.

Parameters:

value - An instances of type String.

Returns:

The current Remarks object instance.

Since:

3.1.0

withCls

public Remarks withCls(ListCCL value)

Set the classification of the current data item. This attribute is REQUIRED on each data item, even if the classification is "U".

Parameters:

value - An instances of type ListCCL.

Returns:

The current Remarks object instance.

Since:

3.1.0

withIdx

public Remarks withIdx(BigInteger value)

Set a unique index for each Remark used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted.

Parameters:

value - An instances of type BigInteger.

Returns:

The current Remarks object instance.

Since:

3.1.0

toString

public String toString()

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

Remarks requires cls, idx.

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