Interface IDocumentDataService

Namespace

Ascon.Polynom.Web.Api.Data.Interfaces.Repository

Assembly

Ascon.Polynom.Web.Api.Data.dll

Представляет репозиторий для работы с документами.

public interface IDocumentDataService : ILocateableDataService<IDocument>, IBaseDataService<IDocument>, IDataService<IDocument>, IDataService

Inherited Members

ILocateableDataService<IDocument>.GetByLocationAsync(string, CancellationToken)

ILocateableDataService<IDocument>.GetDefaultLocationAsync(IIdentifiableObject, CancellationToken)

IBaseDataService<IDocument>.GetByIdAsync(IGetByIdRequest, CancellationToken)

Methods

CreateAsync(ICreateDocumentRequest, CancellationToken)

Создаёт новый документ.

Task<IDocument> CreateAsync(ICreateDocumentRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateDocumentRequest

Идентификатор родительской группы.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<IDocument>

CreateWithValuesAsync(ICreateDocumentWithValuesRequest, CancellationToken)

Создаёт новый документ с параметрами.

Task<IDocument> CreateWithValuesAsync(ICreateDocumentWithValuesRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateDocumentWithValuesRequest

Запрос создания документа с параметрами.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<IDocument>

DeleteAsync(IDeleteRequest, CancellationToken)

Удаляет документ.

Task DeleteAsync(IDeleteRequest request, CancellationToken cancellationToken)

Parameters

request IDeleteRequest

Идентификатор удаляемого документа.

cancellationToken CancellationToken

Токен отмены.

Returns

Task

DeleteManyAsync(IDeleteManyRequest, CancellationToken)

Удаляет список документов.

Task<IDeleteManyResponse> DeleteManyAsync(IDeleteManyRequest request, CancellationToken cancellationToken)

Parameters

request IDeleteManyRequest

Идентификаторы удаляемых документов.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<IDeleteManyResponse>

GetByDocumentGroupAsync(IIdentifierRequest, CancellationToken)

Возвращает документы, принадлежащие группе документов.

Task<List<IDocument>> GetByDocumentGroupAsync(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

cancellationToken CancellationToken

Токен отмены.

Returns

Task<List<IDocument>>

GetByElementAsync(IIdentifierRequest, CancellationToken)

Возвращает собственные документы элемента.

Task<List<IDocument>> GetByElementAsync(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

cancellationToken CancellationToken

Токен отмены.

Returns

Task<List<IDocument>>

GetByElementGroupAsync(IIdentifierRequest, CancellationToken)

Возвращает собственные документы группы элементов.

Task<List<IDocument>> GetByElementGroupAsync(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

cancellationToken CancellationToken

Токен отмены.

Returns

Task<List<IDocument>>

GetByUidAsync(string, CancellationToken)

Возвращает документ по его guid.

Task<IDocument> GetByUidAsync(string uid, CancellationToken cancellationToken = default)

Parameters

uid string

Guid объекта в виде строки.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<IDocument>

GetSerialNumbers(IIdentifiableObject, CancellationToken)

Возвращает порядковые номера документа.

Task<ISerialNumbersResponse> GetSerialNumbers(IIdentifiableObject identifier, CancellationToken cancellationToken = default)

Parameters

identifier IIdentifiableObject

Идентификатор объекта.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<ISerialNumbersResponse>

GetTemplateAsync(IIdentifierRequest, CancellationToken)

Возвращает шаблон для заполнения свойств документа.

Task<IPropertyOwnerResponse> GetTemplateAsync(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор группы документов.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<IPropertyOwnerResponse>

GetUsagesAsync(IIdentifierRequest, CancellationToken)

Возвращает объекты, в которых используется документ.

Task<List<IClassificationObject>> GetUsagesAsync(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор документа.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<List<IClassificationObject>>

LinkDocumentOwnersAsync(ILinkDocumentOwnersRequest, CancellationToken)

Привязывает документ к владельцам.

Task<List<IClassificationObject>> LinkDocumentOwnersAsync(ILinkDocumentOwnersRequest request, CancellationToken cancellationToken = default)

Parameters

request ILinkDocumentOwnersRequest

Параметры запроса.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<List<IClassificationObject>>

UnlinkDocumentOwnersAsync(IUnlinkDocumentOwnersRequest, CancellationToken)

Отвязывает документ от владельцев.

Task<List<IClassificationObject>> UnlinkDocumentOwnersAsync(IUnlinkDocumentOwnersRequest request, CancellationToken cancellationToken = default)

Parameters

request IUnlinkDocumentOwnersRequest

Параметры запроса.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<List<IClassificationObject>>

UpdateAsync(IUpdateDocumentRequest, CancellationToken)

Обновляет документ.

Task<IDocument> UpdateAsync(IUpdateDocumentRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateDocumentRequest

Идентификатор родительской группы.

cancellationToken CancellationToken

Токен отмены.

Returns

Task<IDocument>

UpdateSerialNumbers(IUpdateSerialNumbersRequest, CancellationToken)

Редактирует внутренний уникальный номер документа.

Task UpdateSerialNumbers(IUpdateSerialNumbersRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateSerialNumbersRequest

Параметры запроса.

cancellationToken CancellationToken

Токен отмены.

Returns

Task