Role (lib-openssrf-3.1.0 1.0.0 API)

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

All Implemented Interfaces:

Comparable<Role>
```
public class Role
extends Common<Role>
```
Role is the XML root for all parameters of a Role (position or role representing an organisational user of the system; also known as Job Account in the USA).
Sub-Elements are Address, Email, TelephoneFax
Example:
```
 <Role cls="U">
   <Serial cls="U">USA::JA:123</Serial>
   <EntryDateTime cls="U">2011-12-12T00:00:00Z</EntryDateTime>
   <Name cls="U">EUCOM FMFO</Name>
   <Country cls="U">USA</Country>
   <ContactRef cls="U">USA:EU:CN:1</ContactRef>
 </Role>
 
```
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

Role()
No arg constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Set<Address>`	`getAddress()` Get the Address
`Set<Contact>`	`getContact()` Get the ContactRef
`Set<Serial>`	`getContactRef()` Deprecated. SSRF references are managed automatically. Use `getContact()` instead.
`TString`	`getCountry()` Get the country to which the Role belongs.
`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.
`S50`	`getName()` Get the name or function of the Role.
`D`	`getReviewDate()` Get the date by which the dataset is to be reviewed.
`Set<TelephoneFax>`	`getTelephoneFax()` Get the TelephoneFax
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetAddress()` Determine if the Address is configured.
`boolean`	`isSetContact()` Determine if the contact field is configured.
`boolean`	`isSetContactRef()` Determine if the ContactRef is configured.
`boolean`	`isSetCountry()` Determine if the Country 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`	`isSetName()` Determine if the Name is configured.
`boolean`	`isSetReviewDate()` Determine if the ReviewDate is configured.
`boolean`	`isSetTelephoneFax()` Determine if the TelephoneFax is configured.
`void`	`postLoad(SSRF root)` Update the SSRF data type references in this Role record after loading from XML.
`void`	`prepare()` Update the SSRF data type references in this Role record.
`void`	`setCountry(TString value)` Set the country to which the Role belongs.
`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`	`setName(S50 value)` Set the name or function of the Role.
`void`	`setReviewDate(D value)` Set the date by which the dataset is to be reviewed.
`String`	`toString()` Get a string representation of this Role instance configuration.
`void`	`unsetAddress()` Clear the Address field.
`void`	`unsetContactRef()` Clear the ContactRef field.
`void`	`unsetEMail()` Clear the EMail field.
`void`	`unsetTelephoneFax()` Clear the TelephoneFax field.
`Role`	`withAddress(Address... values)` Set the Address
`Role`	`withAddress(Collection<Address> values)` Set the Address
`Role`	`withContact(Collection<Contact> values)` Set the ContactRef
`Role`	`withContact(Contact... values)` Set the ContactRef
`Role`	`withContactRef(Collection<Serial> values)` Deprecated. SSRF references are managed automatically. Use `withContact(Contact...)` instead.
`Role`	`withContactRef(Serial... values)` Deprecated. SSRF references are managed automatically. Use `withContact(Contact...)` instead.
`Role`	`withCountry(ListCCY value)` Set the country to which the Role belongs.
`Role`	`withEffectiveDate(Calendar value)` Set the date by which the dataset is to be operational or effective.
`Role`	`withEffectiveDate(Date value)` Set the date by which the dataset is to be operational or effective.
`Role`	`withEMail(Collection<EMail> values)` Set the Email
`Role`	`withEMail(EMail... values)` Set the Email
`Role`	`withExpirationDate(Calendar value)` Set the date at which the dataset will expire.
`Role`	`withExpirationDate(Date value)` Set the date at which the dataset will expire.
`Role`	`withName(String value)` Set the name or function of the Role.
`Role`	`withReviewDate(Calendar value)` Set the date by which the dataset is to be reviewed.
`Role`	`withReviewDate(Date value)` Set the date by which the dataset is to be reviewed.
`Role`	`withTelephoneFax(Collection<TelephoneFax> values)` Set the TelephoneFax
`Role`	`withTelephoneFax(TelephoneFax... values)` Set the TelephoneFax

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, 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
  - Role
```
public Role()
```
    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 indicates 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 indicates 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
  - getName
```
public S50 getName()
```
    Get the name or function of the Role. The name SHOULD be unique within the agency..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setName
```
public void setName(S50 value)
```
    Set the name or function of the Role. The name SHOULD be unique within the agency..
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetName
```
public boolean isSetName()
```
    Determine if the Name is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getCountry
```
public TString getCountry()
```
    Get the country to which the Role belongs. IMPORTANT NOTE: The Country is Optional in order to accommodate legacy data; however it SHOULD be filled in. The release of datasets to Roles is based upon matching nationalities; therefore a Role without a Country will not be able to receive datasets having a releasability caveat..
    
    Returns:
    
    the Country value in a TString data type
    
    Since:
    
    3.1.0
  - setCountry
```
public void setCountry(TString value)
```
    Set the country to which the Role belongs. IMPORTANT NOTE: The Country is Optional in order to accommodate legacy data; however it SHOULD be filled in. The release of datasets to Roles is based upon matching nationalities; therefore a Role without a Country will not be able to receive datasets having a releasability caveat..
    
    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
  - 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.
  - getContactRef
```
@Deprecated
public Set<Serial> getContactRef()
```
    Deprecated. SSRF references are managed automatically. Use getContact() instead.
    
    Get the ContactRef
    Complex element ContactRef references a Contact..
    
    Returns:
    
    a Serial instance
    
    Since:
    
    3.1.0
  - isSetContactRef
```
public boolean isSetContactRef()
```
    Determine if the ContactRef is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetContactRef
```
public void unsetContactRef()
```
    Clear the ContactRef field. This sets the field to null.
  - withEffectiveDate
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withEffectiveDate
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public Role 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 indicates 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 Role object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public Role 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 indicates 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 Role object instance.
    
    Since:
    
    3.1.0
  - withName
```
public Role withName(String value)
```
    Set the name or function of the Role. The name SHOULD be unique within the agency.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Role object instance.
    
    Since:
    
    3.1.0
  - withCountry
```
public Role withCountry(ListCCY value)
```
    Set the country to which the Role belongs. IMPORTANT NOTE: The Country is Optional in order to accommodate legacy data; however it SHOULD be filled in. The release of datasets to Roles is based upon matching nationalities; therefore a Role without a Country will not be able to receive datasets having a releasability caveat.
    
    Parameters:
    
    value - An instances of type ListCCY.
    
    Returns:
    
    The current Role object instance.
    
    Since:
    
    3.1.0
  - withAddress
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withAddress
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withTelephoneFax
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withTelephoneFax
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withEMail
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withEMail
```
public Role 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 Role object instance.
    
    Since:
    
    3.1.0
  - withContactRef
```
@Deprecated
public Role withContactRef(Serial... values)
```
    Deprecated. SSRF references are managed automatically. Use withContact(Contact...) instead.
    
    Set the ContactRef
    Complex element ContactRef references a Contact.
    
    Parameters:
    
    values - One or more instances of type ContactRef....
    
    Returns:
    
    The current Role object instance.
    
    Since:
    
    3.1.0
  - withContactRef
```
@Deprecated
public Role withContactRef(Collection<Serial> values)
```
    Deprecated. SSRF references are managed automatically. Use withContact(Contact...) instead.
    
    Set the ContactRef
    Complex element ContactRef references a Contact.
    
    Parameters:
    
    values - A collection of Serial instances
    
    Returns:
    
    The current Role object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this Role instance configuration.
    
    Overrides:
    
    toString in class Common<Role>
    
    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.
    Role requires cls, Serial, EntryDateTime and Name.
    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<Role>
    
    Returns:
    
    TRUE if required fields are set, otherwise FALSE
  - getContact
```
public Set<Contact> getContact()
```
    Get the ContactRef
    Complex element ContactRef references a Contact..
    
    Returns:
    
    a Contact instance
    
    Since:
    
    3.1.0
  - isSetContact
```
public boolean isSetContact()
```
    Determine if the contact field is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - withContact
```
public Role withContact(Contact... values)
```
    Set the ContactRef
    Complex element ContactRef references a Contact.
    
    Parameters:
    
    values - An instances of type Contact.
    
    Returns:
    
    The current Role object instance.
    
    Since:
    
    3.1.0
  - withContact
```
public Role withContact(Collection<Contact> values)
```
    Set the ContactRef
    Complex element ContactRef references a Contact.
    
    Parameters:
    
    values - An instances of type Contact.
    
    Returns:
    
    The current Role object instance.
    
    Since:
    
    3.1.0
  - prepare
```
public void prepare()
```
    Update the SSRF data type references in this Role record.
    This method builds the exported contactRef field with values from the transient contact field. This method should typically be called after the Role is configured and (optionally) before exporting an SSRF message.
    
    Overrides:
    
    prepare in class Common<Role>
    
    Since:
    
    3.1.0
  - postLoad
```
public void postLoad(SSRF root)
```
    Update the SSRF data type references in this Role record after loading from XML.
    This method builds the transient contact with values from the imported contactRef field. This method should typically be called after the Role is imported from XML.
    
    Overrides:
    
    postLoad in class Common<Role>
    
    Parameters:
    
    root - the SSRF root instance.
    
    Since:
    
    3.1.0

Class Role

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

Role

Method Detail

getEffectiveDate

setEffectiveDate

isSetEffectiveDate

getExpirationDate

setExpirationDate

isSetExpirationDate

getReviewDate

setReviewDate

isSetReviewDate

getName

setName

isSetName

getCountry

setCountry

isSetCountry

getAddress

isSetAddress

unsetAddress

getTelephoneFax

isSetTelephoneFax

unsetTelephoneFax

getEMail

isSetEMail

unsetEMail

getContactRef

isSetContactRef

unsetContactRef

withEffectiveDate

withEffectiveDate

withExpirationDate

withExpirationDate

withReviewDate

withReviewDate

withName

withCountry

withAddress

withAddress

withTelephoneFax

withTelephoneFax

withEMail

withEMail

withContactRef

withContactRef

toString

isSet

getContact

isSetContact

withContact

withContact

prepare

postLoad