Class NcDocumentType
A data type for a paper or electronic document.
Implements
Inherited Members
Namespace: NiemTypes
Assembly: EidoLib.dll
Syntax
[DataContract]
public class NcDocumentType : IEquatable<NcDocumentType>
Properties
AlternativeTitle
A title used as a substitute or alternative to the formal title of a document. NIEM reference is nc:DocumentAlternativeTitleText
Declaration
[DataMember(Name = "alternativeTitle")]
public List<NcTextType> AlternativeTitle { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A title used as a substitute or alternative to the formal title of a document. NIEM reference is nc:DocumentAlternativeTitleText |
Author
An entity primarily responsible for creating the intellectual content of the resource. NIEM reference is nc:DocumentAuthor
Declaration
[DataMember(Name = "author")]
public List<NcEntityType> Author { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | An entity primarily responsible for creating the intellectual content of the resource. NIEM reference is nc:DocumentAuthor |
Binary
A binary encoding of the content of a document. NIEM reference is nc:DocumentBinary
Declaration
[DataMember(Name = "binary")]
public List<NcBinaryType> Binary { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcBinaryType> | A binary encoding of the content of a document. NIEM reference is nc:DocumentBinary |
Category
A kind of document; a nature or genre of the content. NIEM reference is nc:DocumentCategoryText
Declaration
[DataMember(Name = "category")]
public List<NcTextType> Category { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A kind of document; a nature or genre of the content. NIEM reference is nc:DocumentCategoryText |
CategoryCode
A kind of document. NIEM reference is scr:DocumentCategoryCode
Declaration
[DataMember(Name = "categoryCode")]
public List<ScrDocumentCategoryCodeType> CategoryCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ScrDocumentCategoryCodeType> | A kind of document. NIEM reference is scr:DocumentCategoryCode |
CategoryDescription
A description of a kind of information in a document. NIEM reference is nc:DocumentCategoryDescriptionText
Declaration
[DataMember(Name = "categoryDescription")]
public List<NcTextType> CategoryDescription { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A description of a kind of information in a document. NIEM reference is nc:DocumentCategoryDescriptionText |
CategoryId
An identifier of a kind of information in a document. NIEM reference is nc:DocumentCategoryID
Declaration
[DataMember(Name = "categoryId")]
public List<NiemXsstring> CategoryId { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsstring> | An identifier of a kind of information in a document. NIEM reference is nc:DocumentCategoryID |
CategoryName
A name of a category of information in a document. NIEM reference is nc:DocumentCategoryName
Declaration
[DataMember(Name = "categoryName")]
public List<NcTextType> CategoryName { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A name of a category of information in a document. NIEM reference is nc:DocumentCategoryName |
Caveat
A warning or caution about the information. NIEM reference is nc:CaveatText
Declaration
[DataMember(Name = "caveat")]
public List<NcTextType> Caveat { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A warning or caution about the information. NIEM reference is nc:CaveatText |
ContentList
A list of the chapters, sections, or other divisions of a document. NIEM reference is nc:DocumentContentListText
Declaration
[DataMember(Name = "contentList")]
public List<NcTextType> ContentList { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A list of the chapters, sections, or other divisions of a document. NIEM reference is nc:DocumentContentListText |
Context
ncDocumentType JSON-LD context
Declaration
[DataMember(Name = "@context")]
public NcDocumentType.ContextEnum? Context { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<NcDocumentType.ContextEnum> | ncDocumentType JSON-LD context |
Contributor
An entity responsible for making contributions to the content of the resource. NIEM reference is nc:DocumentContributor
Declaration
[DataMember(Name = "contributor")]
public List<NcEntityType> Contributor { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | An entity responsible for making contributions to the content of the resource. NIEM reference is nc:DocumentContributor |
Country
A country being discussed in a document. NIEM reference is nc:DocumentCountry
Declaration
[DataMember(Name = "country")]
public List<NcCountryType> Country { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcCountryType> | A country being discussed in a document. NIEM reference is nc:DocumentCountry |
Coverage
A description of the extent or scope of the content of the resource. NIEM reference is nc:DocumentCoverageText
Declaration
[DataMember(Name = "coverage")]
public List<NcTextType> Coverage { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A description of the extent or scope of the content of the resource. NIEM reference is nc:DocumentCoverageText |
CoverageAddress
An extent or scope of the content of the resource. NIEM reference is nc:DocumentCoverageAddress
Declaration
[DataMember(Name = "coverageAddress")]
public List<NcAddressType> CoverageAddress { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcAddressType> | An extent or scope of the content of the resource. NIEM reference is nc:DocumentCoverageAddress |
CoverageDate
A date relating to an extent or scope of the content of the resource. NIEM reference is nc:DocumentCoverageDate
Declaration
[DataMember(Name = "coverageDate")]
public List<NcDateType> CoverageDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date relating to an extent or scope of the content of the resource. NIEM reference is nc:DocumentCoverageDate |
CreationDate
A date a document was created. NIEM reference is nc:DocumentCreationDate
Declaration
[DataMember(Name = "creationDate")]
public List<NcDateType> CreationDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date a document was created. NIEM reference is nc:DocumentCreationDate |
Description
A description of the content of a document. NIEM reference is nc:DocumentDescriptionText
Declaration
[DataMember(Name = "description")]
public List<NcTextType> Description { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A description of the content of a document. NIEM reference is nc:DocumentDescriptionText |
DispositionAuthorityName
A name of an authority designated to handle or process information in a document. NIEM reference is nc:DocumentDispositionAuthorityName
Declaration
[DataMember(Name = "dispositionAuthorityName")]
public List<NcTextType> DispositionAuthorityName { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A name of an authority designated to handle or process information in a document. NIEM reference is nc:DocumentDispositionAuthorityName |
DispositionInstruction
An instruction on how to handle or process information in a document. NIEM reference is nc:DocumentDispositionInstructionText
Declaration
[DataMember(Name = "dispositionInstruction")]
public List<NcTextType> DispositionInstruction { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | An instruction on how to handle or process information in a document. NIEM reference is nc:DocumentDispositionInstructionText |
DisputedReason
A reason why the accuracy of a document is disputed. NIEM reference is nc:DocumentDisputedReasonText
Declaration
[DataMember(Name = "disputedReason")]
public List<NcTextType> DisputedReason { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A reason why the accuracy of a document is disputed. NIEM reference is nc:DocumentDisputedReasonText |
EffectiveDate
A date in which the content or action becomes enforceable, active, or effective. NIEM reference is nc:DocumentEffectiveDate
Declaration
[DataMember(Name = "effectiveDate")]
public List<NcDateType> EffectiveDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date in which the content or action becomes enforceable, active, or effective. NIEM reference is nc:DocumentEffectiveDate |
EntrySubmitter
A person who contributed an entry in a document. NIEM reference is nc:DocumentEntrySubmitter
Declaration
[DataMember(Name = "entrySubmitter")]
public List<NcPersonType> EntrySubmitter { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcPersonType> | A person who contributed an entry in a document. NIEM reference is nc:DocumentEntrySubmitter |
ExpirationDate
A date after which the document is no longer valid. It may indicate a document should be removed from a registry or index. NIEM reference is nc:DocumentExpirationDate
Declaration
[DataMember(Name = "expirationDate")]
public List<NcDateType> ExpirationDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date after which the document is no longer valid. It may indicate a document should be removed from a registry or index. NIEM reference is nc:DocumentExpirationDate |
FileControlId
An identifier assigned to a document to locate it within a file control system. NIEM reference is nc:DocumentFileControlID
Declaration
[DataMember(Name = "fileControlId")]
public List<NiemXsstring> FileControlId { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsstring> | An identifier assigned to a document to locate it within a file control system. NIEM reference is nc:DocumentFileControlID |
FiledDate
A date a document was officially filed with an organization or agency. NIEM reference is nc:DocumentFiledDate
Declaration
[DataMember(Name = "filedDate")]
public List<NcDateType> FiledDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date a document was officially filed with an organization or agency. NIEM reference is nc:DocumentFiledDate |
FileExtension
A file extension of an electronic document. NIEM reference is nc:DocumentFileExtensionText
Declaration
[DataMember(Name = "fileExtension")]
public List<NcTextType> FileExtension { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A file extension of an electronic document. NIEM reference is nc:DocumentFileExtensionText |
FileName
A file name of an electronic document. NIEM reference is nc:DocumentFileName
Declaration
[DataMember(Name = "fileName")]
public List<NcTextType> FileName { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A file name of an electronic document. NIEM reference is nc:DocumentFileName |
Format
A file format, content type (e.g., a MIME type), or physical format of a document. NIEM reference is nc:DocumentFormatText
Declaration
[DataMember(Name = "format")]
public List<NcTextType> Format { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A file format, content type (e.g., a MIME type), or physical format of a document. NIEM reference is nc:DocumentFormatText |
FormatCategory
A kind of classification system used to define the specific format of a binary object or file. NIEM reference is nc:DocumentFormatCategoryText
Declaration
[DataMember(Name = "formatCategory")]
public List<NcTextType> FormatCategory { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A kind of classification system used to define the specific format of a binary object or file. NIEM reference is nc:DocumentFormatCategoryText |
GroupId
An identifier of a group to which a document belongs. NIEM reference is nc:DocumentGroupID
Declaration
[DataMember(Name = "groupId")]
public List<NiemXsstring> GroupId { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsstring> | An identifier of a group to which a document belongs. NIEM reference is nc:DocumentGroupID |
Identification
An identification that references a document. NIEM reference is nc:DocumentIdentification
Declaration
[DataMember(Name = "identification")]
public List<NcIdentificationType> Identification { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcIdentificationType> | An identification that references a document. NIEM reference is nc:DocumentIdentification |
InformationCutOffDate
A date after which contributions to the content of a document will no longer be accepted. NIEM reference is nc:DocumentInformationCutOffDate
Declaration
[DataMember(Name = "informationCutOffDate")]
public List<NcDateType> InformationCutOffDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date after which contributions to the content of a document will no longer be accepted. NIEM reference is nc:DocumentInformationCutOffDate |
IntelligenceCategoryCode
A nature or genre of the resource. NIEM reference is nc:DocumentIntelligenceCategoryCode
Declaration
[DataMember(Name = "intelligenceCategoryCode")]
public List<DodJcsPub20DocumentIntelligenceCategoryCodeType> IntelligenceCategoryCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<DodJcsPub20DocumentIntelligenceCategoryCodeType> | A nature or genre of the resource. NIEM reference is nc:DocumentIntelligenceCategoryCode |
IsApproved
True if a document has been approved; false otherwise. NIEM reference is nc:DocumentApprovedIndicator
Declaration
[DataMember(Name = "isApproved")]
public List<NiemXsboolean> IsApproved { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if a document has been approved; false otherwise. NIEM reference is nc:DocumentApprovedIndicator |
IsCopyright
True if a document is copyrighted; false otherwise. NIEM reference is nc:DocumentCopyrightIndicator
Declaration
[DataMember(Name = "isCopyright")]
public List<NiemXsboolean> IsCopyright { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if a document is copyrighted; false otherwise. NIEM reference is nc:DocumentCopyrightIndicator |
IsDisputed
True if the accuracy of a document is disputed; false otherwise. NIEM reference is nc:DocumentDisputedIndicator
Declaration
[DataMember(Name = "isDisputed")]
public List<NiemXsboolean> IsDisputed { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if the accuracy of a document is disputed; false otherwise. NIEM reference is nc:DocumentDisputedIndicator |
IsEuDataPrivacy
True if the data is protected under the EU Data Protection Regulation 2016-679 and should be treated differently; false otherwise. NIEM reference is nc:DocumentEUDataPrivacyIndicator
Declaration
[DataMember(Name = "isEuDataPrivacy")]
public List<NiemXsboolean> IsEuDataPrivacy { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if the data is protected under the EU Data Protection Regulation 2016-679 and should be treated differently; false otherwise. NIEM reference is nc:DocumentEUDataPrivacyIndicator |
IsPermanentRecord
True if a document is to be kept as a permanent record; false otherwise. NIEM reference is nc:DocumentPermanentRecordIndicator
Declaration
[DataMember(Name = "isPermanentRecord")]
public List<NiemXsboolean> IsPermanentRecord { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if a document is to be kept as a permanent record; false otherwise. NIEM reference is nc:DocumentPermanentRecordIndicator |
IsPrivacyAct
True if a document is categorized as containing personal information subject to protection by the Privacy Act; false otherwise. NIEM reference is nc:DocumentPrivacyActIndicator
Declaration
[DataMember(Name = "isPrivacyAct")]
public List<NiemXsboolean> IsPrivacyAct { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if a document is categorized as containing personal information subject to protection by the Privacy Act; false otherwise. NIEM reference is nc:DocumentPrivacyActIndicator |
IssuanceDate
A date a document was issued. NIEM reference is nc:DocumentIssuanceDate
Declaration
[DataMember(Name = "issuanceDate")]
public List<NcDateType> IssuanceDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date a document was issued. NIEM reference is nc:DocumentIssuanceDate |
IssuanceLocation
A location from which a document was issued. NIEM reference is nc:DocumentIssuanceLocation
Declaration
[DataMember(Name = "issuanceLocation")]
public List<NcLocationType> IssuanceLocation { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcLocationType> | A location from which a document was issued. NIEM reference is nc:DocumentIssuanceLocation |
IsVital
True if a document is categorized as a vital record by the originating agency; false otherwise. NIEM reference is nc:DocumentVitalIndicator
Declaration
[DataMember(Name = "isVital")]
public List<NiemXsboolean> IsVital { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsboolean> | True if a document is categorized as a vital record by the originating agency; false otherwise. NIEM reference is nc:DocumentVitalIndicator |
ItAugmentation
Additional information about a document. NIEM reference is it:DocumentAugmentation
Declaration
[DataMember(Name = "itAugmentation")]
public List<ItDocumentAugmentationType> ItAugmentation { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ItDocumentAugmentationType> | Additional information about a document. NIEM reference is it:DocumentAugmentation |
JAugmentation
Additional information about a document. NIEM reference is j:DocumentAugmentation
Declaration
[DataMember(Name = "jAugmentation")]
public List<JDocumentAugmentationType> JAugmentation { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<JDocumentAugmentationType> | Additional information about a document. NIEM reference is j:DocumentAugmentation |
Keyword
A significant word or phrase that describes the overall content of a document or its main topic. NIEM reference is nc:DocumentKeywordText
Declaration
[DataMember(Name = "keyword")]
public List<NcTextType> Keyword { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A significant word or phrase that describes the overall content of a document or its main topic. NIEM reference is nc:DocumentKeywordText |
LanguageCode
A language of the content of the resource. NIEM reference is nc:DocumentLanguageCode
Declaration
[DataMember(Name = "languageCode")]
public List<Iso6393LanguageCodeType> LanguageCode { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Iso6393LanguageCodeType> | A language of the content of the resource. NIEM reference is nc:DocumentLanguageCode |
LastModifiedDate
A date a document was last changed. NIEM reference is nc:DocumentLastModifiedDate
Declaration
[DataMember(Name = "lastModifiedDate")]
public List<NcDateType> LastModifiedDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date a document was last changed. NIEM reference is nc:DocumentLastModifiedDate |
Location
A location of a physical document. NIEM reference is nc:DocumentLocation
Declaration
[DataMember(Name = "location")]
public List<NcLocationType> Location { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcLocationType> | A location of a physical document. NIEM reference is nc:DocumentLocation |
LocationUri
A location of an electronic representation of a document. NIEM reference is nc:DocumentLocationURI
Declaration
[DataMember(Name = "locationUri")]
public List<NiemXsanyURI> LocationUri { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsanyURI> | A location of an electronic representation of a document. NIEM reference is nc:DocumentLocationURI |
ManagementCyclePeriod
A review or update cycle period for a document. NIEM reference is nc:DocumentManagementCyclePeriodText
Declaration
[DataMember(Name = "managementCyclePeriod")]
public List<NcTextType> ManagementCyclePeriod { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A review or update cycle period for a document. NIEM reference is nc:DocumentManagementCyclePeriodText |
MediaCategory
A kind of class that describes the media format of a document. NIEM reference is nc:DocumentMediaCategoryText
Declaration
[DataMember(Name = "mediaCategory")]
public List<NcTextType> MediaCategory { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A kind of class that describes the media format of a document. NIEM reference is nc:DocumentMediaCategoryText |
Medium
A material or physical carrier for storing a document. NIEM reference is nc:DocumentMediumText
Declaration
[DataMember(Name = "medium")]
public List<NcTextType> Medium { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A material or physical carrier for storing a document. NIEM reference is nc:DocumentMediumText |
OtherRecipient
A name of additional addressees. NIEM reference is nc:DocumentOtherRecipient
Declaration
[DataMember(Name = "otherRecipient")]
public List<NcEntityType> OtherRecipient { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | A name of additional addressees. NIEM reference is nc:DocumentOtherRecipient |
PostDate
A date a document is entered or posted to an information system or network; used when the date of posting is different from the date on which a document was officially filed. NIEM reference is nc:DocumentPostDate
Declaration
[DataMember(Name = "postDate")]
public List<NcDateType> PostDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date a document is entered or posted to an information system or network; used when the date of posting is different from the date on which a document was officially filed. NIEM reference is nc:DocumentPostDate |
PublicationDate
A date of the first public dissemination of the content in any media. NIEM reference is nc:DocumentPublicationDate
Declaration
[DataMember(Name = "publicationDate")]
public List<NcDateType> PublicationDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date of the first public dissemination of the content in any media. NIEM reference is nc:DocumentPublicationDate |
ReceivedDate
A date a transmitted document was received. NIEM reference is nc:DocumentReceivedDate
Declaration
[DataMember(Name = "receivedDate")]
public List<NcDateType> ReceivedDate { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDateType> | A date a transmitted document was received. NIEM reference is nc:DocumentReceivedDate |
Recipient
An entity that is a target or intended recipient of a document. NIEM reference is nc:DocumentRecipient
Declaration
[DataMember(Name = "recipient")]
public List<NcEntityType> Recipient { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | An entity that is a target or intended recipient of a document. NIEM reference is nc:DocumentRecipient |
RelatedResource
A reference to another document or resource related to the document. NIEM reference is nc:DocumentRelatedResourceText
Declaration
[DataMember(Name = "relatedResource")]
public List<NcTextType> RelatedResource { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A reference to another document or resource related to the document. NIEM reference is nc:DocumentRelatedResourceText |
Rights
A right held in and over the resource. Rights are the constraints applied to assure the protection of privacy or intellectual property, and any special restrictions, limitations or warning on using a shared resource. NIEM reference is nc:DocumentRightsText
Declaration
[DataMember(Name = "rights")]
public List<NcTextType> Rights { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A right held in and over the resource. Rights are the constraints applied to assure the protection of privacy or intellectual property, and any special restrictions, limitations or warning on using a shared resource. NIEM reference is nc:DocumentRightsText |
Sensitivity
A characterization of the sensitivity, security, or privacy level of a document. NIEM reference is nc:DocumentSensitivityText
Declaration
[DataMember(Name = "sensitivity")]
public List<NcTextType> Sensitivity { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A characterization of the sensitivity, security, or privacy level of a document. NIEM reference is nc:DocumentSensitivityText |
SequenceId
An identifier that determines the document order in a set of related documents. NIEM reference is nc:DocumentSequenceID
Declaration
[DataMember(Name = "sequenceId")]
public List<NiemXsstring> SequenceId { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NiemXsstring> | An identifier that determines the document order in a set of related documents. NIEM reference is nc:DocumentSequenceID |
SoftwareName
A name of a computer application used to process a document. NIEM reference is nc:DocumentSoftwareName
Declaration
[DataMember(Name = "softwareName")]
public List<NcSoftwareNameType> SoftwareName { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcSoftwareNameType> | A name of a computer application used to process a document. NIEM reference is nc:DocumentSoftwareName |
Source
An entity that was the source of a document. NIEM reference is nc:DocumentSource
Declaration
[DataMember(Name = "source")]
public List<NcEntityType> Source { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | An entity that was the source of a document. NIEM reference is nc:DocumentSource |
SourceText
A source from which the content of a document is derived. NIEM reference is nc:DocumentSourceText
Declaration
[DataMember(Name = "sourceText")]
public List<NcTextType> SourceText { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A source from which the content of a document is derived. NIEM reference is nc:DocumentSourceText |
Status
A status of a document. NIEM reference is nc:DocumentStatus
Declaration
[DataMember(Name = "status")]
public List<NcStatusType> Status { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcStatusType> | A status of a document. NIEM reference is nc:DocumentStatus |
StatusDetails
A classification of status of a document. NIEM reference is nc:DocumentStatusDetails
Declaration
[DataMember(Name = "statusDetails")]
public List<NcDocumentStatusDetailsType> StatusDetails { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcDocumentStatusDetailsType> | A classification of status of a document. NIEM reference is nc:DocumentStatusDetails |
Subject
A main topic of a document. NIEM reference is nc:DocumentSubjectText
Declaration
[DataMember(Name = "subject")]
public List<NcTextType> Subject { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A main topic of a document. NIEM reference is nc:DocumentSubjectText |
SubmissionAmount
A fee or price required to submit a document. NIEM reference is nc:DocumentSubmissionAmount
Declaration
[DataMember(Name = "submissionAmount")]
public List<NcAmountType> SubmissionAmount { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcAmountType> | A fee or price required to submit a document. NIEM reference is nc:DocumentSubmissionAmount |
Submitter
An entity responsible for making the resource available. NIEM reference is nc:DocumentSubmitter
Declaration
[DataMember(Name = "submitter")]
public List<NcEntityType> Submitter { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcEntityType> | An entity responsible for making the resource available. NIEM reference is nc:DocumentSubmitter |
Summary
A short description of the subject, content, and key points of a document. NIEM reference is nc:DocumentSummaryText
Declaration
[DataMember(Name = "summary")]
public List<NcTextType> Summary { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A short description of the subject, content, and key points of a document. NIEM reference is nc:DocumentSummaryText |
SupplementalMarking
A marking made on a document that is not part of the original content and that was added after a document was finalized. NIEM reference is nc:DocumentSupplementalMarkingText
Declaration
[DataMember(Name = "supplementalMarking")]
public List<NcTextType> SupplementalMarking { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A marking made on a document that is not part of the original content and that was added after a document was finalized. NIEM reference is nc:DocumentSupplementalMarkingText |
Title
A name given to a document. NIEM reference is nc:DocumentTitleText
Declaration
[DataMember(Name = "title")]
public List<NcTextType> Title { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<NcTextType> | A name given to a document. NIEM reference is nc:DocumentTitleText |
Methods
Equals(NcDocumentType)
Returns true if NcDocumentType instances are equal
Declaration
public bool Equals(NcDocumentType other)
Parameters
Type | Name | Description |
---|---|---|
NcDocumentType | other | Instance of NcDocumentType to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | Object to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Overrides
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | Hash code |
Overrides
ToJson()
Returns the JSON string presentation of the object
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
System.String | JSON string presentation of the object |
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String presentation of the object |
Overrides
Operators
Equality(NcDocumentType, NcDocumentType)
Declaration
public static bool operator ==(NcDocumentType left, NcDocumentType right)
Parameters
Type | Name | Description |
---|---|---|
NcDocumentType | left | |
NcDocumentType | right |
Returns
Type | Description |
---|---|
System.Boolean |
Inequality(NcDocumentType, NcDocumentType)
Declaration
public static bool operator !=(NcDocumentType left, NcDocumentType right)
Parameters
Type | Name | Description |
---|---|---|
NcDocumentType | left | |
NcDocumentType | right |
Returns
Type | Description |
---|---|
System.Boolean |