us.gov.dod.standard.ssrf._3_1

Class Message

java.lang.Object

us.gov.dod.standard.ssrf._3_1.Common<Message>

us.gov.dod.standard.ssrf._3_1.Message

All Implemented Interfaces:

Comparable<Message>

public class Message
extends Common<Message>

Message describes the receipt and disposition of a group of Datasets in a single transmittal. The receiving system SHOULD verify the correct datasets were received. If a dataset fails validation, a separate Administrative dataset SHOULD be returned to the sender informing them of the error.

Sub-Element is DatasetRefs

Example:

 <Message cls="U">
   <Serial cls="U">TUR::MS:123</Serial>
   <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime>
   <Name cls="U">Results of Your 2012-01-05 Data Request</Name>
   <SecondaryDatasets cls="U">No</SecondaryDatasets>
   <DatasetRef cls="U">POL::AN:456<DatasetRef>
     <DatasetRef cls="U">DEU::AL:456<DatasetRef>
       <DatasetRef cls="U">NED::TX:456<DatasetRef>
         <DatasetRef cls="U">USA::RX:456<DatasetRef>
         </Message>
 

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
Message() No arg constructor.

Method Summary

Modifier and Type	Method and Description
Set<Common<?>>	getData() Get .
Set<Serial>	getDatasetRef() Deprecated. SSRF references are managed automatically. Use getData() instead.
S40	getName() Get a human-readable name for the message..
TString	getSecondaryDatasets() Get In Data Item SecondaryDatasets, indicate if datasets referenced by the primary dataset are included..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetData() Determine if the data field is configured.
boolean	isSetDatasetRef() Determine if the DatasetRef is configured.
boolean	isSetName() Determine if the Name is configured.
boolean	isSetSecondaryDatasets() Determine if the SecondaryDatasets is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this Message record after loading from XML.
void	prepare() Update the SSRF data type references in this Message record.
void	setName(S40 value) Set a human-readable name for the message..
void	setSecondaryDatasets(TString value) Set In Data Item SecondaryDatasets, indicate if datasets referenced by the primary dataset are included..
String	toString() Get a string representation of this Message instance configuration.
void	unsetDatasetRef() Clear the DatasetRef field.
Message	withData(Collection<Common<?>> values) Set
Message	withData(Common<?>... values) Set
Message	withDatasetRef(Collection<Serial> values) Deprecated. SSRF references are managed automatically. Use withData(Common...) instead.
Message	withDatasetRef(Serial... values) Deprecated. SSRF references are managed automatically. Use withData(Common...) instead.
Message	withName(String value) Set a human-readable name for the message.
Message	withSecondaryDatasets(ListCBO value) Set In Data Item SecondaryDatasets, indicate if datasets referenced by the primary dataset are included.

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

Message

public Message()

No arg constructor. Initializes the Common required fields.

Method Detail

getName

public S40 getName()

Get a human-readable name for the message..

Returns:

a S40 instance

Since:

3.1.0

setName

public void setName(S40 value)

Set a human-readable name for the message..

Parameters:

value - a S40 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

getSecondaryDatasets

public TString getSecondaryDatasets()

Get In Data Item SecondaryDatasets, indicate if datasets referenced by the primary dataset are included..

Returns:

the SecondaryDatasets value in a TString data type

Since:

3.1.0

setSecondaryDatasets

public void setSecondaryDatasets(TString value)

Set In Data Item SecondaryDatasets, indicate if datasets referenced by the primary dataset are included..

Parameters:

value - the SecondaryDatasets value in a TString data type

Since:

3.1.0

isSetSecondaryDatasets

public boolean isSetSecondaryDatasets()

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

getDatasetRef

@Deprecated
public Set<Serial> getDatasetRef()

Deprecated. SSRF references are managed automatically. Use getData() instead.

Get .

Returns:

a Serial instance

Since:

3.1.0

isSetDatasetRef

public boolean isSetDatasetRef()

Determine if the DatasetRef is configured.

Returns:

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

unsetDatasetRef

public void unsetDatasetRef()

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

withName

public Message withName(String value)

Set a human-readable name for the message.

Parameters:

value - An instances of type String.

Returns:

The current Message object instance.

Since:

3.1.0

withSecondaryDatasets

public Message withSecondaryDatasets(ListCBO value)

Set In Data Item SecondaryDatasets, indicate if datasets referenced by the primary dataset are included.

Parameters:

value - An instances of type ListCBO.

Returns:

The current Message object instance.

Since:

3.1.0

withDatasetRef

@Deprecated
public Message withDatasetRef(Serial... values)

Deprecated. SSRF references are managed automatically. Use withData(Common...) instead.

Set

Parameters:

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

Returns:

The current Message object instance.

Since:

3.1.0

withDatasetRef

@Deprecated
public Message withDatasetRef(Collection<Serial> values)

Deprecated. SSRF references are managed automatically. Use withData(Common...) instead.

Set

Parameters:

values - A collection of Serial instances

Returns:

The current Message object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this Message instance configuration.

Overrides:

toString in class Common<Message>

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.

Message 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<Message>

Returns:

TRUE if required fields are set, otherwise FALSE

getData

public Set<Common<?>> getData()

Get .

Returns:

a Common instance

Since:

3.1.0

isSetData

public boolean isSetData()

Determine if the data field is configured.

Returns:

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

withData

public Message withData(Common<?>... values)

Set

Parameters:

values - An instances of type Common.

Returns:

The current Message object instance.

Since:

3.1.0

withData

public Message withData(Collection<Common<?>> values)

Set

Parameters:

values - An instances of type Common.

Returns:

The current Message object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this Message record.

This method builds the exported datasetRef field with values from the transient data field. This method should typically be called after the Message is configured and (optionally) before exporting an SSRF message.

Overrides:

prepare in class Common<Message>

Since:

3.1.0

postLoad

public void postLoad(SSRF root)

Update the SSRF data type references in this Message record after loading from XML.

This method builds the transient data with values from the imported datasetRef field. This method should typically be called after the Message is imported from XML.

Overrides:

postLoad in class Common<Message>

Parameters:

root - the SSRF root instance.

Since:

3.1.0