Search Abstract Classes and Interfaces

ExpressionVisitor

The ExpressionVisitor class is an abstract base class defining objects that visit expression trees.

Namespace

Ektron.Cms.Search.ExpressionVisitor

Methods

  • Visit(AndExpression). Visits the specified AndExpression.
  • Visit(BooleanMultiValuePropertyExpression). Visits the specified BooleanMultiValuePropertyExpression.
  • Visit(BooleanPropertyExpression). Visits the specified BooleanPropertyExpression.
  • Visit(BooleanValueExpression). Visits the specified BooleanValueExpression.
  • Visit(ContainsExpression). Visits the specified ContainsExpression.
  • Visit(DateMultiValuePropertyExpression). Visits the specified DateMultiValuePropertyExpression.
  • Visit(DatePropertyExpression). Visits the specified DatePropertyExpression.
  • Visit(DateValueExpression). Visits the specified DateValueExpression.
  • Visit(DecimalMultiValuePropertyExpression). Visits the specified DecimalMultiValuePropertyExpression.
  • Visit(DecimalPropertyExpression). Visits the specified DecimalPropertyExpression.
  • Visit(DecimalValueExpression). Visits the specified DecimalValueExpression.
  • Visit(DefaultScopeExpression). Visits the specified DefaultScopeExpression.
  • Visit(EqualsExpression). Visits the specified EqualsExpression.
  • Visit(Expression). Visits the specified Expression.
  • Visit(GreaterThanExpression). Visits the specified GreaterThanExpression.
  • Visit(GreaterThanOrEqualsExpression). Visits the specified GreaterThanOrEqualsExpression.
  • Visit(IntegerMultiValuePropertyExpression). Visits the specified IntegerMultiValuePropertyExpression.
  • Visit(IntegerPropertyExpression). Visits the specified IntegerPropertyExpression.
  • Visit(IntegerValueExpression). Visits the specified IntegerValueExpression.
  • Visit(IsNotNullExpression). Visits the specified IsNotNullExpression.
  • Visit(IsNullExpression). Visits the specified IsNullExpression.
  • Visit(KeywordExpression). Visits the specified KeywordExpression.
  • Visit(LessThanExpression). Visits the specified LessThanExpression.
  • Visit(LessThanOrEqualsExpression). Visits the specified LessThanOrEqualsExpression.
  • Visit(NotEqualsExpression). Visits the specified NotEqualsExpression.
  • Visit(NotExpression). Visits the specified NotExpression.
  • Visit(OrExpression). Visits the specified OrExpression.
  • Visit(PropertyExpression). Visits the specified PropertyExpression.
  • Visit(QuotedStringValueExpression). Visits the specified QuotedStringValueExpression.
  • Visit(ScopeExpression). Visits the specified ScopeExpression.
  • Visit(StringMultiValuePropertyExpression). Visits the specified StringMultiValuePropertyExpression.
  • Visit(StringPropertyExpression). Visits the specified StringPropertyExpression.
  • Visit(StringValueExpression). Visits the specified StringValueExpression.

IAuthenticationHandler

The IAuthenticationHandler interface describes a component capable of applying the appropriate permission data to an outgoing search query.

Namespace

Ektron.Cms.Search.IAuthenticationHandler

Methods

  • Handle(AdministratorPermission). Handles the specified permission data, applying it to an outgoing search query. The permission data indicates that the query should execute as a CMS administrator.
  • Handle(CurrentUserPermission). Handles the specified permission data, applying it to an outgoing search query. The permission data indicates that the query should execute as the current CMS user.
  • Handle(ManualUserPermission). Handles the specified permission data, applying it to an outgoing search query. The permission data indicates that the query should execute as a specific CMS user.
  • Handle(Permission). Handles the specified permission data, applying it to an outgoing search query.

ICrawler

The ICrawler interface describes a components capable of managing initiation of indexing activities for relevant CMS events.

Namespace

Ektron.Cms.Search.ICrawler

Methods

  • AddAlias(AliasData). Signals the crawler to handle an add manual alias event.
  • AddAliasRule(AliasRuleData). Signals the crawler to handle an add auto alias event.
  • AddAutoAlias(UrlAliasAutoData). Signals the crawler to handle an add alias event.
  • AddBlogComment(BlogComment). Signals the crawler to handle an add blog comment event.
  • AddColleague(Int64,Int64). Signals the crawler to handle an add colleague event.
  • AddCommunityAlias(UrlAliasCommunityData). Signals the crawler to handle an add alias event.
  • AddContent(ContentData). Signals the crawler to handle an add content event.
  • AddCustomProperty(CustomPropertyData). Signals the crawler to handle a custom property add event.
  • AddCustomPropertyObject(CustomPropertyObjectData). Signals the crawler to handle a custom property object add event.
  • AddDiscussionReply(TaskData). Signals the crawler to handle an add discussion reply event.
  • AddDiscussionTopic(DiscussionTopic). Signals the crawler to handle an add discussion topic event.
  • AddFolder(FolderData). Signals the crawler to handle an add folder event.
  • AddGroup(CommunityGroupData). Signals the crawler to handle an add Group event.
  • AddLibraryItem(LibraryData). Signals the crawler to handle an add library item event.
  • AddManualAlias(UrlAliasManualData). Signals the crawler to handle an add alias event.
  • AddPermission(PermissionData). Signals the crawler to handle the addition of a permission.
  • AddProperty(MetaTypeBaseData). Signals the crawler to handle an add metadata event.
  • AddRegExAlias(UrlAliasRegExData). Signals the crawler to handle an add alias event.
  • AddTaxonomyItem(TaxonomyBaseData). Signals the crawler to handle an add taxonomy item event.
  • AddTemplate(TemplateData). Signals the crawler to handle the addition of a template.
  • AddUser(UserData). Signals the crawler to handle an add user event.
  • AddUserProperty(UserCustomPropertyData). Signals the crawler to handle a user property add event.
  • AddXmlConfiguration(XmlConfigData). Signals the crawler to handle an add XML configuration event.
  • CopyFolder(Int64,Int64). Signals the crawler to handle a copy folder event.
  • DeleteAlias(AliasData). Signals the crawler to handle a delete manual alias event.
  • DeleteAliasRule(AliasRuleData). Signals the crawler to handle a delete auto alias event.
  • DeleteAutoAlias(Int64). Signals the crawler to handle an delete alias event.
  • DeleteCatalogEntry(Int64). Signals the crawler to handle a delete catalog entry event.
  • DeleteColleague(Int64,Int64). Signals the crawler to handle an delete colleague event.
  • DeleteCommunityAlias(Int64). Signals the crawler to handle an delete alias event.
  • DeleteContent(Int64). Signals the crawler to handle an delete content event.
  • DeleteCustomProperty(Int64,Int32). Signals the crawler to handle a custom property delete event.
  • DeleteCustomPropertyObject(Int64,Int32,CustomPropertyObjectType,Int64). Signals the crawler to handle a custom property object delete event.
  • DeleteFolder(Int64). Signals the crawler to handle an delete folder event.
  • DeleteGroup(Int64). Signals the crawler to handle a delete group event.
  • DeleteLibraryItem(Int64). Signals the crawler to handle a delete library item event.
  • DeleteManualAlias(Int64). Signals the crawler to handle an delete alias event.
  • DeleteObjectTag(Int64,Int64,CMSObjectTypes,Int64). Signals the crawler to handle a tag delete event.
  • DeletePermission(PermissionData). Signals the crawler to handle the deletion of a permission.
  • DeleteProperty(Int64). Signals the crawler to handle an delete metadata event.
  • DeleteRegExAlias(Int64). Signals the crawler to handle an delete alias event.
  • DeleteTaxonomyItem(Int64). Signals the crawler to handle an delete taxonomy item event.
  • DeleteTemplate(Int64). Signals the crawler to handle the deletion of a template.
  • DeleteUser(Int64). Signals the crawler to handle a delete user event.
  • DeleteUserProperty(Int64). Signals the crawler to handle a user property delete event.
  • DeleteWebEvent(Int64). Signals the crawler to handle an delete Web event.
  • DeleteXmlConfiguration(Int64). Signals the crawler to handle an delete XML configuration event.
  • DisableAlias(AliasData). Signals the crawler to handle a disable manual alias event.
  • DisableAliasRule(AliasRuleData). Signals the crawler to handle a disable auto alias event.
  • EnableAlias(AliasData). Signals the crawler to handle an enable alias event.
  • EnableAliasRule(AliasRuleData). Signals the crawler to handle a enable auto alias event.
  • MoveFolder(Int64). Signals the crawler to handle a move folder event.
  • PublishCatalogEntry(Int64). Signals the crawler to handle a publish catalog entry event.
  • PublishWebEvent(WebEventData). Signals the crawler to handle an publish Web event.
  • StartFullCrawl(). Requests a full crawl from the associated indexing service.
  • StartFullCrawl(CrawlType). Requests a full crawl from the associated indexing service.
  • StartFullCrawl(CrawlType,Boolean). Requests a full crawl from the associated indexing service with an option whether or not to respect crawl filters from CMS database.
  • StartIncrementalCrawl(). Requests an incremental crawl from the associated indexing service.
  • StartIncrementalCrawl(Boolean). Requests an incremental crawl from the associated indexing service.
  • StartIncrementalCrawl(Boolean,CrawlType). Requests an incremental crawl from the associated indexing service.
  • StartIncrementalCrawl(Boolean,CrawlType,Boolean). Requests an incremental crawl from the associated indexing service with an option whether or not to respect crawl filters from CMS database.
  • StartIncrementalCrawl(CrawlType). Requests an incremental crawl from the associated indexing service.
  • TagObject(TagAssignmentData). Signals the crawler to handle a tag assignment event.
  • UpdateAlias(AliasData). Signals the crawler to handle an update manual alias event.
  • UpdateAliasRule(AliasRuleData). Signals the crawler to handle an update auto alias event.
  • UpdateAliasSetting(String,Object). Signals the crawler to handle a URL aliasing settings update.
  • UpdateAutoAlias(UrlAliasAutoData). Signals the crawler to handle an update alias event.
  • UpdateCommunityAlias(UrlAliasCommunityData). Signals the crawler to handle an update alias event.
  • UpdateContent(ContentData). Signals the crawler to handle an update content event.
  • UpdateCustomProperty(CustomPropertyData). Signals the crawler to handle a custom property update event.
  • UpdateCustomPropertyObject(CustomPropertyObjectData). Signals the crawler to handle a custom property object update event.
  • UpdateDiscussionTopic(DiscussionTopic). Signals the crawler to handle an update discussion topic event.
  • UpdateFolder(FolderData). Signals the crawler to handle an update folder event.
  • UpdateGroup(CommunityGroupData). Signals the crawler to handle an update group event.
  • UpdateItemInheritance(Int64,String,Boolean). Signals the crawler to handle the update of the permission inheritance setting for a particular item.
  • UpdateLibraryItem(LibraryData). Signals the crawler to handle an update library item event.
  • UpdateManualAlias(UrlAliasManualData). Signals the crawler to handle an update alias event.
  • UpdatePermission(PermissionData). Signals the crawler to handle the update of a permission.
  • UpdatePrivateSetting(Int64,String,Boolean). Signals the crawler to handle the update of the permission privacy setting for a particular item.
  • UpdateProperty(MetaTypeBaseData). Signals the crawler to handle an update metadata event.
  • UpdateRegExAlias(UrlAliasRegExData). Signals the crawler to handle an update alias event.
  • UpdateTaxonomyItem(TaxonomyBaseData). Signals the crawler to handle an update taxonomy item event.
  • UpdateTemplate(TemplateData). Signals the crawler to handle the update of a template.
  • UpdateUser(UserData). Signals the crawler to handle an update user event.
  • UpdateUserProperty(UserCustomPropertyData). Signals the crawler to handle a user property update event.
  • UpdateXmlConfiguration(XmlConfigData). Signals the crawler to handle an update XML configuration event.
  • UpdateXmlIndex(XmlConfigData). Signals the crawler to handle an update to XML Index configuration event (saving the index fields on second screen of Smart Form creation).

IIntegratedSearchMapping

The IntegratedSearchMapping interface describes a business object which exposes functionality supporting the creation and management of integrated search mappings.

Namespace

Ektron.Cms.Search.IIntegratedSearchMapping

Methods

  • Add(IntegratedSearchMappingData). Adds the specified integrated search mapping.
  • Delete(Guid). Deletes the specified integrated search mapping from the database.
  • Get(). Gets a collection of all integrated search mappings.
  • Get(Guid). Gets the specified integrated search mapping.
  • Update(IntegratedSearchMappingData). Updates the specified integrated search mapping.

IPropertyNameResolver

The IPropertyNameResolver interface describes a component capable of transforming an internal CMS property name to the name of the corresponding index field.

Namespace

Ektron.Cms.Search.IPropertyNameResolver

Methods

  • Resolve(String,PropertyCategory,PropertyType). Translates the specified CMS property name to the name of the corresponding index field (as its known the underlying search provider).

ISearchManager

The ISearchManager interface defines a component capable of submitting queries for CMS data (content, users, groups, and so on) and returning the relevant results.

Namespace

Ektron.Cms.Search.ISearchManager

Methods

  • Search(AdvancedSearchCriteria). Submits a query according to the specified criteria.
  • Search(KeywordSearchCriteria). Submits a query according to the specified criteria.

ISearchProvider

The ISearchProvider interface describes a component that is capable of communicating with a specific search engine. This includes the translation of CMS search criteria into a syntax supported by that engine, issuing of the query, and the processing of any response data.

Namespace

Ektron.Cms.Search.ISearchProvider

Methods

  • Search(AdvancedSearchCriteria). Executes a narrow, expression-based query using the specified criteria.
  • Search(KeywordSearchCriteria). Executes a keyword-based query using the specified criteria.

ISearchSettings

The ISearchSettings interface describes a component capable of updating and retrieving the configuration details for the search feature.

Namespace

Ektron.Cms.Search.ISearchSettings

Methods

  • GetItem(). Gets the search settings for the current site.

ISuggestedResults

The ISuggestedResults interface describes a component providing administrative capabilities for suggested search result data.

Namespace

Ektron.Cms.Search.ISuggestedResults

Methods

  • Add(SuggestedResultSet). Adds the specified suggested result set.
  • Delete(Guid). Deletes the suggested result identified by the ID.
  • GetItem(Guid). Gets the suggested result set identified by the specified ID.
  • GetItem(String). Gets the suggested result set containing the specified search phrase.
  • GetList(). Gets a collection of suggested result sets from the configured search provider.
  • Update(SuggestedResultSet). Updates the specified suggested result set.

ISynonyms

The ISynonyms interface describes a class providing access to search synonym sets.

Namespace

Ektron.Cms.Search.ISynonyms

Methods

  • Add(SynonymSet). Adds the specified synonym set.
  • Add(List<SynonymSet>). Adds the specified synonym sets.
  • Delete(Guid,Int32). Deletes the specified synonym set.
  • GetItem(Guid). Gets a synonym set.
  • GetList(Int32). Gets a collection of synonym sets for the specified language.
  • Update(List<SynonymSet>). Updates the specified synonym sets.
  • Update(SynonymSet). Updates the specified synonym set.