us.gov.dod.standard.ssrf._3_1.administrative

Class CodeList

java.lang.Object

us.gov.dod.standard.ssrf._3_1.administrative.CodeList

public class CodeList
extends Object

CodeList contains the actions necessary to create or delete a code entry in a given Code List.

Element of Administrative

Sub-Element is Code

Example:

 <CodeList>
   <Action cls="U">Add Code</Action>
   <CodeListCode cls="U">CAS</CodeListCode>
   <EffectiveDate cls="U">2011-12-25</EffectiveDate>
   <Code>
     <Value cls="U">Jerking</Value>
     <Description cls="U">Moving wildly in all directions</Description>
   </Code>
 </CodeList>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
CodeList()

Method Summary

Modifier and Type	Method and Description
TString	getAction() Get the intended type of modification to the given code list..
Set<Code>	getCode() Get the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List..
US3	getCodeListCode() Get the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List..
MEMO	getDescription() Get the description of the intended contents of new code list, and the element(s) where it will be used..
D	getEffectiveDate() Get the date by which the dataset is to be operational or effective..
TString	getOrigin() Get the country or organisation which is using the modified or new code..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAction() Determine if the Action is configured.
boolean	isSetCode() Determine if the Code is configured.
boolean	isSetCodeListCode() Determine if the CodeListCode is configured.
boolean	isSetDescription() Determine if the Description is configured.
boolean	isSetEffectiveDate() Determine if the EffectiveDate is configured.
boolean	isSetOrigin() Determine if the Origin is configured.
void	setAction(TString value) Set the intended type of modification to the given code list..
void	setCodeListCode(US3 value) Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List..
void	setDescription(MEMO value) Set the description of the intended contents of new code list, and the element(s) where it will be used..
void	setEffectiveDate(D value) Set the date by which the dataset is to be operational or effective..
void	setOrigin(TString value) Set the country or organisation which is using the modified or new code..
String	toString() Get a string representation of this CodeList instance configuration.
void	unsetCode() Clear the Code field.
CodeList	withAction(ListCAC value) Set the intended type of modification to the given code list.
CodeList	withCode(Code... values) Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List.
CodeList	withCode(Collection<Code> values) Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List.
CodeList	withCodeListCode(String value) Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List.
CodeList	withDescription(String value) Set the description of the intended contents of new code list, and the element(s) where it will be used.
CodeList	withEffectiveDate(Calendar value) Set the date by which the dataset is to be operational or effective.
CodeList	withEffectiveDate(Date value) Set the date by which the dataset is to be operational or effective.
CodeList	withOrigin(ListCAO value) Set the country or organisation which is using the modified or new code.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeList

public CodeList()

Method Detail

getAction

public TString getAction()

Get the intended type of modification to the given code list..

Returns:

the Action value in a TString data type

Since:

3.1.0

setAction

public void setAction(TString value)

Set the intended type of modification to the given code list..

Parameters:

value - the Action value in a TString data type

Since:

3.1.0

isSetAction

public boolean isSetAction()

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

getCodeListCode

public US3 getCodeListCode()

Get the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List..

Returns:

a US3 instance

Since:

3.1.0

setCodeListCode

public void setCodeListCode(US3 value)

Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List..

Parameters:

value - a US3 instance

Since:

3.1.0

isSetCodeListCode

public boolean isSetCodeListCode()

Determine if the CodeListCode is configured.

Returns:

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

getEffectiveDate

public D getEffectiveDate()

Get the date by which the dataset is to be operational or effective..

Returns:

a D instance

Since:

3.1.0

setEffectiveDate

public void setEffectiveDate(D value)

Set the date by which the dataset is to be operational or effective..

Parameters:

value - a D instance

Since:

3.1.0

isSetEffectiveDate

public boolean isSetEffectiveDate()

Determine if the EffectiveDate is configured.

Returns:

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

getDescription

public MEMO getDescription()

Get the description of the intended contents of new code list, and the element(s) where it will be used..

Returns:

a MEMO instance

Since:

3.1.0

setDescription

public void setDescription(MEMO value)

Set the description of the intended contents of new code list, and the element(s) where it will be used..

Parameters:

value - a MEMO instance

Since:

3.1.0

isSetDescription

public boolean isSetDescription()

Determine if the Description is configured.

Returns:

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

getOrigin

public TString getOrigin()

Get the country or organisation which is using the modified or new code..

Returns:

the Origin value in a TString data type

Since:

3.1.0

setOrigin

public void setOrigin(TString value)

Set the country or organisation which is using the modified or new code..

Parameters:

value - the Origin value in a TString data type

Since:

3.1.0

isSetOrigin

public boolean isSetOrigin()

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

getCode

public Set<Code> getCode()

Get the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List..

Returns:

a Code instance

Since:

3.1.0

isSetCode

public boolean isSetCode()

Determine if the Code is configured.

Returns:

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

unsetCode

public void unsetCode()

Clear the Code field. This sets the field to null.

withAction

public CodeList withAction(ListCAC value)

Set the intended type of modification to the given code list.

Parameters:

value - An instances of type ListCAC.

Returns:

The current CodeList object instance.

Since:

3.1.0

withCodeListCode

public CodeList withCodeListCode(String value)

Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List.

Parameters:

value - An instances of type String.

Returns:

The current CodeList object instance.

Since:

3.1.0

withEffectiveDate

public CodeList withEffectiveDate(Calendar value)

Set the date by which the dataset is to be operational or effective.

Parameters:

value - An instances of type Calendar.

Returns:

The current CodeList object instance.

Since:

3.1.0

withEffectiveDate

public CodeList withEffectiveDate(Date value)

Set the date by which the dataset is to be operational or effective.

Parameters:

value - An instances of type Date.

Returns:

The current CodeList object instance.

Since:

3.1.0

withDescription

public CodeList withDescription(String value)

Set the description of the intended contents of new code list, and the element(s) where it will be used.

Parameters:

value - An instances of type String.

Returns:

The current CodeList object instance.

Since:

3.1.0

withOrigin

public CodeList withOrigin(ListCAO value)

Set the country or organisation which is using the modified or new code.

Parameters:

value - An instances of type ListCAO.

Returns:

The current CodeList object instance.

Since:

3.1.0

withCode

public CodeList withCode(Code... values)

Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List.

Parameters:

values - One or more instances of type Code....

Returns:

The current CodeList object instance.

Since:

3.1.0

withCode

public CodeList withCode(Collection<Code> values)

Set the three-letter code of an existing Code List to be modified, or an unused three-letter code in the case of the creation of a new Code List.

Parameters:

values - A collection of Code instances

Returns:

The current CodeList object instance.

Since:

3.1.0

toString

public String toString()

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

CodeList requires Action, CodeListCode, EffectiveDate.

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