public class Message extends Common<Message>
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>
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 and Description |
---|
Message()
No arg constructor.
|
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.
|
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
public Message()
public S40 getName()
S40
instancepublic void setName(S40 value)
value
- a S40
instancepublic boolean isSetName()
public TString getSecondaryDatasets()
TString
data typepublic void setSecondaryDatasets(TString value)
value
- the SecondaryDatasets value in a TString
data typepublic boolean isSetSecondaryDatasets()
If configured this method also inspects the TString
wrapped value.
@Deprecated public Set<Serial> getDatasetRef()
getData()
instead.Serial
instancepublic boolean isSetDatasetRef()
public void unsetDatasetRef()
public Message withName(String value)
value
- An instances of type String
.public Message withSecondaryDatasets(ListCBO value)
value
- An instances of type ListCBO
.@Deprecated public Message withDatasetRef(Serial... values)
withData(Common...)
instead.values
- One or more instances of type DatasetRef...
.@Deprecated public Message withDatasetRef(Collection<Serial> values)
withData(Common...)
instead.values
- A collection of Serial
instancespublic String toString()
public boolean isSet()
public boolean isSetData()
public Message withData(Common<?>... values)
values
- An instances of type Common>
.public Message withData(Collection<Common<?>> values)
values
- An instances of type Common>
.public void prepare()
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.
public void postLoad(SSRF root)
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.
Copyright © 2016 OpenSSRF.org. All rights reserved.