The ICatalogueRequest type exposes the following members.

Methods

  NameDescription
Public methodAddApplicableTerritAddr
Add a new 'Address' entry. Address (ASBIE). An association to the territory (regions, country, city, etc.) to which the requested Catalogue will apply. Expressed as an Address.
Public methodAddCatalogueRequestLine
Add a new 'Catalogue Request Line' entry. Catalogue Request Line (ASBIE). An association to specific Catalogue Lines for the catalogue requested.
Public methodAddDescription
Add a new 'Description' entry. Description (BBIE). Describes the Catalogue Request.
Public methodAddDocumentRef
Add a new 'Document Reference' entry. Document Reference (ASBIE). An association to other documents.
Public methodAddNote
Add a new 'Note' entry. Note (BBIE). Free-form text applying to the Catalogue Request. This element may contain notes or any other similar information that is not contained explicitly in another structure.
Public methodAddReferencedContract
Add a new 'Contract' entry. Contract (ASBIE). An association to a framework agreement or contract.
Public methodAddReqClassificatScheme
Add a new 'Classification Scheme' entry. Classification Scheme (ASBIE). An association to classification categories for the Catalogue requested.
Public methodAddValidityPeriod
Add a new 'Period' entry. Period (ASBIE). The period assigned by the Catalogue Managing Party during which the information in the Catalogue requested is to be effective. This may be given as start and end dates or a duration.
Public methodAssignStyleSheet
Assigns a XSLT stylesheet to the document.
Public methodClearApplicableTerritAddrs
Removes all 'Address' entries. Address (ASBIE). An association to the territory (regions, country, city, etc.) to which the requested Catalogue will apply. Expressed as an Address.
Public methodClearCatalogueRequestLines
Removes all 'Catalogue Request Line' entries. Catalogue Request Line (ASBIE). An association to specific Catalogue Lines for the catalogue requested.
Public methodClearDescriptions
Removes all 'Description' entries. Description (BBIE). Describes the Catalogue Request.
Public methodClearDocumentRefs
Removes all 'Document Reference' entries. Document Reference (ASBIE). An association to other documents.
Public methodClearNotes
Removes all 'Note' entries. Note (BBIE). Free-form text applying to the Catalogue Request. This element may contain notes or any other similar information that is not contained explicitly in another structure.
Public methodClearReferencedContracts
Removes all 'Contract' entries. Contract (ASBIE). An association to a framework agreement or contract.
Public methodClearReqClassificatSchemes
Removes all 'Classification Scheme' entries. Classification Scheme (ASBIE). An association to classification categories for the Catalogue requested.
Public methodClearValidityPeriods
Removes all 'Period' entries. Period (ASBIE). The period assigned by the Catalogue Managing Party during which the information in the Catalogue requested is to be effective. This may be given as start and end dates or a duration.
Public methodGetApplicableTerritAddr
Gets a 'Address' entry. Address (ASBIE). An association to the territory (regions, country, city, etc.) to which the requested Catalogue will apply. Expressed as an Address.
Public methodGetApplicableTerritAddrCount
Gets the number of 'Address' entries in the container object. Address (ASBIE). An association to the territory (regions, country, city, etc.) to which the requested Catalogue will apply. Expressed as an Address.
Public methodGetCatalogueRequestLine
Gets a 'Catalogue Request Line' entry. Catalogue Request Line (ASBIE). An association to specific Catalogue Lines for the catalogue requested.
Public methodGetCatalogueRequestLineCount
Gets the number of 'Catalogue Request Line' entries in the container object. Catalogue Request Line (ASBIE). An association to specific Catalogue Lines for the catalogue requested.
Public methodGetDescription
Gets a 'Description' entry. Description (BBIE). Describes the Catalogue Request.
Public methodGetDescriptionCount
Gets the number of 'Description' entries in the container object. Description (BBIE). Describes the Catalogue Request.
Public methodGetDocumentAsBinary
Gets the document as binary data (UTF-8 encoded).
Public methodGetDocumentAsText
Gets the document as a string (UTF-8 encoded).
Public methodGetDocumentRef
Gets a 'Document Reference' entry. Document Reference (ASBIE). An association to other documents.
Public methodGetDocumentRefCount
Gets the number of 'Document Reference' entries in the container object. Document Reference (ASBIE). An association to other documents.
Public methodGetNote
Gets a 'Note' entry. Note (BBIE). Free-form text applying to the Catalogue Request. This element may contain notes or any other similar information that is not contained explicitly in another structure.
Public methodGetNoteCount
Gets the number of 'Note' entries in the container object. Note (BBIE). Free-form text applying to the Catalogue Request. This element may contain notes or any other similar information that is not contained explicitly in another structure.
Public methodGetReferencedContract
Gets a 'Contract' entry. Contract (ASBIE). An association to a framework agreement or contract.
Public methodGetReferencedContractCount
Gets the number of 'Contract' entries in the container object. Contract (ASBIE). An association to a framework agreement or contract.
Public methodGetReqClassificatScheme
Gets a 'Classification Scheme' entry. Classification Scheme (ASBIE). An association to classification categories for the Catalogue requested.
Public methodGetReqClassificatSchemeCount
Gets the number of 'Classification Scheme' entries in the container object. Classification Scheme (ASBIE). An association to classification categories for the Catalogue requested.
Public methodGetValidityPeriod
Gets a 'Period' entry. Period (ASBIE). The period assigned by the Catalogue Managing Party during which the information in the Catalogue requested is to be effective. This may be given as start and end dates or a duration.
Public methodGetValidityPeriodCount
Gets the number of 'Period' entries in the container object. Period (ASBIE). The period assigned by the Catalogue Managing Party during which the information in the Catalogue requested is to be effective. This may be given as start and end dates or a duration.
Public methodRead
Reads the document from file.
Public methodRemoveApplicableTerritAddr
Removes a 'Address' entry. Address (ASBIE). An association to the territory (regions, country, city, etc.) to which the requested Catalogue will apply. Expressed as an Address.
Public methodRemoveCatalogueRequestLine
Removes a 'Catalogue Request Line' entry. Catalogue Request Line (ASBIE). An association to specific Catalogue Lines for the catalogue requested.
Public methodRemoveDescription
Removes a 'Description' entry. Description (BBIE). Describes the Catalogue Request.
Public methodRemoveDocumentRef
Removes a 'Document Reference' entry. Document Reference (ASBIE). An association to other documents.
Public methodRemoveNote
Removes a 'Note' entry. Note (BBIE). Free-form text applying to the Catalogue Request. This element may contain notes or any other similar information that is not contained explicitly in another structure.
Public methodRemoveReferencedContract
Removes a 'Contract' entry. Contract (ASBIE). An association to a framework agreement or contract.
Public methodRemoveReqClassificatScheme
Removes a 'Classification Scheme' entry. Classification Scheme (ASBIE). An association to classification categories for the Catalogue requested.
Public methodRemoveValidityPeriod
Removes a 'Period' entry. Period (ASBIE). The period assigned by the Catalogue Managing Party during which the information in the Catalogue requested is to be effective. This may be given as start and end dates or a duration.
Public methodResetContractorCustomerParty
Resets the node.
Public methodResetCustomizationID
Resets the node.
Public methodResetID
Resets the node.
Public methodResetItemUpdateRequestIndicator
Resets the node.
Public methodResetLineCountNumeric
Resets the node.
Public methodResetName
Resets the node.
Public methodResetPricingUpdateRequestIndicator
Resets the node.
Public methodResetProfileID
Resets the node.
Public methodResetProviderParty
Resets the node.
Public methodResetReceiverParty
Resets the node.
Public methodResetRequestedCatalogueReference
Resets the node.
Public methodResetRequestedLanguageID
Resets the node.
Public methodResetRequestedLanguageLocaleCode
Resets the node.
Public methodResetRequestedLanguageName
Resets the node.
Public methodResetSellerSupplierParty
Resets the node.
Public methodResetTradingTerms
Resets the node.
Public methodResetUBLExtensions
Resets the node.
Public methodResetUBLVersionID
Resets the node.
Public methodResetUUID
Resets the node.
Public methodSetDocument
Sets the document from an object. The object can be a string or a binary array.
Public methodSetOutputEncoding
Sets the desired output encoding. An empty string resets it to its default (normally UTF-8).
Public methodWrite
Writes the document to file.

Properties

  NameDescription
Public propertyContractorCustomerParty
Customer Party (ASBIE). The Customer Party responsible for the contract to which the Catalogue relates.
Public propertyContractorCustomerPartySet
Checks if the property has been set or not.
Public propertyCustomizationID
Customization Identifier (BBIE). Identifies a user-defined customization of UBL for a specific use.
Public propertyCustomizationIDSet
Checks if the property has been set or not.
Public propertyID
Identifier (BBIE). An identifier for the Catalogue Request assigned by the Catalogue Managing Party.
Public propertyIDSet
Checks if the property has been set or not.
Public propertyIssueDate
Issue Date (BBIE). The date assigned by the Catalogue Managing Party on which the Catalogue was requested.
Public propertyIssueTime
Issue Time (BBIE). The time assigned by the Catalogue Managing Party at which the Catalogue was requested.
Public propertyItemUpdateRequestIndicator
Indicator (BBIE). The indicator requesting an update of the item specifications.
Public propertyItemUpdateRequestIndicatorSet
Checks if the property has been set or not.
Public propertyLineCountNumeric
Line Count (BBIE). The number of lines in the document.
Public propertyLineCountNumericSet
Checks if the property has been set or not.
Public propertyName
Name (BBIE). A name given to the Catalogue Request.
Public propertyNameSet
Checks if the property has been set or not.
Public propertyNamespaceUri
Gets the namespace URI of this document.
Public propertyPricingUpdateRequestIndicator
Indicator (BBIE). The indicator requesting a pricing update.
Public propertyPricingUpdateRequestIndicatorSet
Checks if the property has been set or not.
Public propertyProfileID
Profile Identifier (BBIE). Identifies a user-defined profile of the subset of UBL being used.
Public propertyProfileIDSet
Checks if the property has been set or not.
Public propertyProviderParty
Party (ASBIE). An association to the Catalogue Provider Party.
Public propertyProviderPartySet
Checks if the property has been set or not.
Public propertyReceiverParty
Party (ASBIE). An association to the Catalogue Receiver Party.
Public propertyReceiverPartySet
Checks if the property has been set or not.
Public propertyRequestedCatalogueReference
Catalogue Reference (ASBIE). An association to a specific Catalogue; used if the Catalogue Request is for an update.
Public propertyRequestedCatalogueReferenceSet
Checks if the property has been set or not.
Public propertyRequestedLanguageID
A combination of types: Identifier (BBIE). An identifier for a language, expressed as a code.
Public propertyRequestedLanguageIDSet
Checks if the property has been set or not.
Public propertyRequestedLanguageLocaleCode
A combination of types: Locale Code (BBIE). The locale where the language is used, expressed as a code.
Public propertyRequestedLanguageLocaleCodeSet
Checks if the property has been set or not.
Public propertyRequestedLanguageName
A combination of types: Name (BBIE). The name of the language.
Public propertyRequestedLanguageNameSet
Checks if the property has been set or not.
Public propertySellerSupplierParty
Supplier Party (ASBIE). The Supplier Party responsible for the contract to which the Catalogue relates.
Public propertySellerSupplierPartySet
Checks if the property has been set or not.
Public propertyTradingTerms
Trading Terms (ASBIE). An association to trading terms.
Public propertyTradingTermsSet
Checks if the property has been set or not.
Public propertyUBLExtensions
().
Public propertyUBLExtensionsSet
Checks if the property has been set or not.
Public propertyUBLVersionID
UBL Version Identifier (BBIE). 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.
Public propertyUBLVersionIDSet
Checks if the property has been set or not.
Public propertyUUID
UUID (BBIE). A universally unique identifier for an instance of this ABIE.
Public propertyUUIDSet
Checks if the property has been set or not.

See Also