Class SearchResult

An individual search result.

Inheritance
System.Object
RepositoryItem
SearchResult
Inherited Members
Namespace: Algenta.Colectica.Model.Repository
Assembly: Algenta.Colectica.Model.dll
Syntax
public class SearchResult : RepositoryItem, IRepositoryItemIdentity, ISummaryText, IDescribable, IVersionable, IIdentifiable, IVisitable, IHasCustomFields

Constructors

SearchResult()

Initializes a new instance of the SearchResult class.

Declaration
public SearchResult()

Properties

Attachments

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

Declaration
public virtual ObservableCollection<Attachment> Attachments { get; }
Property Value
Type Description
ObservableCollection<Attachment>
Implements

BasedOn

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

Declaration
public BasedOn BasedOn { get; set; }
Property Value
Type Description
BasedOn
Implements

ChildrenDereferenced

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

Declaration
public bool ChildrenDereferenced { get; set; }
Property Value
Type Description
System.Boolean

true if the item's children have been dereferenced; otherwise, false.
Implements

ChildTypesAccepted

Unimplemented, and present for historical purposes.

Declaration
public Collection<Guid> ChildTypesAccepted { get; }
Property Value
Type Description
Collection<Guid>
Implements

CustomFields

Gets a collection of custom fields defined for this item.

Declaration
public ObservableCollection<CustomField> CustomFields { get; }
Property Value
Type Description
ObservableCollection<CustomField>
Implements

Description

Gets the description of the item represented by the search result.

Declaration
public MultilingualString Description { get; }
Property Value
Type Description
MultilingualString
Implements

DisplayLabel

Gets the display label.

Declaration
public string DisplayLabel { get; }
Property Value
Type Description
System.String
Implements
Remarks

The display label returns text to be displayed in a user interface or in generated documentation.

IsAuthoritative

Gets or sets a value indicating whether the repository is authoritative for the item represented by the search result.

Declaration
public bool IsAuthoritative { get; set; }
Property Value
Type Description
System.Boolean

IsDirty

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

Declaration
public bool IsDirty { get; set; }
Property Value
Type Description
System.Boolean

true if this instance has unsaved changes; otherwise, false.
Implements

IsPopulated

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

Declaration
public bool IsPopulated { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is populated; otherwise, false.
Implements

ItemName

Gets the name of the item represented by the search result.

Declaration
public MultilingualString ItemName { get; }
Property Value
Type Description
MultilingualString
Implements

Label

Gets the label of the item represented by the search result.

Declaration
public MultilingualString Label { get; }
Property Value
Type Description
MultilingualString
Implements

MetadataRank

Gets or sets the metadata rank, which is based on how often an item is referenced.

Declaration
public long MetadataRank { get; set; }
Property Value
Type Description
System.Int64

OtherMaterials

Unimplemented, and present for historical purposes.

Declaration
public ObservableCollection<OtherMaterial> OtherMaterials { get; }
Property Value
Type Description
ObservableCollection<OtherMaterial>
Implements

RepositoryName

Gets or sets the name of the repository in which the search result was found.

Declaration
public string RepositoryName { get; set; }
Property Value
Type Description
System.String

Summary

Gets a summary of the item represented by search result.

Declaration
public MultilingualString Summary { get; }
Property Value
Type Description
MultilingualString
Implements

Tags

Gets or sets the tags currently set on the item.

Declaration
public Collection<string> Tags { get; set; }
Property Value
Type Description
Collection<System.String>

UserAttributes

Gets a collection of user defined fields defined for this item.

Declaration
public ObservableCollection<UserAttribute> UserAttributes { get; }
Property Value
Type Description
ObservableCollection<UserAttribute>
Implements

UserIds

Gets the user-specified identifiers.

Declaration
public UserIdCollection UserIds { get; }
Property Value
Type Description
UserIdCollection
Implements

Methods

Accept(IVersionableVisitor)

Unimplemented, and present for historical purposes.

Declaration
public void Accept(IVersionableVisitor visitor)
Parameters
Type Name Description
IVersionableVisitor visitor
Implements

AddChild(IVersionable)

Unimplemented, and present for historical purposes.

Declaration
public void AddChild(IVersionable child)
Parameters
Type Name Description
IVersionable child
Implements

GetChildren()

Gets a collection of this item's children.

Declaration
public ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection
Implements

RemoveChild(IVersionable)

Unimplemented, and present for historical purposes.

Declaration
public bool RemoveChild(IVersionable child)
Parameters
Type Name Description
IVersionable child
Returns
Type Description
System.Boolean

RemoveChild(IdentifierTriple)

Unimplemented, and present for historical purposes.

Declaration
public int RemoveChild(IdentifierTriple child)
Parameters
Type Name Description
IdentifierTriple child
Returns
Type Description
System.Int32
Implements

ReplaceChild(IdentifierTriple, IVersionable)

Unimplemented, and present for historical purposes.

Declaration
public int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
Type Name Description
IdentifierTriple toReplace
IVersionable child
Returns
Type Description
System.Int32
Implements

Extension Methods