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

Class CaseNum

java.lang.Object

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

public class CaseNum
extends Object

CaseNum provides the capability to store multiple identifiers for a Dataset.

Element of Common, Configuration

Example:

 <CaseNum>
   <Country cls="U">NLD</Country>
   <Identifier cls="U">JWID 2002</Identifier>
 </CaseNum>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
CaseNum()

Method Summary

Modifier and Type	Method and Description
TString	getCountry() Get the nation or body who provided or assigned the case number..
S20	getIdentifier() Get the case number..
S20	getType() Get a text identifying the type of case number (national file, exercise name, etc)..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetCountry() Determine if the Country is configured.
boolean	isSetIdentifier() Determine if the Identifier is configured.
boolean	isSetType() Determine if the Type is configured.
void	setCountry(TString value) Set the nation or body who provided or assigned the case number..
void	setIdentifier(S20 value) Set the case number..
void	setType(S20 value) Set a text identifying the type of case number (national file, exercise name, etc)..
String	toString() Get a string representation of this CaseNum instance configuration.
CaseNum	withCountry(ListCAO value) Set the nation or body who provided or assigned the case number.
CaseNum	withIdentifier(String value) Set the case number.
CaseNum	withType(String value) Set a text identifying the type of case number (national file, exercise name, etc).

Methods inherited from class java.lang.Object

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

Constructor Detail

CaseNum

public CaseNum()

Method Detail

getCountry

public TString getCountry()

Get the nation or body who provided or assigned the case number..

Returns:

the Country value in a TString data type

Since:

3.1.0

setCountry

public void setCountry(TString value)

Set the nation or body who provided or assigned the case number..

Parameters:

value - the Country value in a TString data type

Since:

3.1.0

isSetCountry

public boolean isSetCountry()

Determine if the Country 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

getType

public S20 getType()

Get a text identifying the type of case number (national file, exercise name, etc)..

Returns:

a S20 instance

Since:

3.1.0

setType

public void setType(S20 value)

Set a text identifying the type of case number (national file, exercise name, etc)..

Parameters:

value - a S20 instance

Since:

3.1.0

isSetType

public boolean isSetType()

Determine if the Type is configured.

Returns:

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

getIdentifier

public S20 getIdentifier()

Get the case number..

Returns:

a S20 instance

Since:

3.1.0

setIdentifier

public void setIdentifier(S20 value)

Set the case number..

Parameters:

value - a S20 instance

Since:

3.1.0

isSetIdentifier

public boolean isSetIdentifier()

Determine if the Identifier is configured.

Returns:

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

withCountry

public CaseNum withCountry(ListCAO value)

Set the nation or body who provided or assigned the case number.

Parameters:

value - An instances of type ListCAO.

Returns:

The current CaseNum object instance.

Since:

3.1.0

withType

public CaseNum withType(String value)

Set a text identifying the type of case number (national file, exercise name, etc).

Parameters:

value - An instances of type String.

Returns:

The current CaseNum object instance.

Since:

3.1.0

withIdentifier

public CaseNum withIdentifier(String value)

Set the case number.

Parameters:

value - An instances of type String.

Returns:

The current CaseNum object instance.

Since:

3.1.0

toString

public String toString()

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

CaseNum requires Identifier.

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