us.gov.dod.standard.ssrf._3_1.contact

Class TelephoneFax

java.lang.Object

us.gov.dod.standard.ssrf._3_1.contact.TelephoneFax

public class TelephoneFax
extends Object

TelephoneFax reflects the telephone and/or telefax number(s) of the Contact, Organisation or Role.

Element of Contact, Organisation, Role

Example:

 <TelephoneFax>
   <Type cls="U">TEL-Civil</Type>
   <Number cls="U">(202)281-3824x1234</Number>
 </TelephoneFax>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
TelephoneFax()

Method Summary

Modifier and Type	Method and Description
TString	getFax() Get "Yes" if the number is for a telefax.
TString	getMaxCls() Get the highest classification that can be used on the network.
S50	getNumber() Get the area code, telephone/telefax number (including the extension if necessary) of individual or contact organisation..
TString	getPreferred() Get a code "Yes" for the preferred number(s) and a code "No" for the others..
S20	getType() Get the name of the network on which this number can be dialed (e.g., DSN, IVSN, CORMORANT).
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetFax() Determine if the Fax is configured.
boolean	isSetMaxCls() Determine if the MaxCls is configured.
boolean	isSetNumber() Determine if the Number is configured.
boolean	isSetPreferred() Determine if the Preferred is configured.
boolean	isSetType() Determine if the Type is configured.
void	setFax(TString value) Set "Yes" if the number is for a telefax.
void	setMaxCls(TString value) Set the highest classification that can be used on the network.
void	setNumber(S50 value) Set the area code, telephone/telefax number (including the extension if necessary) of individual or contact organisation..
void	setPreferred(TString value) Set a code "Yes" for the preferred number(s) and a code "No" for the others..
void	setType(S20 value) Set the name of the network on which this number can be dialed (e.g., DSN, IVSN, CORMORANT).
String	toString() Get a string representation of this TelephoneFax instance configuration.
TelephoneFax	withFax(ListCBO value) Set "Yes" if the number is for a telefax.
TelephoneFax	withMaxCls(ListCCL value) Set the highest classification that can be used on the network.
TelephoneFax	withNumber(String value) Set the area code, telephone/telefax number (including the extension if necessary) of individual or contact organisation.
TelephoneFax	withPreferred(ListCBO value) Set a code "Yes" for the preferred number(s) and a code "No" for the others.
TelephoneFax	withType(String value) Set the name of the network on which this number can be dialed (e.g., DSN, IVSN, CORMORANT).

Methods inherited from class java.lang.Object

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

Constructor Detail

TelephoneFax

public TelephoneFax()

Method Detail

getPreferred

public TString getPreferred()

Get a code "Yes" for the preferred number(s) and a code "No" for the others..

Returns:

the Preferred value in a TString data type

Since:

3.1.0

setPreferred

public void setPreferred(TString value)

Set a code "Yes" for the preferred number(s) and a code "No" for the others..

Parameters:

value - the Preferred value in a TString data type

Since:

3.1.0

isSetPreferred

public boolean isSetPreferred()

Determine if the Preferred 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 the name of the network on which this number can be dialed (e.g., DSN, IVSN, CORMORANT). Use "PUBLIC" for normal public telephone or GSM..

Returns:

a S20 instance

Since:

3.1.0

setType

public void setType(S20 value)

Set the name of the network on which this number can be dialed (e.g., DSN, IVSN, CORMORANT). Use "PUBLIC" for normal public telephone or GSM..

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

getFax

public TString getFax()

Get "Yes" if the number is for a telefax. If this item is empty, it SHOULD be considered as "No"..

Returns:

the Fax value in a TString data type

Since:

3.1.0

setFax

public void setFax(TString value)

Set "Yes" if the number is for a telefax. If this item is empty, it SHOULD be considered as "No"..

Parameters:

value - the Fax value in a TString data type

Since:

3.1.0

isSetFax

public boolean isSetFax()

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

getMaxCls

public TString getMaxCls()

Get the highest classification that can be used on the network. Note for the USA: The letter "R" MUST NOT be used in USA created datasets..

Returns:

the MaxCls value in a TString data type

Since:

3.1.0

setMaxCls

public void setMaxCls(TString value)

Set the highest classification that can be used on the network. Note for the USA: The letter "R" MUST NOT be used in USA created datasets..

Parameters:

value - the MaxCls value in a TString data type

Since:

3.1.0

isSetMaxCls

public boolean isSetMaxCls()

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

getNumber

public S50 getNumber()

Get the area code, telephone/telefax number (including the extension if necessary) of individual or contact organisation..

Returns:

a S50 instance

Since:

3.1.0

setNumber

public void setNumber(S50 value)

Set the area code, telephone/telefax number (including the extension if necessary) of individual or contact organisation..

Parameters:

value - a S50 instance

Since:

3.1.0

isSetNumber

public boolean isSetNumber()

Determine if the Number is configured.

Returns:

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

withPreferred

public TelephoneFax withPreferred(ListCBO value)

Set a code "Yes" for the preferred number(s) and a code "No" for the others.

Parameters:

value - An instances of type ListCBO.

Returns:

The current TelephoneFax object instance.

Since:

3.1.0

withType

public TelephoneFax withType(String value)

Set the name of the network on which this number can be dialed (e.g., DSN, IVSN, CORMORANT). Use "PUBLIC" for normal public telephone or GSM.

Parameters:

value - An instances of type String.

Returns:

The current TelephoneFax object instance.

Since:

3.1.0

withFax

public TelephoneFax withFax(ListCBO value)

Set "Yes" if the number is for a telefax. If this item is empty, it SHOULD be considered as "No".

Parameters:

value - An instances of type ListCBO.

Returns:

The current TelephoneFax object instance.

Since:

3.1.0

withMaxCls

public TelephoneFax withMaxCls(ListCCL value)

Set the highest classification that can be used on the network. Note for the USA: The letter "R" MUST NOT be used in USA created datasets.

Parameters:

value - An instances of type ListCCL.

Returns:

The current TelephoneFax object instance.

Since:

3.1.0

withNumber

public TelephoneFax withNumber(String value)

Set the area code, telephone/telefax number (including the extension if necessary) of individual or contact organisation.

Parameters:

value - An instances of type String.

Returns:

The current TelephoneFax object instance.

Since:

3.1.0

toString

public String toString()

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

TelephoneFax requires Number.

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