Interface IBasicItemService

Provides methods for creating new items and managing basic items in the system.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface IBasicItemService

Methods

CloneAsync(string, string, string, CancellationToken)

Clones an item with the specified Id

Declaration

Task CloneAsync(string itemId, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemId	The Id of the item to delete.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.

DeleteAsync(string, string, string, CancellationToken)

Deletes an item with the specified Id by changing the status to Deleted

Declaration

Task DeleteAsync(string itemId, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemId	The Id of the item to delete.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.

DeleteFromStorageAsync(string, string, string, CancellationToken)

Deletes an item with the specified Id.

Declaration

Task DeleteFromStorageAsync(string itemId, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemId	The Id of the item to delete.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.

GetBasicItemStores()

Returns a collection of all file storage stores associated with this file storage service.

Declaration

IEnumerable<IBasicItemStore> GetBasicItemStores()

Returns

Type	Description
IEnumerable<IBasicItemStore>	A collection of IFileStorageStore instances.

GetItemAsync(string, string, string, CancellationToken)

Retrieves an item by its Id.

Declaration

Task<BasicItem> GetItemAsync(string itemId, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemId	The Id of the item to retrieve.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task<BasicItem>	The item with the specified IdMaster, or null if no item is found.

GetItemByFilterAsync(BasicItemFilter, string, string, CancellationToken)

Retrieves a basic item based on the provided filter.

Declaration

Task<BasicItem> GetItemByFilterAsync(BasicItemFilter filter, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BasicItemFilter	filter	The BasicItemFilter used to retrieve the item.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task<BasicItem>	A basic items.

GetItemCountAsync(BasicItemFilter, string, string, CancellationToken)

Retrieves the number of basic items based on the provided filter.

Declaration

Task<long> GetItemCountAsync(BasicItemFilter filter, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BasicItemFilter	filter	The BasicItemFilter used to retrieve the count of basic items.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	The number of basic items that match the provided filter.

GetItemsByFilterAsync(BasicItemFilter, string, string, CancellationToken)

Retrieves a collection of basic items based on the provided filter.

Declaration

Task<IEnumerable<BasicItem>> GetItemsByFilterAsync(BasicItemFilter filter, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BasicItemFilter	filter	The BasicItemFilter used to retrieve the context items.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<BasicItem>>	A collection of basic items.

GetNewItemAsync(string, string, CancellationToken)

Creates a new item with default values.

Declaration

Task<BasicItem> GetNewItemAsync(string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task<BasicItem>	A new item.

SetStatusAsync(string, string, string, string, CancellationToken)

Sets the status of an item with the specified Id.

Declaration

Task SetStatusAsync(string itemId, string status, string storageName, string storageContainerData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemId	The Id of the item to update.
string	status	The new status of the item.
string	storageName	The name of the storage to use.
string	storageContainerData	The storage container data.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.