Interface IItemIndexer
Provides methods to get indexable extracts about a particular type of IVersionable item
Namespace: Algenta.Colectica.Model
Assembly: Algenta.Colectica.Model.dll
Syntax
public interface IItemIndexerProperties
Name
Name of the indexer addin
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Version
Version number of the indexer addin.
Declaration
int Version { get; }Property Value
| Type | Description |
|---|---|
| int |
Methods
GetDeclaredFields()
Get a list of the fields declared by the addin to be indexed
Declaration
List<DeclaredField> GetDeclaredFields()Returns
| Type | Description |
|---|---|
| List<DeclaredField> |
IndexItem(IVersionable)
index field names and values
Declaration
List<ItemIndexValue> IndexItem(IVersionable item)Parameters
| Type | Name | Description |
|---|---|---|
| IVersionable | item |
Returns
| Type | Description |
|---|---|
| List<ItemIndexValue> |
IndexItemWithContext(RepositoryClientBase, IVersionable)
index field names and values of related items to this item
Declaration
List<ItemIndexValue> IndexItemWithContext(RepositoryClientBase client, IVersionable item)Parameters
| Type | Name | Description |
|---|---|---|
| RepositoryClientBase | client | |
| IVersionable | item |
Returns
| Type | Description |
|---|---|
| List<ItemIndexValue> |
SupportsItem(Guid)
Determines whether this class can provide information about an item with the specified type.
Declaration
bool SupportsItem(Guid itemType)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | itemType | The type of the item for which information is being queried. |
Returns
| Type | Description |
|---|---|
| bool |
|