public class Administrative extends Common<Administrative>
Sub-Elements are CodeList
, Dataset
Example: Rejecting an Assignment for which the recipient does not have the referenced Transmitter dataset:
<Administrative cls="U"> <Serial cls="U">DEU:NFA:DR:123</Serial> <MessageRef cls="U">DEU:NFA:MS:123</MessageRef> <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime> <Action cls="U">Missing Refs</Action> <Dataset> <Serial cls="U">USA::AS:456</Serial> <MissingRef cls="U">USA::TX:123</MissingRef> </Dataset> </Administrative>
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 |
---|
Administrative()
No arg constructor.
|
Modifier and Type | Method and Description |
---|---|
TString |
getAction()
Get the action which triggered the transmission, or to be performed upon
reception, of this dataset..
|
Set<CodeList> |
getCodeList()
Get the CodeList
|
Set<Dataset> |
getDataset()
Get the Dataset
|
Message |
getMessage()
Get the serial of the Message Dataset that is causing this response..
|
Serial |
getMessageRef()
Deprecated.
SSRF references are managed automatically. Use
getMessage() instead. |
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetAction()
Determine if the Action is configured.
|
boolean |
isSetCodeList()
Determine if the CodeList is configured.
|
boolean |
isSetDataset()
Determine if the Dataset is configured.
|
boolean |
isSetMessage()
Determine if the message field is configured.
|
boolean |
isSetMessageRef()
Determine if the MessageRef is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this Administrative record after
loading from XML.
|
void |
prepare()
Update the SSRF data type references in this Administrative record.
|
void |
setAction(TString value)
Set the action which triggered the transmission, or to be performed upon
reception, of this dataset..
|
void |
setMessageRef(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setMessage(Message) instead. |
String |
toString()
Get a string representation of this Administrative instance configuration.
|
void |
unsetCodeList()
Clear the CodeList field.
|
void |
unsetDataset()
Clear the Dataset field.
|
Administrative |
withAction(ListCDR value)
Set the action which triggered the transmission, or to be performed upon
reception, of this dataset.
|
Administrative |
withCodeList(CodeList... values)
Set the CodeList
|
Administrative |
withCodeList(Collection<CodeList> values)
Set the CodeList
|
Administrative |
withDataset(Collection<Dataset> values)
Set the Dataset
|
Administrative |
withDataset(Dataset... values)
Set the Dataset
|
Administrative |
withMessage(Message value)
Set the serial of the Message Dataset that is causing this response.
|
Administrative |
withMessageRef(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withMessage(Message) instead. |
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 Administrative()
public TString getAction()
TString
data typepublic void setAction(TString value)
value
- the Action value in a TString
data typepublic boolean isSetAction()
If configured this method also inspects the TString
wrapped value.
@Deprecated public Serial getMessageRef()
getMessage()
instead.Serial
instance@Deprecated public void setMessageRef(Serial value)
#setMessage(Message)
instead.value
- a Serial
instancepublic boolean isSetMessageRef()
public Set<Dataset> getDataset()
Complex element Dataset is used within an Administrative transaction to specify the identifier of the datasets on which the action must apply..
Dataset
instancepublic boolean isSetDataset()
public void unsetDataset()
public Set<CodeList> getCodeList()
Complex element CodeList contains the actions necessary to create or delete a code entry in a given Code List..
CodeList
instancepublic boolean isSetCodeList()
public void unsetCodeList()
public Administrative withAction(ListCDR value)
value
- An instances of type ListCDR
.@Deprecated public Administrative withMessageRef(Serial value)
withMessage(Message)
instead.value
- An instances of type Serial
.public Administrative withDataset(Dataset... values)
Complex element Dataset is used within an Administrative transaction to specify the identifier of the datasets on which the action must apply.
values
- One or more instances of type Dataset...
.public Administrative withDataset(Collection<Dataset> values)
Complex element Dataset is used within an Administrative transaction to specify the identifier of the datasets on which the action must apply.
values
- A collection of Dataset
instancespublic Administrative withCodeList(CodeList... values)
Complex element CodeList contains the actions necessary to create or delete a code entry in a given Code List.
values
- One or more instances of type CodeList...
.public Administrative withCodeList(Collection<CodeList> values)
Complex element CodeList contains the actions necessary to create or delete a code entry in a given Code List.
values
- A collection of CodeList
instancespublic String toString()
toString
in class Common<Administrative>
public boolean isSet()
Administrative
requires
cls
, Serial
, EntryDateTime
and Action
.
Note that this method only checks for the presence of required information; this method does not validate the information format.
isSet
in class Common<Administrative>
public Message getMessage()
Message
instancepublic boolean isSetMessage()
public Administrative withMessage(Message value)
value
- An instances of type Message
.public void prepare()
This method builds the exported messageRef
field with values from
the transient message
field. This method should typically be
called after the Administrative is configured and (optionally) before
exporting an SSRF message.
prepare
in class Common<Administrative>
public void postLoad(SSRF root)
This method builds the transient message
with values from the
imported messageRef
field. This method should typically be called
after the Administrative is imported from XML. * @param root the SSRF root
instance.
postLoad
in class Common<Administrative>
root
- the SSRF root instanceCopyright © 2016 OpenSSRF.org. All rights reserved.