ExternalReference (lib-openssrf-3.1.0 1.0.0 API)

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

All Implemented Interfaces:: Comparable<ExternalReference>

public class ExternalReference
extends Common<ExternalReference>

ExternalReference contains bibliographic or any other references applicable to the dataset except those placed in Derivative Classification Authority (Data element ClsDerived).

Example:

 <ExternalReference cls="U">
   <Serial cls="U">USA:AF:EX:123</Serial>
   <Type cls="U">Document</Type>
   <Title cls="U">plan 5027</Title>
   <Organisation cls="U">PACOM</Organisation>
   <Date cls="U">2000-04-27</Date>
   <ResourceLocator cls="U">USA-AF-EX-123.PDF</ResourceLocator>
 </ExternalReference>

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

ExternalReference()
No arg constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S50`	`getAlternateIdentifier()` Get any alternate identifier for the document as needed..
`S255`	`getAuthor()` Get the name of the author of the reference, if it cannot be covered by a ContactRef..
`D`	`getDate()` Get the publication date of the external reference.
`TString`	`getDocumentCls()` Get the classification level of the Reference..
`S50`	`getIdentifier()` Get any alternate identifier for the document as needed..
`TString`	`getIsAttached()` Get if the document, file or other "external" information is stored in attachment to this message..
`TString`	`getIsClassified()` Get if the referenced information contains any classified data..
`S50`	`getOrganisation()` Get the name of the Organisation that published the Reference, if it cannot be covered by a OrganisationRef.
`TString`	`getReferencedStage()` Get the spectrum certification stage associated with this information..
`TString`	`getRepeat()` Get In Data Item Repeat (US), indicate if the attached file should be repeatedly viewed / listened to..
`S255`	`getResourceLocator()` Get either the file name (including the extension) of the reference document when it is attached to the dataset, or an URL (Uniform Resource Locator) to find the document..
`S255`	`getTitle()` Get the full title of the document..
`TString`	`getType()` Get the type of information referenced by this external reference..
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetAlternateIdentifier()` Determine if the AlternateIdentifier is configured.
`boolean`	`isSetAuthor()` Determine if the Author is configured.
`boolean`	`isSetDate()` Determine if the Date is configured.
`boolean`	`isSetDocumentCls()` Determine if the DocumentCls is configured.
`boolean`	`isSetIdentifier()` Determine if the Identifier is configured.
`boolean`	`isSetIsAttached()` Determine if the IsAttached is configured.
`boolean`	`isSetIsClassified()` Determine if the IsClassified is configured.
`boolean`	`isSetOrganisation()` Determine if the Organisation is configured.
`boolean`	`isSetReferencedStage()` Determine if the ReferencedStage is configured.
`boolean`	`isSetRepeat()` Determine if the Repeat is configured.
`boolean`	`isSetResourceLocator()` Determine if the ResourceLocator is configured.
`boolean`	`isSetTitle()` Determine if the Title is configured.
`boolean`	`isSetType()` Determine if the Type is configured.
`void`	`setAlternateIdentifier(S50 value)` Set any alternate identifier for the document as needed..
`void`	`setAuthor(S255 value)` Set the name of the author of the reference, if it cannot be covered by a ContactRef..
`void`	`setDate(D value)` Set the publication date of the external reference.
`void`	`setDocumentCls(TString value)` Set the classification level of the Reference..
`void`	`setIdentifier(S50 value)` Set any alternate identifier for the document as needed..
`void`	`setIsAttached(TString value)` Set if the document, file or other "external" information is stored in attachment to this message..
`void`	`setIsClassified(TString value)` Set if the referenced information contains any classified data..
`void`	`setOrganisation(S50 value)` Set the name of the Organisation that published the Reference, if it cannot be covered by a OrganisationRef.
`void`	`setReferencedStage(TString value)` Set the spectrum certification stage associated with this information..
`void`	`setRepeat(TString value)` Set In Data Item Repeat (US), indicate if the attached file should be repeatedly viewed / listened to..
`void`	`setResourceLocator(S255 value)` Set either the file name (including the extension) of the reference document when it is attached to the dataset, or an URL (Uniform Resource Locator) to find the document..
`void`	`setTitle(S255 value)` Set the full title of the document..
`void`	`setType(TString value)` Set the type of information referenced by this external reference..
`String`	`toString()` Get a string representation of this ExternalReference instance configuration.
`ExternalReference`	`withAlternateIdentifier(String value)` Set any alternate identifier for the document as needed.
`ExternalReference`	`withAuthor(String value)` Set the name of the author of the reference, if it cannot be covered by a ContactRef.
`ExternalReference`	`withDate(Calendar value)` Set the publication date of the external reference
`ExternalReference`	`withDate(Date value)` Set the publication date of the external reference
`ExternalReference`	`withDocumentCls(ListCCL value)` Set the classification level of the Reference.
`ExternalReference`	`withIdentifier(String value)` Set any alternate identifier for the document as needed.
`ExternalReference`	`withIsAttached(ListCBO value)` Set if the document, file or other "external" information is stored in attachment to this message.
`ExternalReference`	`withIsClassified(ListCBO value)` Set if the referenced information contains any classified data.
`ExternalReference`	`withOrganisation(String value)` Set the name of the Organisation that published the Reference, if it cannot be covered by a OrganisationRef
`ExternalReference`	`withReferencedStage(ListCSG value)` Set the spectrum certification stage associated with this information.
`ExternalReference`	`withRepeat(ListCBO value)` Set In Data Item Repeat (US), indicate if the attached file should be repeatedly viewed / listened to.
`ExternalReference`	`withResourceLocator(String value)` Set either the file name (including the extension) of the reference document when it is attached to the dataset, or an URL (Uniform Resource Locator) to find the document.
`ExternalReference`	`withTitle(String value)` Set the full title of the document.
`ExternalReference`	`withType(ListCRE value)` Set the type of information referenced by this external reference.

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
  - ExternalReference
```
public ExternalReference()
```
    No arg constructor. Initializes the Common required fields.
- Method Detail
  - getType
```
public TString getType()
```
    Get the type of information referenced by this external reference..
    
    Returns:
    
    the Type value in a TString data type
    
    Since:
    
    3.1.0
  - setType
```
public void setType(TString value)
```
    Set the type of information referenced by this external reference..
    
    Parameters:
    
    value - the Type value in a TString data type
    
    Since:
    
    3.1.0
  - isSetType
```
public boolean isSetType()
```
    Determine if the Type 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
  - getDate
```
public D getDate()
```
    Get the publication date of the external reference.
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setDate
```
public void setDate(D value)
```
    Set the publication date of the external reference.
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetDate
```
public boolean isSetDate()
```
    Determine if the Date is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getIdentifier
```
public S50 getIdentifier()
```
    Get any alternate identifier for the document as needed..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setIdentifier
```
public void setIdentifier(S50 value)
```
    Set any alternate identifier for the document as needed..
    
    Parameters:
    
    value - a S50 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
  - getAlternateIdentifier
```
public S50 getAlternateIdentifier()
```
    Get any alternate identifier for the document as needed..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setAlternateIdentifier
```
public void setAlternateIdentifier(S50 value)
```
    Set any alternate identifier for the document as needed..
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetAlternateIdentifier
```
public boolean isSetAlternateIdentifier()
```
    Determine if the AlternateIdentifier is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getTitle
```
public S255 getTitle()
```
    Get the full title of the document..
    
    Returns:
    
    a S255 instance
    
    Since:
    
    3.1.0
  - setTitle
```
public void setTitle(S255 value)
```
    Set the full title of the document..
    
    Parameters:
    
    value - a S255 instance
    
    Since:
    
    3.1.0
  - isSetTitle
```
public boolean isSetTitle()
```
    Determine if the Title is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getAuthor
```
public S255 getAuthor()
```
    Get the name of the author of the reference, if it cannot be covered by a ContactRef..
    
    Returns:
    
    a S255 instance
    
    Since:
    
    3.1.0
  - setAuthor
```
public void setAuthor(S255 value)
```
    Set the name of the author of the reference, if it cannot be covered by a ContactRef..
    
    Parameters:
    
    value - a S255 instance
    
    Since:
    
    3.1.0
  - isSetAuthor
```
public boolean isSetAuthor()
```
    Determine if the Author is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getOrganisation
```
public S50 getOrganisation()
```
    Get the name of the Organisation that published the Reference, if it cannot be covered by a OrganisationRef.
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setOrganisation
```
public void setOrganisation(S50 value)
```
    Set the name of the Organisation that published the Reference, if it cannot be covered by a OrganisationRef.
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetOrganisation
```
public boolean isSetOrganisation()
```
    Determine if the Organisation is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getDocumentCls
```
public TString getDocumentCls()
```
    Get the classification level of the Reference..
    
    Returns:
    
    the DocumentCls value in a TString data type
    
    Since:
    
    3.1.0
  - setDocumentCls
```
public void setDocumentCls(TString value)
```
    Set the classification level of the Reference..
    
    Parameters:
    
    value - the DocumentCls value in a TString data type
    
    Since:
    
    3.1.0
  - isSetDocumentCls
```
public boolean isSetDocumentCls()
```
    Determine if the DocumentCls 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
  - getResourceLocator
```
public S255 getResourceLocator()
```
    Get either the file name (including the extension) of the reference document when it is attached to the dataset, or an URL (Uniform Resource Locator) to find the document..
    
    Returns:
    
    a S255 instance
    
    Since:
    
    3.1.0
  - setResourceLocator
```
public void setResourceLocator(S255 value)
```
    Set either the file name (including the extension) of the reference document when it is attached to the dataset, or an URL (Uniform Resource Locator) to find the document..
    
    Parameters:
    
    value - a S255 instance
    
    Since:
    
    3.1.0
  - isSetResourceLocator
```
public boolean isSetResourceLocator()
```
    Determine if the ResourceLocator is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getIsAttached
```
public TString getIsAttached()
```
    Get if the document, file or other "external" information is stored in attachment to this message..
    
    Returns:
    
    the IsAttached value in a TString data type
    
    Since:
    
    3.1.0
  - setIsAttached
```
public void setIsAttached(TString value)
```
    Set if the document, file or other "external" information is stored in attachment to this message..
    
    Parameters:
    
    value - the IsAttached value in a TString data type
    
    Since:
    
    3.1.0
  - isSetIsAttached
```
public boolean isSetIsAttached()
```
    Determine if the IsAttached 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
  - getIsClassified
```
public TString getIsClassified()
```
    Get if the referenced information contains any classified data..
    
    Returns:
    
    the IsClassified value in a TString data type
    
    Since:
    
    3.1.0
  - setIsClassified
```
public void setIsClassified(TString value)
```
    Set if the referenced information contains any classified data..
    
    Parameters:
    
    value - the IsClassified value in a TString data type
    
    Since:
    
    3.1.0
  - isSetIsClassified
```
public boolean isSetIsClassified()
```
    Determine if the IsClassified 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
  - getReferencedStage
```
public TString getReferencedStage()
```
    Get the spectrum certification stage associated with this information..
    
    Returns:
    
    the ReferencedStage value in a TString data type
    
    Since:
    
    3.1.0
  - setReferencedStage
```
public void setReferencedStage(TString value)
```
    Set the spectrum certification stage associated with this information..
    
    Parameters:
    
    value - the ReferencedStage value in a TString data type
    
    Since:
    
    3.1.0
  - isSetReferencedStage
```
public boolean isSetReferencedStage()
```
    Determine if the ReferencedStage 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
  - getRepeat
```
public TString getRepeat()
```
    Get In Data Item Repeat (US), indicate if the attached file should be repeatedly viewed / listened to..
    
    Returns:
    
    the Repeat value in a TString data type
    
    Since:
    
    3.1.0
  - setRepeat
```
public void setRepeat(TString value)
```
    Set In Data Item Repeat (US), indicate if the attached file should be repeatedly viewed / listened to..
    
    Parameters:
    
    value - the Repeat value in a TString data type
    
    Since:
    
    3.1.0
  - isSetRepeat
```
public boolean isSetRepeat()
```
    Determine if the Repeat 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
  - withType
```
public ExternalReference withType(ListCRE value)
```
    Set the type of information referenced by this external reference.
    
    Parameters:
    
    value - An instances of type ListCRE.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withDate
```
public ExternalReference withDate(Calendar value)
```
    Set the publication date of the external reference
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withDate
```
public ExternalReference withDate(Date value)
```
    Set the publication date of the external reference
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withIdentifier
```
public ExternalReference withIdentifier(String value)
```
    Set any alternate identifier for the document as needed.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withAlternateIdentifier
```
public ExternalReference withAlternateIdentifier(String value)
```
    Set any alternate identifier for the document as needed.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withTitle
```
public ExternalReference withTitle(String value)
```
    Set the full title of the document.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withAuthor
```
public ExternalReference withAuthor(String value)
```
    Set the name of the author of the reference, if it cannot be covered by a ContactRef.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withOrganisation
```
public ExternalReference withOrganisation(String value)
```
    Set the name of the Organisation that published the Reference, if it cannot be covered by a OrganisationRef
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withDocumentCls
```
public ExternalReference withDocumentCls(ListCCL value)
```
    Set the classification level of the Reference.
    
    Parameters:
    
    value - An instances of type ListCCL.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withResourceLocator
```
public ExternalReference withResourceLocator(String value)
```
    Set either the file name (including the extension) of the reference document when it is attached to the dataset, or an URL (Uniform Resource Locator) to find the document.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withIsAttached
```
public ExternalReference withIsAttached(ListCBO value)
```
    Set if the document, file or other "external" information is stored in attachment to this message.
    
    Parameters:
    
    value - An instances of type ListCBO.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withIsClassified
```
public ExternalReference withIsClassified(ListCBO value)
```
    Set if the referenced information contains any classified data.
    
    Parameters:
    
    value - An instances of type ListCBO.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withReferencedStage
```
public ExternalReference withReferencedStage(ListCSG value)
```
    Set the spectrum certification stage associated with this information.
    
    Parameters:
    
    value - An instances of type ListCSG.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - withRepeat
```
public ExternalReference withRepeat(ListCBO value)
```
    Set In Data Item Repeat (US), indicate if the attached file should be repeatedly viewed / listened to.
    
    Parameters:
    
    value - An instances of type ListCBO.
    
    Returns:
    
    The current ExternalReference object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this ExternalReference instance configuration.
    
    Overrides:
    
    toString in class Common<ExternalReference>
    
    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.
    ExternalReference requires cls, Serial, EntryDateTime and IsAttached.
    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<ExternalReference>
    
    Returns:
    
    TRUE if required fields are set, otherwise FALSE

Class ExternalReference

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

ExternalReference

Method Detail

getType

setType

isSetType

getDate

setDate

isSetDate

getIdentifier

setIdentifier

isSetIdentifier

getAlternateIdentifier

setAlternateIdentifier

isSetAlternateIdentifier

getTitle

setTitle

isSetTitle

getAuthor

setAuthor

isSetAuthor

getOrganisation

setOrganisation

isSetOrganisation

getDocumentCls

setDocumentCls

isSetDocumentCls

getResourceLocator

setResourceLocator

isSetResourceLocator

getIsAttached

setIsAttached

isSetIsAttached

getIsClassified

setIsClassified

isSetIsClassified

getReferencedStage

setReferencedStage

isSetReferencedStage

getRepeat

setRepeat

isSetRepeat

withType

withDate

withDate

withIdentifier

withAlternateIdentifier

withTitle

withAuthor

withOrganisation

withDocumentCls

withResourceLocator

withIsAttached

withIsClassified

withReferencedStage

withRepeat

toString

isSet