Dycode SimpleUBL UBL 2.0 Class Library

AttachedDocument Class

Remarks

A UBL 'wrapper' that allows a document of any kind to be packaged with the UBL document that references it.

Public Instance Constructors

AttachedDocument Constructor Default constructor.
AttachedDocument Copy Constructor Copy constructor. (Only C++)
AttachedDocument Constructor with required values Constructor with required values. (Only C++, .NET)

Public Instance Properties

 
Property UBL 2.0 Description
UBLVersionID0..1 UBL Version Identifier. The earliest version of the UBL 2 schema for this document type that defines all of the elements that might be encountered in the current instance. (Ex: 2.0.5)
UBLExtensions0..1 A container for all extensions present in the document.
CustomizationID0..1 Customization Identifier. Identifies a user-defined customization of UBL for a specific use. (Ex: NES)
ProfileID0..1 Profile Identifier. Identifies a user-defined profile of the customization of UBL being used. (Ex: BasicProcurementProcess)
ID1 Identifier. An identifier for the Attached Document; this ID is used as a reference by the UBL 'parent' document.
UUID0..1 UUID. A universally unique identifier for an instance of this ABIE.
IssueDate1 Issue Date. A date denoting when the Attached Document was issued.
IssueTime0..1 Issue Time. A time denoting when the Attached Document was issued.
Notes0..n Note. Contains any free-form text pertinent to the entire document or to the document message itself. This element may contain notes or any other similar information that is not contained explicitly in another structure.
DocumentTypeCode0..1 Document Type Code. Qualifies the type of document using a code set.
DocumentType0..1 Document Type. Qualifies types of document as text.
ParentDocumentID1 Document Identifier. Identifies the parent document.
ParentDocumentTypeCode0..1 Document Type Code. Identifies the type of parent document.
Signatures0..n Signature. Associates the Attached Document with zero or more signatures.
SenderParty1 Party. An association to the Party sending this document.
ReceiverParty1 Party. An association to the Party receiving this document.
Attachment1 Attachment. An attachment containing the document content.
 
XML XML Document in the string format.

Public Instance Methods

GetSchemaValidationErrors Validate document by schema. If document is not valid, return validation error.
GetSchemaValidationErrorsFromXML Validate XML by schema. If XML is not valid, return validation error.
GetValueValidationErrors Validate document by value. If document is not valid, return validation error.
GetValueValidationErrorsFromXML Validate XML by value. If XML is not valid, return validation error.
GetValidationErrors Validate document by schema and then by value. If document is not valid, return validation error.
GetValidationErrorsFromXML Validate XML by schema and then by value. If XML is not valid, return validation error.
Write Write document XML.
Read Read document XML.

Public Operators

Operator=Overloading of Assignment Operator. (Only C++)

Thread Safety

Public static members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

See Also

AttachedDocument Properties | Dycode.SimpleUBL | AttachedDocument Example