Interface IVersionable

Defines the basic identification of a repository-managed item: agency identifier, identifier, and item version.

Inherited Members

IIdentifiable.AgencyId

IIdentifiable.Identifier

IIdentifiable.UserIds

IHasCustomFields.CustomFields

IHasCustomFields.UserAttributes

IVisitable.Accept(IVersionableVisitor)

Namespace: Algenta.Colectica.Model

Assembly: Algenta.Colectica.Model.dll

Syntax

public interface IVersionable : IIdentifiable, IHasCustomFields, IVisitable

Properties

Attachments

Gets a collection of file URIs stored in the File Storage Service attached to this item.

Declaration

ObservableCollection<Attachment> Attachments { get; }

Property Value

Type	Description
ObservableCollection<Attachment>

BannerImageUri

Gets or sets the image to use as a banner.

Declaration

Uri BannerImageUri { get; set; }

Property Value

Type	Description
Uri

BasedOn

Gets a collection that describes previous items on which this item is based

Declaration

BasedOn BasedOn { get; set; }

Property Value

Type	Description
BasedOn

ChildTypesAccepted

Gets the child types that may be added to this item type.

Declaration

[JsonIgnore]
Collection<Guid> ChildTypesAccepted { get; }

Property Value

Type	Description
Collection<Guid>	The child types that may be added to this item type.

ChildrenDereferenced

Gets or sets a value indicating whether the item's children have been dereferenced.

Declaration

[JsonIgnore]
bool ChildrenDereferenced { get; set; }

Property Value

Type	Description
bool	true if the item's children have been dereferenced; otherwise, false.

CompositeId

Gets or sets the item's composite identifier, consisting of the agency identifier, identifier, and version.

Declaration

IdentifierTriple CompositeId { get; set; }

Property Value

Type	Description
IdentifierTriple	The item's composite identifier.

IsDirty

Gets or sets a value indicating whether this instance has unsaved changes.

Declaration

[JsonIgnore]
bool IsDirty { get; set; }

Property Value

Type	Description
bool	true if this instance has unsaved changes; otherwise, false.

IsPopulated

Gets or sets a value indicating whether this instance's information is populated.

Declaration

bool IsPopulated { get; set; }

Property Value

Type	Description
bool	true if this instance is populated; otherwise, false.

IsPublished

Gets or sets a value indicating whether this instance is published.

Declaration

bool IsPublished { get; set; }

Property Value

Type	Description
bool	true if this instance is published; otherwise, false.

ItemType

Gets the universally unique identifier representing the item's type.

Declaration

Guid ItemType { get; }

Property Value

Type	Description
Guid	The identifier representing the item's type.

OtherMaterials

Gets a collection of other material fields defined for this item.

Declaration

ObservableCollection<OtherMaterial> OtherMaterials { get; }

Property Value

Type	Description
ObservableCollection<OtherMaterial>

SucceededBy

If another item should be preferred instead of this item.

Declaration

TypedIdTriple SucceededBy { get; set; }

Property Value

Type	Description
TypedIdTriple

ThumbnailImageUri

Gets or sets the image to use as a thumbnail.

Declaration

Uri ThumbnailImageUri { get; set; }

Property Value

Type	Description
Uri

Version

Gets or sets the version of the item.

Declaration

long Version { get; set; }

Property Value

Type	Description
long	The version of the item.

VersionDate

Gets or sets the DateTime this version of the item was created.

Declaration

DateTime VersionDate { get; set; }

Property Value

Type	Description
DateTime	The DateTime this version was created.

VersionRationale

Gets the log message given by the user who created this version of the item.

Declaration

MultilingualString VersionRationale { get; }

Property Value

Type	Description
MultilingualString

VersionResponsibility

Gets or sets the name of the user who created this version of the item.

Declaration

string VersionResponsibility { get; set; }

Property Value

Type	Description
string	The name of the user who created this version of the item.

Methods

AddChild(IVersionable)

Adds the child.

Declaration

void AddChild(IVersionable child)

Parameters

Type	Name	Description
IVersionable	child	The child.

GetChildren()

Gets a collection of this item's children.

Declaration

ChildItemCollection GetChildren()

Returns

Type	Description
ChildItemCollection

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration

int RemoveChild(IdentifierTriple child)

Parameters

Type	Name	Description
IdentifierTriple	child	The child to be removed.

Returns

Type	Description
int	The number of children removed from the item.

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child.

Declaration

int ReplaceChild(IdentifierTriple toReplace, IVersionable child)

Parameters

Type	Name	Description
IdentifierTriple	toReplace	The identifier of the child to replace.
IVersionable	child	The new child.

Returns

Type	Description
int	The number of children replaced.

Extension Methods

Extensions.Yield<T>(T)