Class SearchResult

An individual search result.

Inheritance
object
RepositoryItem
SearchResult
Implements
Inherited Members
Namespace: Algenta.Colectica.Model.Repository
Assembly: Algenta.Colectica.Model.dll
Syntax
[DataContract(Namespace = "http://ns.colectica.com/2009/07/")]
public class SearchResult : RepositoryItem, IRepositoryItemIdentity, ISummaryText, IDescribable, IVersionable, IIdentifiable, IHasCustomFields, IVisitable

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>

BannerImageUri

Gets or sets the banner image for the item.

Declaration
public Uri BannerImageUri { get; set; }
Property Value
Type Description
Uri

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

ChildTypesAccepted

Unimplemented, and present for historical purposes.

Declaration
public Collection<Guid> ChildTypesAccepted { get; }
Property Value
Type Description
Collection<Guid>
Exceptions
Type Condition
NotImplementedException

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
bool

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

CustomFields

Gets a collection of custom fields defined for this item.

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

Description

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

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

DisplayLabel

Gets the display label.

Declaration
public string DisplayLabel { get; }
Property Value
Type Description
string
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
[DataMember]
public bool IsAuthoritative { get; set; }
Property Value
Type Description
bool

IsDirty

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

Declaration
public 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
public bool IsPopulated { get; set; }
Property Value
Type Description
bool

true if this instance is populated; otherwise, false.

ItemName

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

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

Label

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

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

MetadataRank

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

Declaration
[DataMember]
public long MetadataRank { get; set; }
Property Value
Type Description
long

OtherMaterials

Unimplemented, and present for historical purposes.

Declaration
public ObservableCollection<OtherMaterial> OtherMaterials { get; }
Property Value
Type Description
ObservableCollection<OtherMaterial>
Exceptions
Type Condition
NotImplementedException

RepositoryName

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

Declaration
[DataMember]
public string RepositoryName { get; set; }
Property Value
Type Description
string

SucceededBy

If another item should be preferred instead of this item.

Declaration
public TypedIdTriple SucceededBy { get; set; }
Property Value
Type Description
TypedIdTriple

Summary

Gets a summary of the item represented by search result.

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

Tags

Gets or sets the tags currently set on the item.

Declaration
[DataMember]
public Collection<string> Tags { get; set; }
Property Value
Type Description
Collection<string>

ThumbnailImageUri

Gets or sets the thumbnail image for the item.

Declaration
public Uri ThumbnailImageUri { get; set; }
Property Value
Type Description
Uri

UserAttributes

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

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

UserIds

Gets the user-specified identifiers.

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

Methods

Accept(IVersionableVisitor)

Unimplemented, and present for historical purposes.

Declaration
public void Accept(IVersionableVisitor visitor)
Parameters
Type Name Description
IVersionableVisitor visitor
Exceptions
Type Condition
NotImplementedException

AddChild(IVersionable)

Unimplemented, and present for historical purposes.

Declaration
public void AddChild(IVersionable child)
Parameters
Type Name Description
IVersionable child
Exceptions
Type Condition
NotImplementedException

GetChildren()

Gets a collection of this item's children.

Declaration
public ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection

RemoveChild(IVersionable)

Unimplemented, and present for historical purposes.

Declaration
public bool RemoveChild(IVersionable child)
Parameters
Type Name Description
IVersionable child
Returns
Type Description
bool
Exceptions
Type Condition
NotImplementedException

RemoveChild(IdentifierTriple)

Unimplemented, and present for historical purposes.

Declaration
public int RemoveChild(IdentifierTriple child)
Parameters
Type Name Description
IdentifierTriple child
Returns
Type Description
int
Exceptions
Type Condition
NotImplementedException

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
int
Exceptions
Type Condition
NotImplementedException

Implements

Extension Methods