Contact (lib-openssrf-3.1.0 1.0.0 API)

java.lang.Object
- us.gov.dod.standard.ssrf._3_1.Common<Contact>
- - us.gov.dod.standard.ssrf._3_1.Contact

All Implemented Interfaces:: Comparable<Contact>

public class Contact
extends Common<Contact>

Contact is the XML root for all parameters of a Contact.

Sub-Elements are Address, Email, TelephoneFax

Example:

 <Contact cls="U">
   <Serial cls="U">USA:AF:CN:123</Serial>
   <EntryDateTime cls="U">2004-05-20T00:00:00Z</EntryDateTime>
   <FirstName cls="U">John</FirstName>
   <LastName cls="U">Doe</LastName>
   <TelephoneFax>
     <Number cls="U">(123)456.789</Number>
   </TelephoneFax>
 </Contact>

Version:: 3.1.0, 03/30/2015
Author:: Key Bridge LLC

Field Summary
- Fields inherited from class us.gov.dod.standard.ssrf._3_1.Common
  approvedBy, approvedDateTime, caseNum, cls, description, entryBy, entryByRole, entryDateTime, extReferenceRef, extReferences, idref, lastChangeBy, lastChangeByRole, lastChangeDateTime, lastObservedBy, lastReviewBy, lastReviewByRole, lastReviewDate, legacyReleasability, modAllowedBy, modAllowedByRole, observedFirstDateTime, observedLastDateTime, owner, ownerRole, quality, recommendedValue, redacted, releasability, remarkRef, remarks, securityClass, serial, state

Constructor Summary

Constructors
Constructor and Description

Contact()
No arg constructor.

Constructors
Constructor and Description
`Contact()` No arg constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<Address>`	`getAddress()` Get the Address
`D`	`getEffectiveDate()` Get the date by which the dataset is to be operational or effective..
`Set<EMail>`	`getEMail()` Get the Email
`D`	`getExpirationDate()` Get the date at which the dataset will expire.
`S30`	`getFirstName()` Get the first name of the contact individual..
`S30`	`getLastName()` Get the last name of the contact individual..
`D`	`getReviewDate()` Get the date by which the dataset is to be reviewed.
`Set<TelephoneFax>`	`getTelephoneFax()` Get the TelephoneFax
`S10`	`getTitleRank()` Get the contact title or rank e.g., Ms, Col, etc..
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetAddress()` Determine if the Address is configured.
`boolean`	`isSetEffectiveDate()` Determine if the EffectiveDate is configured.
`boolean`	`isSetEMail()` Determine if the EMail is configured.
`boolean`	`isSetExpirationDate()` Determine if the ExpirationDate is configured.
`boolean`	`isSetFirstName()` Determine if the FirstName is configured.
`boolean`	`isSetLastName()` Determine if the LastName is configured.
`boolean`	`isSetReviewDate()` Determine if the ReviewDate is configured.
`boolean`	`isSetTelephoneFax()` Determine if the TelephoneFax is configured.
`boolean`	`isSetTitleRank()` Determine if the TitleRank is configured.
`void`	`setEffectiveDate(D value)` Set the date by which the dataset is to be operational or effective..
`void`	`setExpirationDate(D value)` Set the date at which the dataset will expire.
`void`	`setFirstName(S30 value)` Set the first name of the contact individual..
`void`	`setLastName(S30 value)` Set the last name of the contact individual..
`void`	`setReviewDate(D value)` Set the date by which the dataset is to be reviewed.
`void`	`setTitleRank(S10 value)` Set the contact title or rank e.g., Ms, Col, etc..
`String`	`toString()` Get a string representation of this Contact instance configuration.
`void`	`unsetAddress()` Clear the Address field.
`void`	`unsetEMail()` Clear the EMail field.
`void`	`unsetTelephoneFax()` Clear the TelephoneFax field.
`Contact`	`withAddress(Address... values)` Set the Address
`Contact`	`withAddress(Collection<Address> values)` Set the Address
`Contact`	`withEffectiveDate(Calendar value)` Set the date by which the dataset is to be operational or effective.
`Contact`	`withEffectiveDate(Date value)` Set the date by which the dataset is to be operational or effective.
`Contact`	`withEMail(Collection<EMail> values)` Set the Email
`Contact`	`withEMail(EMail... values)` Set the Email
`Contact`	`withExpirationDate(Calendar value)` Set the date at which the dataset will expire.
`Contact`	`withExpirationDate(Date value)` Set the date at which the dataset will expire.
`Contact`	`withFirstName(String value)` Set the first name of the contact individual.
`Contact`	`withLastName(String value)` Set the last name of the contact individual.
`Contact`	`withReviewDate(Calendar value)` Set the date by which the dataset is to be reviewed.
`Contact`	`withReviewDate(Date value)` Set the date by which the dataset is to be reviewed.
`Contact`	`withTelephoneFax(Collection<TelephoneFax> values)` Set the TelephoneFax
`Contact`	`withTelephoneFax(TelephoneFax... values)` Set the TelephoneFax
`Contact`	`withTitleRank(String value)` Set the contact title or rank e.g., Ms, Col, etc.

Methods inherited from class us.gov.dod.standard.ssrf._3_1.Common
compareTo, equals, getApprovedBy, getApprovedDateTime, getCaseNum, getCls, getDescription, getEntryBy, getEntryByRole, getEntryDateTime, getExtReferenceRef, getExtReferences, getIdref, getLastChangeBy, getLastChangeByRole, getLastChangeDateTime, getLastObservedBy, getLastReviewBy, getLastReviewByRole, getLastReviewDate, getLegacyReleasability, getModAllowedBy, getModAllowedByRole, getObservedFirstDateTime, getObservedLastDateTime, getOwner, getOwnerRole, getQuality, getRecommendedValue, getRedacted, getReleasability, getRemarkRef, getRemarks, getSecurityClass, getSerial, getState, hashCode, isSetApprovedBy, isSetApprovedDateTime, isSetCaseNum, isSetCls, isSetDescription, isSetEntryBy, isSetEntryByRole, isSetEntryDateTime, isSetExtReferenceRef, isSetExtReferences, isSetIdref, isSetLastChangeBy, isSetLastChangeByRole, isSetLastChangeDateTime, isSetLastObservedBy, isSetLastReviewBy, isSetLastReviewByRole, isSetLastReviewDate, isSetLegacyReleasability, isSetModAllowedBy, isSetModAllowedByRole, isSetObservedFirstDateTime, isSetObservedLastDateTime, isSetOwner, isSetOwnerRole, isSetQuality, isSetRecommendedValue, isSetRedacted, isSetReleasability, isSetRemarkRef, isSetRemarks, isSetSecurityClass, isSetSerial, isSetState, postLoad, prepare, setApprovedBy, setApprovedDateTime, setCls, setDescription, setEntryBy, setEntryDateTime, setIdref, setLastChangeBy, setLastChangeDateTime, setLastObservedBy, setLastReviewBy, setLastReviewDate, setLegacyReleasability, setModAllowedBy, setObservedFirstDateTime, setObservedLastDateTime, setOwner, setQuality, setRecommendedValue, setRedacted, setSecurityClass, setSerial, setState, unsetCaseNum, unsetExtReferenceRef, unsetExtReferences, unsetReleasability, unsetRemarkRef, unsetRemarks, withApprovedBy, withApprovedDateTime, withApprovedDateTime, withCaseNum, withCaseNum, withCls, withDescription, withEntryBy, withEntryByRole, withEntryDateTime, withExtReferenceRef, withExtReferenceRef, withExtReferences, withExtReferences, withExtReferences, withIdref, withLastChangeBy, withLastChangeByRole, withLastChangeDateTime, withLastChangeDateTime, withLastObservedBy, withLastReviewBy, withLastReviewByRole, withLastReviewDate, withLastReviewDate, withLegacyReleasability, withModAllowedBy, withModAllowedByRole, withObservedFirstDateTime, withObservedFirstDateTime, withObservedLastDateTime, withObservedLastDateTime, withOwner, withOwnerRole, withQuality, withRecommendedValue, withRedacted, withReleasability, withReleasability, withRemarkRef, withRemarkRef, withRemarkRef, withRemarks, withRemarks, withSecurityClass, withSerial, withState

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Contact
```
public Contact()
```
    No arg constructor. Initializes the Common required fields.
- Method Detail
  - 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
  - getExpirationDate
```
public D getExpirationDate()
```
    Get the date at which the dataset will expire. The Expiration date should be less than five years from current date..
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setExpirationDate
```
public void setExpirationDate(D value)
```
    Set the date at which the dataset will expire. The Expiration date should be less than five years from current date..
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetExpirationDate
```
public boolean isSetExpirationDate()
```
    Determine if the ExpirationDate is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getReviewDate
```
public D getReviewDate()
```
    Get the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment..
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setReviewDate
```
public void setReviewDate(D value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment..
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetReviewDate
```
public boolean isSetReviewDate()
```
    Determine if the ReviewDate is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getTitleRank
```
public S10 getTitleRank()
```
    Get the contact title or rank e.g., Ms, Col, etc..
    
    Returns:
    
    a S10 instance
    
    Since:
    
    3.1.0
  - setTitleRank
```
public void setTitleRank(S10 value)
```
    Set the contact title or rank e.g., Ms, Col, etc..
    
    Parameters:
    
    value - a S10 instance
    
    Since:
    
    3.1.0
  - isSetTitleRank
```
public boolean isSetTitleRank()
```
    Determine if the TitleRank is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getFirstName
```
public S30 getFirstName()
```
    Get the first name of the contact individual..
    
    Returns:
    
    a S30 instance
    
    Since:
    
    3.1.0
  - setFirstName
```
public void setFirstName(S30 value)
```
    Set the first name of the contact individual..
    
    Parameters:
    
    value - a S30 instance
    
    Since:
    
    3.1.0
  - isSetFirstName
```
public boolean isSetFirstName()
```
    Determine if the FirstName is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getLastName
```
public S30 getLastName()
```
    Get the last name of the contact individual..
    
    Returns:
    
    a S30 instance
    
    Since:
    
    3.1.0
  - setLastName
```
public void setLastName(S30 value)
```
    Set the last name of the contact individual..
    
    Parameters:
    
    value - a S30 instance
    
    Since:
    
    3.1.0
  - isSetLastName
```
public boolean isSetLastName()
```
    Determine if the LastName is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getAddress
```
public Set<Address> getAddress()
```
    Get the Address
    Complex element Address contains the address of a Contact, Organisation or Role..
    
    Returns:
    
    a Address instance
    
    Since:
    
    3.1.0
  - isSetAddress
```
public boolean isSetAddress()
```
    Determine if the Address is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetAddress
```
public void unsetAddress()
```
    Clear the Address field. This sets the field to null.
  - getTelephoneFax
```
public Set<TelephoneFax> getTelephoneFax()
```
    Get the TelephoneFax
    Complex element TelephoneFax reflects the telephone and/or telefax number(s) of the Contact, Organisation or Role..
    
    Returns:
    
    a TelephoneFax instance
    
    Since:
    
    3.1.0
  - isSetTelephoneFax
```
public boolean isSetTelephoneFax()
```
    Determine if the TelephoneFax is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetTelephoneFax
```
public void unsetTelephoneFax()
```
    Clear the TelephoneFax field. This sets the field to null.
  - getEMail
```
public Set<EMail> getEMail()
```
    Get the Email
    Complex element Email contains the email address of the Contact or Role..
    
    Returns:
    
    a EMail instance
    
    Since:
    
    3.1.0
  - isSetEMail
```
public boolean isSetEMail()
```
    Determine if the EMail is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetEMail
```
public void unsetEMail()
```
    Clear the EMail field. This sets the field to null.
  - withEffectiveDate
```
public Contact 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 Contact object instance.
    
    Since:
    
    3.1.0
  - withEffectiveDate
```
public Contact 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 Contact object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Contact withExpirationDate(Calendar value)
```
    Set the date at which the dataset will expire. The Expiration date should be less than five years from current date.
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Contact withExpirationDate(Date value)
```
    Set the date at which the dataset will expire. The Expiration date should be less than five years from current date.
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public Contact withReviewDate(Calendar value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment.
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public Contact withReviewDate(Date value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment.
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withTitleRank
```
public Contact withTitleRank(String value)
```
    Set the contact title or rank e.g., Ms, Col, etc.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withFirstName
```
public Contact withFirstName(String value)
```
    Set the first name of the contact individual.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withLastName
```
public Contact withLastName(String value)
```
    Set the last name of the contact individual.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withAddress
```
public Contact withAddress(Address... values)
```
    Set the Address
    Complex element Address contains the address of a Contact, Organisation or Role.
    
    Parameters:
    
    values - One or more instances of type Address....
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withAddress
```
public Contact withAddress(Collection<Address> values)
```
    Set the Address
    Complex element Address contains the address of a Contact, Organisation or Role.
    
    Parameters:
    
    values - A collection of Address instances
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withTelephoneFax
```
public Contact withTelephoneFax(TelephoneFax... values)
```
    Set the TelephoneFax
    Complex element TelephoneFax reflects the telephone and/or telefax number(s) of the Contact, Organisation or Role.
    
    Parameters:
    
    values - One or more instances of type TelephoneFax....
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withTelephoneFax
```
public Contact withTelephoneFax(Collection<TelephoneFax> values)
```
    Set the TelephoneFax
    Complex element TelephoneFax reflects the telephone and/or telefax number(s) of the Contact, Organisation or Role.
    
    Parameters:
    
    values - A collection of TelephoneFax instances
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withEMail
```
public Contact withEMail(EMail... values)
```
    Set the Email
    Complex element Email contains the email address of the Contact or Role.
    
    Parameters:
    
    values - One or more instances of type EMail....
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - withEMail
```
public Contact withEMail(Collection<EMail> values)
```
    Set the Email
    Complex element Email contains the email address of the Contact or Role.
    
    Parameters:
    
    values - A collection of EMail instances
    
    Returns:
    
    The current Contact object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this Contact instance configuration.
    
    Overrides:
    
    toString in class Common<Contact>
    
    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.
    Contact requires cls, Serial, EntryDateTime.
    Note that this method only checks for the presence of required information; this method does not validate the information format.
    
    Overrides:
    
    isSet in class Common<Contact>
    
    Returns:
    
    TRUE if required fields are set, otherwise FALSE

Class Contact

Field Summary

Fields inherited from class us.gov.dod.standard.ssrf._3_1.Common

Constructor Summary

Method Summary

Methods inherited from class us.gov.dod.standard.ssrf._3_1.Common

Methods inherited from class java.lang.Object

Constructor Detail

Contact

Method Detail

getEffectiveDate

setEffectiveDate

isSetEffectiveDate

getExpirationDate

setExpirationDate

isSetExpirationDate

getReviewDate

setReviewDate

isSetReviewDate

getTitleRank

setTitleRank

isSetTitleRank

getFirstName

setFirstName

isSetFirstName

getLastName

setLastName

isSetLastName

getAddress

isSetAddress

unsetAddress

getTelephoneFax

isSetTelephoneFax

unsetTelephoneFax

getEMail

isSetEMail

unsetEMail

withEffectiveDate

withEffectiveDate

withExpirationDate

withExpirationDate

withReviewDate

withReviewDate

withTitleRank

withFirstName

withLastName

withAddress

withAddress

withTelephoneFax

withTelephoneFax

withEMail

withEMail

toString

isSet