T
- The inheriting class typepublic abstract class Common<T> extends Object implements Comparable<T>
Sub-Elements are
CaseNum
, ExtReferenceRef
, Remarks
, SecurityClass
Modifier and Type | Field and Description |
---|---|
protected S50 |
approvedBy
US:ApprovedBy - Last Approval Person (Optional)
|
protected DT |
approvedDateTime
US:ApprovedDateTime - Last Approval Timestamp (Optional)
|
protected Set<CaseNum> |
caseNum
CaseNum (Optional)
|
protected ListCCL |
cls
cls - Classification (Required)
|
protected S500 |
description
Description - General Dataset Description (Optional)
|
protected Serial |
entryBy
EntryBy - Creator Role (Optional)
|
protected Role |
entryByRole
EntryBy - Creator Role (Optional)
|
protected DT |
entryDateTime
EntryDateTime - Entry Date/Time (Required)
|
protected Set<ExtReferenceRef> |
extReferenceRef
ExtReferenceRef (Optional)
|
protected Set<BigInteger> |
extReferences
extReferences - Links to External References (Optional)
|
protected String |
idref
idref - Data Item ID (Optional)
|
protected Serial |
lastChangeBy
LastChangeBy - Last Modifier Role (Optional)
|
protected Role |
lastChangeByRole
LastChangeBy - Last Modifier Role (Optional)
|
protected DT |
lastChangeDateTime
LastChangeDateTime - Latest Modification Date/Time (Optional)
|
protected S50 |
lastObservedBy
US:LastObservedBy - Last Observed By (Optional)
|
protected Serial |
lastReviewBy
LastReviewBy - Last Review Person RoleRef (Optional)
|
protected Role |
lastReviewByRole
LastReviewBy - Last Review Person RoleRef (Optional)
|
protected D |
lastReviewDate
LastReviewDate - Last Review Date (Optional)
|
protected String |
legacyReleasability
US:legacyReleasability - Legacy Releasability (Optional)
|
protected Serial |
modAllowedBy
ModAllowedBy - Role Allowed to Modify (Optional)
|
protected Role |
modAllowedByRole
ModAllowedBy - Role Allowed to Modify (Optional)
|
protected DT |
observedFirstDateTime
US:ObservedFirstDateTime - Initial Signal Detected Timestamp (Optional)
|
protected DT |
observedLastDateTime
US:ObservedLastDateTime - Last Signal Detected Timestamp (Optional)
|
protected Serial |
owner
Owner - Role which Owns the Dataset (Optional)
|
protected Role |
ownerRole
Owner - Role which Owns the Dataset (Optional)
|
protected String |
quality
US:quality - Data Quality (Optional)
|
protected String |
recommendedValue
US:recommendedValue - Recommended Value (Optional)
|
protected TString |
redacted
In Data Item Redacted (US), indicate if any original, or authoritative,
data was omitted.
|
protected Set<ListCCY> |
releasability
releasability - Releasability Markings (Optional)
|
protected Set<BigInteger> |
remarkRef
remarks - Links to Data Item Remarks (Optional)
|
protected Set<Remarks> |
remarks
remarks - additional information applicable to this data item.
|
protected SecurityClass |
securityClass
US:SecurityClass (Optional)
|
protected Serial |
serial
Serial - Serial (Required)
|
protected TString |
state
State - Dataset Status (Optional)
|
Constructor and Description |
---|
Common()
Abstract constructor for the Common class type.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object o)
Comparison is based alphabetically by class type, reverse chronologically
by entry date/time, then finally by alphabetically by the (semi-random)
serial number.
|
boolean |
equals(Object obj)
Equality is based upon the object serial number.
|
S50 |
getApprovedBy()
Get the identifier of the designated expert who last approved or accepted
the dataset.
|
DT |
getApprovedDateTime()
Get the last date and time, based on Greenwich Mean Time (GMT), that the
dataset was approved or accepted by a designated expert.
|
Set<CaseNum> |
getCaseNum()
Get the CaseNum
|
ListCCL |
getCls()
Get the classification of the current data item.
|
S500 |
getDescription()
Get a general description of the Dataset that is inheriting Common.
|
Serial |
getEntryBy()
Deprecated.
SSRF references are managed automatically. Use
getEntryByRole() instead. |
Role |
getEntryByRole()
Get the serial of the Role which is creating the current dataset.
|
DT |
getEntryDateTime()
Get the date and UTC Time the dataset was initially entered into the data
repository (e.g., FRRS for USA, SMIR for NATO).
|
Set<ExtReferenceRef> |
getExtReferenceRef()
Get the ExtReferenceRef
|
Set<BigInteger> |
getExtReferences()
Get a list of Conmmon/ExtReferenceRef idx values applicable to the current
data item.
|
String |
getIdref()
Get a unique identifier for each Data Item in the Dataset.
|
Serial |
getLastChangeBy()
Deprecated.
SSRF references are managed automatically. Use
getLastChangeByRole() instead. |
Role |
getLastChangeByRole()
Get the serial of the Role which last modified the current dataset.
|
DT |
getLastChangeDateTime()
Get the date and UTC Time the dataset was last modified.
|
S50 |
getLastObservedBy()
Get the identifier of the person or entity who last observed this Dataset.
|
Serial |
getLastReviewBy()
Deprecated.
SSRF references are managed automatically. Use
getLastReviewByRole() instead. |
Role |
getLastReviewByRole()
Get the Role reference serial of the person who last reviewed the dataset.
|
D |
getLastReviewDate()
Get the last date that the dataset was reviewed.
|
String |
getLegacyReleasability()
Get one or more special handling instructions in sentence format, not code
format.
|
Serial |
getModAllowedBy()
Deprecated.
SSRF references are managed automatically. Use
getModAllowedByRole() instead. |
Role |
getModAllowedByRole()
Get the serial of the Role which is authorized to modify the current
dataset.
|
DT |
getObservedFirstDateTime()
Get the date and time, based on Greenwich Mean Time (GMT), the subject
signal was first collected.
|
DT |
getObservedLastDateTime()
Get the date and time, based on Greenwich Mean Time (GMT), the subject
signal was last collected.
|
Serial |
getOwner()
Deprecated.
SSRF references are managed automatically. Use
getOwnerRole() instead. |
Role |
getOwnerRole()
Get the serial of the Role which is responsible for the accuracy of the
data content.
|
String |
getQuality()
Get one or more data quality indicator(s), separated by "|” (i.e., ASCII
character #124), for the contents of the associated Data Item For example,
"Outlier" | "Non-CodeList".
|
String |
getRecommendedValue()
Get a value that is most probably correct.
|
TString |
getRedacted()
Get In Data Item Redacted (US), indicate if any original, or authoritative,
data was omitted.
|
Set<ListCCY> |
getReleasability()
Get a list of country codes for which the current data item is releasable.
|
Set<BigInteger> |
getRemarkRef()
Get remarks - Links to Data Item Remarks (Optional)
|
Set<Remarks> |
getRemarks()
Get a list of Common/Remarks idx values applicable to the current data
item.
|
SecurityClass |
getSecurityClass()
Get the US:SecurityClass
|
Serial |
getSerial()
Get a unique Dataset identifier.
|
TString |
getState()
Get the state of the dataset.
|
int |
hashCode()
Hash code is based upon the object serial number.
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetApprovedBy()
Determine if the ApprovedBy is configured.
|
boolean |
isSetApprovedDateTime()
Determine if the ApprovedDateTime is configured.
|
boolean |
isSetCaseNum()
Determine if the CaseNum is configured.
|
boolean |
isSetCls()
Determine if the Cls is configured.
|
boolean |
isSetDescription()
Determine if the Description is configured.
|
boolean |
isSetEntryBy()
Determine if the EntryBy is configured.
|
boolean |
isSetEntryByRole()
Determine if the entryByRole field is configured.
|
boolean |
isSetEntryDateTime()
Determine if the EntryDateTime is configured.
|
boolean |
isSetExtReferenceRef()
Determine if the ExtReferenceRef is configured.
|
boolean |
isSetExtReferences()
Determine if the ExtReferences is configured.
|
boolean |
isSetIdref()
Determine if the Idref is configured.
|
boolean |
isSetLastChangeBy()
Determine if the LastChangeBy is configured.
|
boolean |
isSetLastChangeByRole()
Determine if the lastChangeByRole field is configured.
|
boolean |
isSetLastChangeDateTime()
Determine if the LastChangeDateTime is configured.
|
boolean |
isSetLastObservedBy()
Determine if the LastObservedBy is configured.
|
boolean |
isSetLastReviewBy()
Determine if the LastReviewBy is configured.
|
boolean |
isSetLastReviewByRole()
Determine if the lastReviewByRole field is configured.
|
boolean |
isSetLastReviewDate()
Determine if the LastReviewDate is configured.
|
boolean |
isSetLegacyReleasability()
Determine if the LegacyReleasability is configured.
|
boolean |
isSetModAllowedBy()
Determine if the ModAllowedBy is configured.
|
boolean |
isSetModAllowedByRole()
Determine if the modAllowedByRole field is configured.
|
boolean |
isSetObservedFirstDateTime()
Determine if the ObservedFirstDateTime is configured.
|
boolean |
isSetObservedLastDateTime()
Determine if the ObservedLastDateTime is configured.
|
boolean |
isSetOwner()
Determine if the Owner is configured.
|
boolean |
isSetOwnerRole()
Determine if the ownerRole field is configured.
|
boolean |
isSetQuality()
Determine if the Quality is configured.
|
boolean |
isSetRecommendedValue()
Determine if the RecommendedValue is configured.
|
boolean |
isSetRedacted()
Determine if the Redacted is configured.
|
boolean |
isSetReleasability()
Determine if the Releasability is configured.
|
boolean |
isSetRemarkRef()
Determine if the RemarkRef is configured.
|
boolean |
isSetRemarks()
Determine if the Remarks is configured.
|
boolean |
isSetSecurityClass()
Determine if the SecurityClass is configured.
|
boolean |
isSetSerial()
Determine if the Serial is configured.
|
boolean |
isSetState()
Determine if the State is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this Common record after loading
from XML.
|
void |
prepare()
Update the SSRF data type references in this Common record.
|
void |
setApprovedBy(S50 value)
Set the identifier of the designated expert who last approved or accepted
the dataset.
|
void |
setApprovedDateTime(DT value)
Set the last date and time, based on Greenwich Mean Time (GMT), that the
dataset was approved or accepted by a designated expert.
|
void |
setCls(ListCCL value)
Set the classification of the current data item.
|
void |
setDescription(S500 value)
Set a general description of the Dataset that is inheriting Common.
|
void |
setEntryBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setEntryByRole(Role) instead. |
void |
setEntryDateTime(DT value)
Set the date and UTC Time the dataset was initially entered into the data
repository (e.g., FRRS for USA, SMIR for NATO).
|
void |
setIdref(String value)
Set a unique identifier for each Data Item in the Dataset.
|
void |
setLastChangeBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setLastChangeByRole(Role) instead. |
void |
setLastChangeDateTime(DT value)
Set the date and UTC Time the dataset was last modified.
|
void |
setLastObservedBy(S50 value)
Set the identifier of the person or entity who last observed this Dataset.
|
void |
setLastReviewBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setLastReviewByRole(Role) instead. |
void |
setLastReviewDate(D value)
Set the last date that the dataset was reviewed.
|
void |
setLegacyReleasability(String value)
Set one or more special handling instructions in sentence format, not code
format.
|
void |
setModAllowedBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setModAllowedByRole(Role) instead. |
void |
setObservedFirstDateTime(DT value)
Set the date and time, based on Greenwich Mean Time (GMT), the subject
signal was first collected.
|
void |
setObservedLastDateTime(DT value)
Set the date and time, based on Greenwich Mean Time (GMT), the subject
signal was last collected.
|
void |
setOwner(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setOwnerRole(Role) instead. |
void |
setQuality(String value)
Set one or more data quality indicator(s), separated by "|” (i.e., ASCII
character #124), for the contents of the associated Data Item For example,
"Outlier" | "Non-CodeList".
|
void |
setRecommendedValue(String value)
Set a value that is most probably correct.
|
void |
setRedacted(TString value)
Set In Data Item Redacted (US), indicate if any original, or authoritative,
data was omitted.
|
void |
setSecurityClass(SecurityClass value)
Set the US:SecurityClass
|
void |
setSerial(Serial value)
Set a unique Dataset identifier.
|
void |
setState(TString value)
Set the state of the dataset.
|
String |
toString()
Get a string representation of this Common instance configuration.
|
void |
unsetCaseNum()
Clear the CaseNum field.
|
void |
unsetExtReferenceRef()
Clear the ExtReferenceRef field.
|
void |
unsetExtReferences()
Clear the ExtReferences field.
|
void |
unsetReleasability()
Clear the Releasability field.
|
void |
unsetRemarkRef()
Clear the RemarkRef field.
|
void |
unsetRemarks()
Clear the Remarks field.
|
T |
withApprovedBy(String value)
Set the identifier of the designated expert who last approved or accepted
the dataset.
|
T |
withApprovedDateTime(Calendar value)
Set the last date and time, based on Greenwich Mean Time (GMT), that the
dataset was approved or accepted by a designated expert.
|
T |
withApprovedDateTime(Date value)
Set the last date and time, based on Greenwich Mean Time (GMT), that the
dataset was approved or accepted by a designated expert.
|
T |
withCaseNum(CaseNum... values)
Set the CaseNum
|
T |
withCaseNum(Collection<CaseNum> values)
Set the CaseNum
|
T |
withCls(ListCCL value)
Set the classification of the current data item.
|
T |
withDescription(String value)
Set a general description of the Dataset that is inheriting Common.
|
T |
withEntryBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withEntryByRole(Role) instead. |
T |
withEntryByRole(Role value)
Set the serial of the Role which is creating the current dataset.
|
T |
withEntryDateTime(DT value)
Set the date and UTC Time the dataset was initially entered into the data
repository (e.g., FRRS for USA, SMIR for NATO).
|
T |
withExtReferenceRef(Collection<ExtReferenceRef> values)
Set the ExtReferenceRef
|
T |
withExtReferenceRef(ExtReferenceRef... values)
Set the ExtReferenceRef
|
T |
withExtReferences(BigInteger... values)
Set a list of Conmmon/ExtReferenceRef idx values applicable to the current
data item.
|
T |
withExtReferences(Collection<BigInteger> values)
Set a list of Conmmon/ExtReferenceRef idx values applicable to the current
data item.
|
T |
withExtReferences(ExtReferenceRef extReference)
Set a list of Conmmon/ExtReferenceRef idx values applicable to the current
data item.
|
T |
withIdref(String value)
Set a unique identifier for each Data Item in the Dataset.
|
T |
withLastChangeBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withLastChangeByRole(Role) instead. |
T |
withLastChangeByRole(Role value)
Set the serial of the Role which last modified the current dataset.
|
T |
withLastChangeDateTime(Calendar value)
Set the date and UTC Time the dataset was last modified.
|
T |
withLastChangeDateTime(Date value)
Set the date and UTC Time the dataset was last modified.
|
T |
withLastObservedBy(String value)
Set the identifier of the person or entity who last observed this Dataset.
|
T |
withLastReviewBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withLastReviewByRole(Role) instead. |
T |
withLastReviewByRole(Role value)
Set the Role reference serial of the person who last reviewed the dataset.
|
T |
withLastReviewDate(Calendar value)
Set the last date that the dataset was reviewed.
|
T |
withLastReviewDate(Date value)
Set the last date that the dataset was reviewed.
|
T |
withLegacyReleasability(String value)
Set one or more special handling instructions in sentence format, not code
format.
|
T |
withModAllowedBy(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withModAllowedByRole(Role) instead. |
T |
withModAllowedByRole(Role value)
Set the serial of the Role which is authorized to modify the current
dataset.
|
T |
withObservedFirstDateTime(Calendar value)
Set the date and time, based on Greenwich Mean Time (GMT), the subject
signal was first collected.
|
T |
withObservedFirstDateTime(Date value)
Set the date and time, based on Greenwich Mean Time (GMT), the subject
signal was first collected.
|
T |
withObservedLastDateTime(Calendar value)
Set the date and time, based on Greenwich Mean Time (GMT), the subject
signal was last collected.
|
T |
withObservedLastDateTime(Date value)
Set the date and time, based on Greenwich Mean Time (GMT), the subject
signal was last collected.
|
T |
withOwner(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withOwnerRole(Role) instead. |
T |
withOwnerRole(Role value)
Set the serial of the Role which is responsible for the accuracy of the
data content.
|
T |
withQuality(String value)
Set one or more data quality indicator(s), separated by "|” (i.e., ASCII
character #124), for the contents of the associated Data Item For example,
"Outlier" | "Non-CodeList".
|
T |
withRecommendedValue(String value)
Set a value that is most probably correct.
|
T |
withRedacted(ListCBO value)
Set In Data Item Redacted (US), indicate if any original, or authoritative,
data was omitted.
|
T |
withReleasability(Collection<ListCCY> values)
Set a list of country codes for which the current data item is releasable.
|
T |
withReleasability(ListCCY... values)
Set a list of country codes for which the current data item is releasable.
|
T |
withRemarkRef(BigInteger... values)
Set remarks - Links to Data Item Remarks (Optional)
|
T |
withRemarkRef(Collection<BigInteger> values)
Set remarks - Links to Data Item Remarks (Optional)
|
T |
withRemarkRef(Remarks remark)
Set a single remark - Links to Data Item Remarks (Optional)
|
T |
withRemarks(Collection<Remarks> values)
Set a list of Common/Remarks idx values applicable to the current data
item.
|
T |
withRemarks(Remarks... values)
Set a list of Common/Remarks idx values applicable to the current data
item.
|
T |
withSecurityClass(SecurityClass value)
Set the US:SecurityClass
|
T |
withSerial(Serial value)
Set a unique Dataset identifier.
|
T |
withState(ListCSU value)
Set the state of the dataset.
|
protected ListCCL cls
The classification of the current data item. This attribute is REQUIRED on each data item, even if the classification is "U".
Format is L:CCL
protected Serial serial
A unique Dataset identifier.
Serial is composed of four parts separated by colons (":"). The maximum total length is 29 characters (5+1+4+1+2+1+15). . Part 1 is the Country and is always REQUIRED. It contains one to five alphabetic uppercase characters representing either the ITU country code or the NATO Command code identifying the originator or organisation responsible for maintaining the dataset, as listed in Code List CCY. . Part 2 is the orgCode and is OPTIONAL. It may contain one to four alphanumeric characters (no spaces nor special characters) representing a code for an Organisation within the country or command. It will normally indicate the organisation responsible for maintaining the dataset. Domain naming is left at the discretion of each country, but should be managed by a central authority in the country to allow deconfliction and uniqueness. It should enable the location in the data repository where this dataset information is stored. . Part 3 is the Dataset Type and MUST contain a two-character code from the table in the Introduction section identifying the type of dataset (LO for a Location, etc). . Part 4 is a Serial Identifier and is always REQUIRED. It contains one to fifteen alphanumeric characters (including spaces and special characters), whose meaning is left at the discretion of each domain manager.
Format is pattern (S29)
Attribute group Initial (Required)
protected DT entryDateTime
The date and UTC Time the dataset was initially entered into the data repository (e.g., FRRS for USA, SMIR for NATO).
Format is DateTime
Attribute group Initial (Required)
protected S50 lastObservedBy
The identifier of the person or entity who last observed this Dataset.
Format is S50
protected DT observedFirstDateTime
The date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected.
Format is DateTime
protected DT observedLastDateTime
The date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected.
Format is DateTime
protected S50 approvedBy
The identifier of the designated expert who last approved or accepted the dataset.
Format is S50
protected DT approvedDateTime
The last date and time, based on Greenwich Mean Time (GMT), that the dataset was approved or accepted by a designated expert.
Format is DateTime
protected TString redacted
protected Serial entryBy
The serial of the Role which is creating the current dataset.
Format is pattern (S29)
Attribute group Initial (Required)
protected Serial owner
The serial of the Role which is responsible for the accuracy of the data content.
Format is pattern (S29)
Attribute group Initial (Required)
protected DT lastChangeDateTime
The date and UTC Time the dataset was last modified.
Format is DateTime
Attribute group LastChange (Optional)
protected Serial lastChangeBy
The serial of the Role which last modified the current dataset.
Format is pattern (S29)
Attribute group LastChange (Optional)
protected D lastReviewDate
The last date that the dataset was reviewed.
Format is Date
Attribute group LastReview (Optional)
protected Serial lastReviewBy
The Role reference serial of the person who last reviewed the dataset.
Format is pattern (S29)
Attribute group LastReview (Optional)
protected Serial modAllowedBy
The serial of the Role which is authorised to modify the current dataset.
Format is pattern (S29)
Divergence from SMADEF: Automated changes using ModAllowedBy are not permitted for use by USA systems.
protected TString state
The state of the dataset.
Format is L:CSU
protected S500 description
A general description of the Dataset that is inheriting Common.
Format is S500
protected SecurityClass securityClass
SecurityClass (US) contains the security classification from one or more data information sources.
protected Set<CaseNum> caseNum
CaseNum provides the capability to store multiple identifiers for a Dataset.
protected Set<ExtReferenceRef> extReferenceRef
ExtReferenceRef refers to an external reference defined in a dataset ExternalReference.
protected Set<Remarks> remarks
Remarks contains a free text field that provides a place to add additional information applicable to this data item.
In certain situations, technical data must be included in free text in order to clearly explain a technical or operational consideration; in these instances, the data must also be entered in the data element(s) specifically established for it.
protected Set<ListCCY> releasability
A list of country codes for which the current data item is releasable. For NATO, if this element is omitted, there is no releasability restriction for the data item. For the US, if this data item AND attribute US:legacy Releasability are both blank, there is no releasability restriction for the data item.
Format is List of L:CCY
protected Set<BigInteger> remarkRef
A list of Common/Remarks idx values applicable to the current data item.
Format is List of UN6
protected Set<BigInteger> extReferences
A list of Conmmon/ExtReferenceRef idx values applicable to the current data item.
Format is List of UN6
protected String legacyReleasability
One or more special handling instructions in sentence format, not code format. For example, "Approved for public release; distribution is unlimited". Multiple special handling instructions are separated by "|” (i.e., ASCII character #124).
Format is Memo
protected String quality
One or more data quality indicator(s), separated by "|” (i.e., ASCII character #124), for the contents of the associated Data Item For example, "Outlier" | "Non-CodeList".
Format is S255
protected String recommendedValue
A value that is most probably correct.
Format is Memo
protected String idref
A unique identifier for each Data Item in the Dataset. Within each Dataset, the idref value must be unique for every occurrence. If a received Dataset uses idrefs and it is expected that the Dataset will be exchanged, the idrefs should be considered required. If the receiving system is the permanent end of the line for the Dataset, the idrefs may be considered optional.
Format is S10
protected Role entryByRole
The serial of the Role which is creating the current dataset.
Format is pattern (S29)
Attribute group Initial (Required)
protected Role ownerRole
The serial of the Role which is responsible for the accuracy of the data content.
Format is pattern (S29)
Attribute group Initial (Required)
protected Role lastChangeByRole
The serial of the Role which last modified the current dataset.
Format is pattern (S29)
Attribute group LastChange (Optional)
protected Role lastReviewByRole
The Role reference serial of the person who last reviewed the dataset.
Format is pattern (S29)
Attribute group LastReview (Optional)
protected Role modAllowedByRole
The serial of the Role which is authorized to modify the current dataset.
Format is pattern (S29)
Divergence from SMADEF: Automated changes using ModAllowedBy are not permitted for use by USA systems.
public Common()
This constructor sets the minimum mandatory fields serial
with a
programmatically generated TSerial
instance and
entryDateTime
with the current DATETIME.
public S50 getLastObservedBy()
TS50
data typepublic void setLastObservedBy(S50 value)
value
- the LastObservedBy value in a TS50
data typepublic boolean isSetLastObservedBy()
public DT getObservedFirstDateTime()
DT
data typepublic void setObservedFirstDateTime(DT value)
value
- the ObservedFirstDateTime value in a DT
data typepublic boolean isSetObservedFirstDateTime()
public DT getObservedLastDateTime()
DT
data typepublic void setObservedLastDateTime(DT value)
value
- the ObservedLastDateTime value in a DT
data typepublic boolean isSetObservedLastDateTime()
public S50 getApprovedBy()
TS50
data typepublic void setApprovedBy(S50 value)
value
- the ApprovedBy value in a TS50
data typepublic boolean isSetApprovedBy()
public DT getApprovedDateTime()
DT
data typepublic void setApprovedDateTime(DT value)
value
- the ApprovedDateTime value in a DT
data typepublic boolean isSetApprovedDateTime()
public TString getRedacted()
TString
data typepublic void setRedacted(TString value)
value
- the Redacted value in a TString
data typepublic boolean isSetRedacted()
If configured this method also inspects the TString
wrapped value.
public Serial getSerial()
Serial is composed of four parts separated by colons (":"). The maximum total length is 29 characters (5+1+4+1+2+1+15). . Part 1 is the Country and is always REQUIRED. It contains one to five alphabetic uppercase characters representing either the ITU country code or the NATO Command code identifying the originator or organisation responsible for maintaining the dataset, as listed in Code List CCY. . Part 2 is the orgCode and is OPTIONAL. It may contain one to four alphanumeric characters (no spaces nor special characters) representing a code for an Organisation within the country or command. It will normally indicate the organisation responsible for maintaining the dataset. Domain naming is left at the discretion of each country, but should be managed by a central authority in the country to allow deconfliction and uniqueness. It should enable the location in the data repository where this dataset information is stored. . Part 3 is the Dataset Type and MUST contain a two-character code from the table in the Introduction section identifying the type of dataset (LO for a Location, etc). . Part 4 is a Serial Identifier and is always REQUIRED. It contains one to fifteen alphanumeric characters (including spaces and special characters), whose meaning is left at the discretion of each domain manager.
Serial
data typepublic void setSerial(Serial value)
Serial is composed of four parts separated by colons (":"). The maximum total length is 29 characters (5+1+4+1+2+1+15). . Part 1 is the Country and is always REQUIRED. It contains one to five alphabetic uppercase characters representing either the ITU country code or the NATO Command code identifying the originator or organisation responsible for maintaining the dataset, as listed in Code List CCY. . Part 2 is the orgCode and is OPTIONAL. It may contain one to four alphanumeric characters (no spaces nor special characters) representing a code for an Organisation within the country or command. It will normally indicate the organisation responsible for maintaining the dataset. Domain naming is left at the discretion of each country, but should be managed by a central authority in the country to allow deconfliction and uniqueness. It should enable the location in the data repository where this dataset information is stored. . Part 3 is the Dataset Type and MUST contain a two-character code from the table in the Introduction section identifying the type of dataset (LO for a Location, etc). . Part 4 is a Serial Identifier and is always REQUIRED. It contains one to fifteen alphanumeric characters (including spaces and special characters), whose meaning is left at the discretion of each domain manager.
value
- the Serial value in a Serial
data typepublic boolean isSetSerial()
public DT getEntryDateTime()
DT
data typepublic void setEntryDateTime(DT value)
value
- the EntryDateTime value in a DT
data typepublic boolean isSetEntryDateTime()
@Deprecated public Serial getEntryBy()
getEntryByRole()
instead.Serial
data type@Deprecated public void setEntryBy(Serial value)
#setEntryByRole(Role)
instead.value
- the EntryBy value in a Serial
data typepublic boolean isSetEntryBy()
@Deprecated public Serial getOwner()
getOwnerRole()
instead.Serial
data type@Deprecated public void setOwner(Serial value)
#setOwnerRole(Role)
instead.value
- the Owner value in a Serial
data typepublic boolean isSetOwner()
public DT getLastChangeDateTime()
DT
data typepublic void setLastChangeDateTime(DT value)
value
- the LastChangeDateTime value in a DT
data typepublic boolean isSetLastChangeDateTime()
@Deprecated public Serial getLastChangeBy()
getLastChangeByRole()
instead.Serial
data type@Deprecated public void setLastChangeBy(Serial value)
#setLastChangeByRole(Role)
instead.value
- the LastChangeBy value in a Serial
data typepublic boolean isSetLastChangeBy()
public D getLastReviewDate()
D
data typepublic void setLastReviewDate(D value)
value
- the LastReviewDate value in a D
data typepublic boolean isSetLastReviewDate()
@Deprecated public Serial getLastReviewBy()
getLastReviewByRole()
instead.Serial
data type@Deprecated public void setLastReviewBy(Serial value)
#setLastReviewByRole(Role)
instead.value
- the LastReviewBy value in a Serial
data typepublic boolean isSetLastReviewBy()
@Deprecated public Serial getModAllowedBy()
getModAllowedByRole()
instead.Serial
data type@Deprecated public void setModAllowedBy(Serial value)
#setModAllowedByRole(Role)
instead.value
- the ModAllowedBy value in a Serial
data typepublic boolean isSetModAllowedBy()
public TString getState()
TString
data typepublic void setState(TString value)
value
- the State value in a TString
data typepublic boolean isSetState()
If configured this method also inspects the TString
wrapped value.
public S500 getDescription()
TS500
data typepublic void setDescription(S500 value)
value
- the Description value in a TS500
data typepublic boolean isSetDescription()
public SecurityClass getSecurityClass()
Complex element SecurityClass (US) contains the security classification from one or more data information sources.
SecurityClass
instancepublic void setSecurityClass(SecurityClass value)
Complex element SecurityClass (US) contains the security classification from one or more data information sources.
value
- a SecurityClass
instancepublic boolean isSetSecurityClass()
public Set<CaseNum> getCaseNum()
Complex element CaseNum provides the capability to store multiple identifiers for a Dataset.
CaseNum
instancepublic boolean isSetCaseNum()
public void unsetCaseNum()
public Set<ExtReferenceRef> getExtReferenceRef()
Complex element ExtReferenceRef refers to an external reference defined in a dataset ExternalReference.
ExtReferenceRef
instancepublic boolean isSetExtReferenceRef()
public void unsetExtReferenceRef()
public Set<Remarks> getRemarks()
Remarks
instancepublic boolean isSetRemarks()
public void unsetRemarks()
public ListCCL getCls()
ListCCL
instancepublic void setCls(ListCCL value)
value
- a ListCCL
instancepublic boolean isSetCls()
public Set<ListCCY> getReleasability()
ListCCY
instancepublic boolean isSetReleasability()
public void unsetReleasability()
public Set<BigInteger> getRemarkRef()
A list of Common/Remarks idx values applicable to the current data item.
BigInteger
instancepublic boolean isSetRemarkRef()
public void unsetRemarkRef()
public Set<BigInteger> getExtReferences()
BigInteger
instancepublic boolean isSetExtReferences()
public void unsetExtReferences()
public String getLegacyReleasability()
String
instancepublic void setLegacyReleasability(String value)
value
- a String
instancepublic boolean isSetLegacyReleasability()
public String getQuality()
String
instancepublic void setQuality(String value)
value
- a String
instancepublic boolean isSetQuality()
public String getRecommendedValue()
String
instancepublic void setRecommendedValue(String value)
value
- a String
instancepublic boolean isSetRecommendedValue()
public String getIdref()
String
instancepublic void setIdref(String value)
value
- a String
instancepublic boolean isSetIdref()
public T withLastObservedBy(String value)
value
- An instances of type String
public T withObservedFirstDateTime(Calendar value)
value
- An instances of type Calendar
public T withObservedFirstDateTime(Date value)
value
- An instances of type Date
public T withObservedLastDateTime(Calendar value)
value
- An instances of type Calendar
public T withObservedLastDateTime(Date value)
value
- An instances of type Date
public T withApprovedBy(String value)
value
- An instances of type String
public T withApprovedDateTime(Calendar value)
value
- An instances of type Calendar
public T withApprovedDateTime(Date value)
value
- An instances of type Date
public T withRedacted(ListCBO value)
value
- An instances of type ListCBO
public T withSerial(Serial value)
Serial is composed of four parts separated by colons (":"). The maximum total length is 29 characters (5+1+4+1+2+1+15). . Part 1 is the Country and is always REQUIRED. It contains one to five alphabetic uppercase characters representing either the ITU country code or the NATO Command code identifying the originator or organisation responsible for maintaining the dataset, as listed in Code List CCY. . Part 2 is the orgCode and is OPTIONAL. It may contain one to four alphanumeric characters (no spaces nor special characters) representing a code for an Organisation within the country or command. It will normally indicate the organisation responsible for maintaining the dataset. Domain naming is left at the discretion of each country, but should be managed by a central authority in the country to allow deconfliction and uniqueness. It should enable the location in the data repository where this dataset information is stored. . Part 3 is the Dataset Type and MUST contain a two-character code from the table in the Introduction section identifying the type of dataset (LO for a Location, etc). . Part 4 is a Serial Identifier and is always REQUIRED. It contains one to fifteen alphanumeric characters (including spaces and special characters), whose meaning is left at the discretion of each domain manager.
value
- An instances of type Serial
public T withEntryDateTime(DT value)
value
- An instances of type DT
@Deprecated public T withEntryBy(Serial value)
withEntryByRole(Role)
instead.value
- An instances of type Serial
@Deprecated public T withOwner(Serial value)
withOwnerRole(Role)
instead.value
- An instances of type Serial
public T withLastChangeDateTime(Calendar value)
value
- An instances of type Calendar
public T withLastChangeDateTime(Date value)
value
- An instances of type Date
@Deprecated public T withLastChangeBy(Serial value)
withLastChangeByRole(Role)
instead.value
- An instances of type Serial
public T withLastReviewDate(Calendar value)
value
- An instances of type Calendar
public T withLastReviewDate(Date value)
value
- An instances of type Date
@Deprecated public T withLastReviewBy(Serial value)
withLastReviewByRole(Role)
instead.value
- An instances of type Serial
@Deprecated public T withModAllowedBy(Serial value)
withModAllowedByRole(Role)
instead.value
- An instances of type Serial
public T withState(ListCSU value)
value
- An instances of type ListCSU
public T withDescription(String value)
value
- An instances of type String
public T withSecurityClass(SecurityClass value)
Complex element SecurityClass (US) contains the security classification from one or more data information sources.
value
- An instances of type SecurityClass
public T withCaseNum(CaseNum... values)
Complex element CaseNum provides the capability to store multiple identifiers for a Dataset.
values
- One or more instances of type CaseNum...
public T withCaseNum(Collection<CaseNum> values)
Complex element CaseNum provides the capability to store multiple identifiers for a Dataset.
values
- A collection of CaseNum
instancespublic T withExtReferenceRef(ExtReferenceRef... values)
Complex element ExtReferenceRef refers to an external reference defined in a dataset ExternalReference.
values
- One or more instances of type ExtReferenceRef...
public T withExtReferenceRef(Collection<ExtReferenceRef> values)
Complex element ExtReferenceRef refers to an external reference defined in a dataset ExternalReference.
values
- A collection of ExtReferenceRef
instancespublic T withRemarks(Remarks... values)
values
- One or more instances of type Remarks...
public T withRemarks(Collection<Remarks> values)
values
- A collection of Remarks
instancespublic T withCls(ListCCL value)
value
- An instances of type ListCCL
public T withReleasability(ListCCY... values)
values
- One or more instances of type ListCCY...
public T withReleasability(Collection<ListCCY> values)
values
- A collection of Releasability
instancespublic T withRemarkRef(BigInteger... values)
A list of Common/Remarks idx values applicable to the current data item.
values
- One or more instances of type BigInteger...
public T withRemarkRef(Collection<BigInteger> values)
A list of Common/Remarks idx values applicable to the current data item.
values
- A collection of RemarkRef
instancespublic T withRemarkRef(Remarks remark)
A list of Common/Remarks idx values applicable to the current data item.
remark
- A collection of RemarkRef
instancespublic T withExtReferences(BigInteger... values)
values
- One or more instances of type BigInteger...
public T withExtReferences(Collection<BigInteger> values)
values
- A collection of ExtReferences
instancespublic T withExtReferences(ExtReferenceRef extReference)
extReference
- A collection of ExtReferences
instancespublic T withLegacyReleasability(String value)
value
- An instances of type String
public T withQuality(String value)
value
- An instances of type String
public T withRecommendedValue(String value)
value
- An instances of type String
public T withIdref(String value)
value
- An instances of type String
public String toString()
public boolean isSet()
Common
requires
EntryDateTime
, Serial
, cls
.
Note that this method only checks for the presence of required information; this method does not validate the information format.
public Role getEntryByRole()
Role
instancepublic boolean isSetEntryByRole()
public T withEntryByRole(Role value)
value
- An instances of type Role
public Role getOwnerRole()
Role
instancepublic boolean isSetOwnerRole()
public T withOwnerRole(Role value)
value
- An instances of type Role
public Role getLastChangeByRole()
Role
instancepublic boolean isSetLastChangeByRole()
public T withLastChangeByRole(Role value)
value
- An instances of type Role
public Role getLastReviewByRole()
Role
instancepublic boolean isSetLastReviewByRole()
public T withLastReviewByRole(Role value)
value
- An instances of type Role
public Role getModAllowedByRole()
Role
instancepublic boolean isSetModAllowedByRole()
public T withModAllowedByRole(Role value)
value
- An instances of type Role
public void prepare()
This method builds Common exported fields with values from their respective
transient object instance fields.:
entryBy
from
entryByRole
owner
from ownerRole
lastChangeBy
from lastChangeByRole
lastReviewBy
from lastReviewByRole
modAllowedBy
from modAllowedByRole
This method should typically be called after the Common is configured and (optionally) before exporting an SSRF message.
public void postLoad(SSRF root)
This method builds the transient entryByRole
with values from the
imported entryBy
field. This method should typically be called
after the Common is imported from XML.
root
- the SSRF root instancepublic int hashCode()
public boolean equals(Object obj)
public int compareTo(Object o)
compareTo
in interface Comparable<T>
o
- the other object instance to sortCopyright © 2016 OpenSSRF.org. All rights reserved.