Interface IBarcodeProvider

Namespace

CMS.Plugin.BarcodeManagement.Abstractions

Assembly

CMS.Plugin.BarcodeManagement.Abstractions.dll

条码提供程序

public interface IBarcodeProvider

Methods

AnalysisAsync(Guid, string)

条码解析

Task<(bool IsSucceeded, string? ErrorMsg, List<(string Name, string Content, int Digit)>)> AnalysisAsync(Guid barcodeAnalysisId, string barcode)

Parameters

barcodeAnalysisId Guid

条码解析规则id

barcode string

条码

Returns

Task<(bool IsSucceeded, string ErrorMsg, List<(string Name, string Content, int Digit)>)>

IsSucceeded:是否解析成功,ErrorMsg:错误信息,Name:条码段名称,Content:条码段内容,Digit:位数

BarcodeAnalysisGetListAsync(GetBarcodeAnalysisesRequest, bool, CancellationToken)

获取条码解析规则列表

Task<PagedResult<BarcodeAnalysisModel>> BarcodeAnalysisGetListAsync(GetBarcodeAnalysisesRequest input, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

input GetBarcodeAnalysisesRequest

输入

includeDetails bool

cancellationToken CancellationToken

Returns

Task<PagedResult<BarcodeAnalysisModel>>

BarcodeGenerationGetListAsync(GetBarcodeGenerationsRequest, bool, CancellationToken)

获取条码生成规则列表

Task<PagedResult<BarcodeGenerationModel>> BarcodeGenerationGetListAsync(GetBarcodeGenerationsRequest input, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

input GetBarcodeGenerationsRequest

输入

includeDetails bool

cancellationToken CancellationToken

Returns

Task<PagedResult<BarcodeGenerationModel>>

BarcodeVerificationGetListAsync(GetBarcodeVerificationsRequest, bool, CancellationToken)

获取条码校验规则列表

Task<PagedResult<BarcodeVerificationModel>> BarcodeVerificationGetListAsync(GetBarcodeVerificationsRequest input, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

input GetBarcodeVerificationsRequest

输入

includeDetails bool

cancellationToken CancellationToken

Returns

Task<PagedResult<BarcodeVerificationModel>>

FindBarcodeAnalysisByIdAsync(Guid, bool, CancellationToken)

获取条码解析规则

Task<BarcodeAnalysisModel?> FindBarcodeAnalysisByIdAsync(Guid id, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

id Guid

条码解析规则id

includeDetails bool

cancellationToken CancellationToken

Returns

Task<BarcodeAnalysisModel>

FindBarcodeAnalysisByNameAsync(string, bool, CancellationToken)

获取条码解析规则

Task<BarcodeAnalysisModel?> FindBarcodeAnalysisByNameAsync(string name, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

name string

条码解析规则名称

includeDetails bool

cancellationToken CancellationToken

Returns

Task<BarcodeAnalysisModel>

FindBarcodeGenerationAsync(Guid, Guid, string, CancellationToken)

根据适用工序、产品查找条码生成规则

Task<BarcodeGenerationModel> FindBarcodeGenerationAsync(Guid workSectionId, Guid productId, string customerName, CancellationToken cancellationToken = default)

Parameters

workSectionId Guid

适用工序

productId Guid

适用产品

customerName string

适用客户

cancellationToken CancellationToken

取消操作标记

Returns

Task<BarcodeGenerationModel>

找到的条码生成规则，如果不存在则返回null

FindBarcodeGenerationAsync(Guid, Guid, CancellationToken)

根据适用工序、产品查找条码生成规则

Task<BarcodeGenerationModel> FindBarcodeGenerationAsync(Guid workSectionId, Guid productId, CancellationToken cancellationToken = default)

Parameters

workSectionId Guid

适用工序

productId Guid

适用产品

cancellationToken CancellationToken

取消操作标记

Returns

Task<BarcodeGenerationModel>

找到的条码生成规则，如果不存在则返回null

FindBarcodeGenerationByIdAsync(Guid, bool, CancellationToken)

获取条码生成规则

Task<BarcodeGenerationModel?> FindBarcodeGenerationByIdAsync(Guid id, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

id Guid

条码生成规则id

includeDetails bool

cancellationToken CancellationToken

Returns

Task<BarcodeGenerationModel>

FindBarcodeGenerationByNameAsync(string, bool, CancellationToken)

获取条码生成规则

Task<BarcodeGenerationModel?> FindBarcodeGenerationByNameAsync(string name, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

name string

条码生成规则名称

includeDetails bool

cancellationToken CancellationToken

Returns

Task<BarcodeGenerationModel>

FindBarcodeVerificationByIdAsync(Guid, bool, CancellationToken)

获取条码校验规则

Task<BarcodeVerificationModel?> FindBarcodeVerificationByIdAsync(Guid id, bool includeDetails = false, CancellationToken cancellationToken = default)

Parameters

id Guid

条码校验规则id

includeDetails bool

cancellationToken CancellationToken

Returns

Task<BarcodeVerificationModel>

FindBarcodeVerificationByNameAsync(string)

获取条码校验规则

Task<BarcodeVerificationModel?> FindBarcodeVerificationByNameAsync(string name)

Parameters

name string

条码校验规则名称

Returns

Task<BarcodeVerificationModel>

FindBarcodeVerificationByNameAsync(string, bool, CancellationToken)

获取条码校验规则

Task<BarcodeVerificationModel?> FindBarcodeVerificationByNameAsync(string name, bool includeDetails, CancellationToken cancellationToken = default)

Parameters

name string

条码校验规则名称

includeDetails bool

cancellationToken CancellationToken

Returns

Task<BarcodeVerificationModel>

GenerateAsync(Guid, string?, Guid?)

条码生成

Task<(bool IsSucceeded, string? ErrorMsg, string? Barcode)> GenerateAsync(Guid barcodeGenerationId, string? barcode = null, Guid? segmentId = null)

Parameters

barcodeGenerationId Guid

条码生成规则id

barcode string

条码

segmentId Guid?

工序Id

Returns

Task<(bool IsUsed, string UsedObject, string Error)>

IsSucceeded:是否生成成功,ErrorMsg:错误信息,Barcode:生成条码

GenerateAsync(Guid, string?, Guid?, Guid?)

条码生成

Task<(bool IsSucceeded, string? ErrorMsg, string? Barcode)> GenerateAsync(Guid barcodeGenerationId, string? barcode = null, Guid? workSectionId = null, Guid? workStationId = null)

Parameters

barcodeGenerationId Guid

条码生成规则id

barcode string

条码

workSectionId Guid?

workStationId Guid?

Returns

Task<(bool IsUsed, string UsedObject, string Error)>

IsSucceeded:是否生成成功,ErrorMsg:错误信息,Barcode:生成条码

VerifyAsync(Guid, string, bool, string?, string?, IEnumerable<string>?)

条码校验

Task<(bool IsPassed, string? ErrorMsg)> VerifyAsync(Guid barcodeVerificationId, string barcode, bool anyPass = false, string? materialCode = null, string? productModel = null, IEnumerable<string>? ignoreSegmentNames = null)

Parameters

barcodeVerificationId Guid

条码校验规则id

barcode string

条码

anyPass bool

任何一个通过即为通过

materialCode string

物料编号

productModel string

产品型号

ignoreSegmentNames IEnumerable<string>

忽略校验的条码段名称集合

Returns

Task<(bool IsUsed, string UsedObject)>

VerifyAsync(Guid, string, string?)

条码校验，（去除跟产品型号相关的校验）

Task<(bool IsPassed, string? ErrorMsg)> VerifyAsync(Guid barcodeVerificationId, string barcode, string? materialCode = null)

Parameters

barcodeVerificationId Guid

barcode string

materialCode string

Returns

Task<(bool IsUsed, string UsedObject)>