Table of Contents

GOB Ship. Proposal Handler Interface

Provides document specific functionality that is needed for shipment proposal and warehouse shipment creation from shipment proposal.

Properties

Property Value
Object Type Interface
Object Subtype Normal
Accessibility Level Public

Procedures

IncludeInShipmentProposal()

Specifies if a document can be included in shipment proposal.

Syntax

[Boolean] := IncludeInShipmentProposal(DocumentHeaderId: RecordId)

Parameters

DocumentHeaderId
 Type: RecordId

The RecordID of a document header.

CopyAdditionalFieldsFromSourceDoc()

Transfers document-specific fields to a ship. proposal wksh. line.

Syntax

CopyAdditionalFieldsFromSourceDoc(DocumentId: RecordId, var ShipProposalWkshLine: Record "GOB Ship. Proposal Wksh. Line")

Parameters

DocumentId
 Type: RecordId

The RecordID of a document header or a document line.

ShipProposalWkshLine
 Type: Record "GOB Ship. Proposal Wksh. Line"

Document-specific fields are set in this variable. Other fields remain unchanged.

FilterDocumentLinesAdditionalFilters()

Filters the lines of a document header, specified in "DocumentHeaderId". Is intended to be used in cases, where additional filtering is needed, besides the primary key fields.

Syntax

FilterDocumentLinesAdditionalFilters(DocumentHeaderId: RecordId, var DocumentLine: RecordRef)

Parameters

DocumentHeaderId
 Type: RecordId

The RecordID of a document header.

DocumentLine
 Type: RecordRef

The filtered document lines for the document header.

GetQtyToShipFieldNo()

Returns the field number of the "Qty. to ship" field of the document line table of the implementing document type.

Syntax

[Integer] := GetQtyToShipFieldNo()

GetWhseShipmentAggregationCriteria()

Specifies the aggregation criteria for warehouse shipments. The field values are used to generate a string that is written to the warehouse shipment header and to identify matching shipments.

Syntax

GetWhseShipmentAggregationCriteria(var AggregationCriteriaFieldNos: List of [Integer])

Parameters

AggregationCriteriaFieldNos
 Type: List of [Integer]

A list that contains all field numbers that are used as aggregation criteria.

IsViableForAggregation()

Specifies if warehouse shipment aggregation is possible for the document in principle.

Syntax

[Boolean] := IsViableForAggregation()

CreateWhseShipment()

Creates a warehouse shipment for the document.

Syntax

[Boolean] := CreateWhseShipment(DocumentHeaderId: RecordId, var CreatedWhseShptHeaderNo: Code[20], var EIPGetSrcDocOutbndExt: Codeunit "GOB EIP GetSrcDocOutbnd Ext.")

Parameters

DocumentHeaderId
 Type: RecordId

The RecordID of a document header.

CreatedWhseShptHeaderNo
 Type: Code[20]

The created whse. shipment number, if successful.

EIPGetSrcDocOutbndExt
 Type: Codeunit "GOB EIP GetSrcDocOutbnd Ext."

The instance of this codeunit that is used to modify the standard whse. shipment creation behavior.

Return

Boolean

Returns true if shipment creation was successful.

CheckSourceDocumentHeaderViableForAggregation()

Checks the source document header of a warehouse shipment and returns true, if aggregation is allowed for the header. Specific field values or sub-tables are checked here.

Syntax

[Boolean] := CheckSourceDocumentHeaderViableForAggregation(DocumentHeaderId: RecordId)

Parameters

DocumentHeaderId
 Type: RecordId

SetPostingDate()

Sets the posting date of a document header.

Syntax

SetPostingDate(DocumentHeaderId: RecordId)

Parameters

DocumentHeaderId
 Type: RecordId

CheckWhseShipmentExists()

Returns true, if there are warehouse shipments for the document line.

Syntax

[Boolean] := CheckWhseShipmentExists(DocumentLineId: RecordId)

Parameters

DocumentLineId
 Type: RecordId

LookUpDocumentNoFilter()

Opens a lookup page, where the user can select multiple existing documents to create a filter.

Syntax

LookUpDocumentNoFilter(var DocumentNoFilter: Text, var ItemNoFilter: Text)

Parameters

DocumentNoFilter
 Type: Text

Returns a filter on the selected document numbers.

ItemNoFilter
 Type: Text

Returns a filter on the item numbers included in the selected documents.

IsSalesType()

Specifies if the implementing document is a sales document.

Syntax

[Boolean] := IsSalesType()

IsPurchaseType()

Specifies if the implementing document is a purchase document.

Syntax

[Boolean] := IsPurchaseType()

Return

Boolean

Return value of type Boolean.