Interface IItemStore

Interface for a data store that provides CRUD operations for item data.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface IItemStore

Methods

DeleteInactiveVersionAsync(string, Section, string, CancellationToken)

Sets Deleted status for an inactive version.

Declaration

Task DeleteInactiveVersionAsync(string itemIdMaster, Section section, string versionName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
string	versionName	The name of the version.
CancellationToken	cancellationToken

Returns

Type	Description
Task

DeleteMasterPartAsync(string, CancellationToken)

Deletes the master part of an item with the given itemIdMaster.

Declaration

Task DeleteMasterPartAsync(string itemIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A Task representing the asynchronous operation.

DisableCultureVersionsAsync(string, Section, CancellationToken)

Disable all Culture versions of an item section.

Declaration

Task DisableCultureVersionsAsync(string itemIdMaster, Section section, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task

DisableGlobalVersionsAsync(string, Section, CancellationToken)

Disable all Global versions of an item section.

Declaration

Task DisableGlobalVersionsAsync(string itemIdMaster, Section section, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task

GetDateModifiedAsync(string, CancellationToken)

Gets the date when the item with the given itemIdMaster was last modified.

Declaration

Task<DateTimeOffset?> GetDateModifiedAsync(string itemIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task<DateTimeOffset?>	A Task representing the asynchronous operation. The task result contains the date when the item was last modified, or null if the item has never been modified.

GetItemVersionAsync(string, Section, VersionFilter, CancellationToken)

Gets the version of an item with the given itemIdMaster and section.

Declaration

Task<ItemVersion> GetItemVersionAsync(string itemIdMaster, Section section, VersionFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
VersionFilter	filter	The VersionFilter used to retrive versions.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ItemVersion>	A Task representing the asynchronous operation. The task result contains the version of the item.

GetItemVersionLocalizationsAsync(string, Section, CancellationToken)

Gets the list of localizations of an item with the given itemIdMaster and section.

Declaration

Task<IEnumerable<string>> GetItemVersionLocalizationsAsync(string itemIdMaster, Section section, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<string>>	A Task representing the asynchronous operation. The task result contains the list of localizations of the item.

GetItemVersionPreviewCountAsync(string, Section, CancellationToken)

Gets the number of preview versions of an item with the given itemIdMaster and section.

Declaration

Task<long> GetItemVersionPreviewCountAsync(string itemIdMaster, Section section, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	A Task representing the asynchronous operation. The task result contains the number of preview versions of the item.

GetItemVersionsAsync(string, Section, VersionFilter, CancellationToken)

Gets the versions of an item with the given itemIdMaster and section.

Declaration

Task<IEnumerable<ItemVersion>> GetItemVersionsAsync(string itemIdMaster, Section section, VersionFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
VersionFilter	filter	The VersionFilter used to retrive versions.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<ItemVersion>>	A Task representing the asynchronous operation. The task result contains the list of versions of the item.

GetMasterPartAsync(string, CancellationToken)

Gets the master part of an item asynchronously.

Declaration

Task<Item.MasterPart> GetMasterPartAsync(string itemIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The Id of the item to retrieve the master part for.
CancellationToken	cancellationToken

Returns

Type	Description
Task<Item.MasterPart>	The master part of the item.

GetNewHistoryVersionNameAsync(string, string, Section, CancellationToken)

Gets a new version name for a given item and section.

Declaration

Task<string> GetNewHistoryVersionNameAsync(string itemIdMaster, string parentVersionName, Section section, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
string	parentVersionName	The parent version name.
Section	section	The Section of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>	A new history version name.

GetNewVersionNameAsync(string, Section, CancellationToken)

Gets a new version name for a given item and section.

Declaration

Task<string> GetNewVersionNameAsync(string itemIdMaster, Section section, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>	A new version name.

GetParentVersionName(string)

Gets the parent version name for a given history version name.

Declaration

string GetParentVersionName(string historyVersionName)

Parameters

Type	Name	Description
string	historyVersionName	The history version name.

Returns

Type	Description
string	The parent version name.

GetSectionPartAsync(string, Section, string, string, CancellationToken)

Gets the section part of an item asynchronously.

Declaration

Task<Item.SectionPart> GetSectionPartAsync(string itemIdMaster, Section section, string versionCulture, string versionName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The Id of the item to retrieve the section part for.
Section	section	The Section to retrieve the section part for.
string	versionCulture	The version culture.
string	versionName	The version name.
CancellationToken	cancellationToken

Returns

Type	Description
Task<Item.SectionPart>	The section part of the item.

SetLabelAsync(string, string, CancellationToken)

Sets the label of an item asynchronously.

Declaration

Task SetLabelAsync(string itemIdMaster, string label, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The Id of the item to set the label for.
string	label	The label to set.
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetMasterPartAsync(MasterPart, CancellationToken)

Sets the master part of an item asynchronously.

Declaration

Task<string> SetMasterPartAsync(Item.MasterPart masterPart, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item.MasterPart	masterPart	The Item.MasterPart to set.
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>	The Id of the item.

SetSectionPartAsync(SectionPart, string, CancellationToken)

Sets the section part of an item asynchronously.

Declaration

Task SetSectionPartAsync(Item.SectionPart sectionPart, string sectionTableName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item.SectionPart	sectionPart	The Item.SectionPart to set.
string	sectionTableName	The name of the section table to set.
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetStatusAsync(string, ItemStatus, CancellationToken)

Sets the status of an item with the given itemIdMaster.

Declaration

Task SetStatusAsync(string itemIdMaster, ItemStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
ItemStatus	status	The new ItemStatus of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A Task representing the asynchronous operation.

SetVersionAsDefaultAsync(string, Section, ItemVersion, CancellationToken)

Sets a version of an item section as the default version by name.

Declaration

Task SetVersionAsDefaultAsync(string itemIdMaster, Section section, ItemVersion version, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
ItemVersion	version	The version to set as default.
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetVersionAsDefaultByCultureAsync(string, Section, string, CancellationToken)

Sets a version of an item section as the default version by culture.

Declaration

Task SetVersionAsDefaultByCultureAsync(string itemIdMaster, Section section, string versionCulture, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
string	versionCulture	The culture of the version to set as default.
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetVersionLinkedValuesAsync(string, Section, string, Dictionary<string, object>, CancellationToken)

Sets the linked values for a version of an item section.

Declaration

Task SetVersionLinkedValuesAsync(string itemIdMaster, Section section, string versionName, Dictionary<string, object> linkedValues, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
string	versionName	The name of the version.
Dictionary<string, object>	linkedValues	The linked values to set for the version.
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetVersionStatusAndCultureAsync(string, Section, string, string, VersionStatus, IEnumerable<string>, CancellationToken)

Sets the status and culture for a version of an item.

Declaration

Task<VersionUpdateResult> SetVersionStatusAndCultureAsync(string itemIdMaster, Section section, string versionName, string versionCulture, VersionStatus versionStatus, IEnumerable<string> cultures, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
Section	section	The Section of the item.
string	versionName	The name of the version.
string	versionCulture	The culture of the version.
VersionStatus	versionStatus	The VersionStatus to set for the version.
IEnumerable<string>	cultures	The cultures for which to set the status.
CancellationToken	cancellationToken

Returns

Type	Description
Task<VersionUpdateResult>	A result indicating the success of the operation.

UpdateDateModifiedAsync(string, CancellationToken)

Updates the modification date of the item with the given itemIdMaster.

Declaration

Task UpdateDateModifiedAsync(string itemIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	itemIdMaster	The IdMaster of the item.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A Task representing the asynchronous operation.