ScopesManager Members

  • Article

Include Protected Members
Include Inherited Members

Defines the functionality to administer Search scopes in a farm.

The ScopesManager type exposes the following members.

Constructors

  Name Description
Protected method ScopesManager Initializes a new instance of the ScopesManager class.

Top

Properties

  Name Description
Public property AllDisplayGroups When overridden in a derived class, gets the collection of scope display groups managed by the ScopesManager.
Public property AllScopes When overridden in derived class, gets a collection that contains all of the scopes managed by the ScopesManager.
Public property AverageCompilationDuration Gets the average compilation time for the Search scopes.
Public property CompilationPercentComplete Gets the percentage of compilation completed for the Search scope system.
Public property CompilationScheduleType When overridden in derived classes, gets or sets the time when the scope compilation is scheduled.
Public property CompilationState Gets the compilation state of the Search scope system.
Public property LastCompilationTime Gets the date and time of the last compilation for the Search scope system.
Protected property LogPrefix When overridden in a derived class, gets the prefix that is prepended to each log statement.
Public property NextCompilationTime Gets the date and time for the next compilation of the Search scope system.
Public property ScopesNeedingCompilation Gets the number of scopes that need to be compiled.

Top

Methods

  Name Description
Protected method ConstructDisplayGroupFromInfo Creates a scope display group with the specified scope display group information.
Protected method ConstructRuleFromRuleInfo Creates a Search scope rule with specified Search scope rule information.
Protected method ConstructScopeFromScopeInfo Creates a Search scope with specified Search scope information.
Protected method EnsureFresh Refreshes the Search scope compilation information if the information is stale.
Protected method EnsurePopulated Sets the Search scope compilation information to the default global values if not already set.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetDisplayGroup When overridden in a derived class, gets the scope display group the with specified site URI and name.
Public method GetDisplayGroupsForSite When overridden in a derived class, gets an enumerator to access the list of the ScopeDisplayGroup objects.
Public method GetHashCode (Inherited from Object.)
Protected method GetRulesInfo Gets a key/value pair of Search scope rules from the specified rule information collection.
Public method GetScope Gets the Search scope.
Public method GetScopesForSite When overridden in a derived class, gets an enumerator to access the collection of scopes for a specified site.
Public method GetSharedScope When overridden in a derived class, gets the global scope with the specified name.
Public method GetSharedScopes When overridden in a derived class, gets an enumerator to access a list of global search Scope objects that are available on any server in the SPFarm.
Public method GetType (Inherited from Object.)
Public method GetUnusedScopesForSite When overridden in a derived class, gets an enumerator to access the list of the search Scope objects that are not used by any Search scope display group.
Protected method InitializeDetails Initializes the Search scope compilation information by using the specified global settings.
Protected method InitializeVolatileDetails Initializes the Search scope compilation information by using the specified volatile global settings.
Protected method MemberwiseClone (Inherited from Object.)
Protected method Populate When overridden in a derived class, resets the Search scope compilation information to the default global values.
Protected method PruneDisplayGroupList Gets an enumerator to access the list of ScopeDisplayGroup objects associated with the specified list of information about Search display groups.
Protected method PruneScopeList Gets an enumerator to access the list of Scope objects associated with the specified list of information about scopes.
Protected method Refresh When overridden in derived classes, reloads the volatile Search scope compilation information by using information from the Search administration database.
Protected method SetDisplayGroupDetails Sets the detailed information about the specified scope display group with the specified display group information.
Protected method SetScopeInfoOnScope Sets the detailed information about the specified scope with the specified scope information.
Public method StartCompilation When overridden in a derived class, starts the Search scope compilation in the Search service application.
Public method ToString (Inherited from Object.)
Public method Update When overridden in a derived class, updates the Search Scope compilation schedule information.

Top

Fields

  Name Description
Protected field isChanged Indicates whether the value of the CompilationScheduleType property has changed.
Protected field isPopulated Indicates whether the Search scope compilation information has been reset to the default global values.
Protected field lastRefreshTime Represents the last time that the volatile Search scope compilation information was reset to the default global values.
Protected field managedPropertiesById Represents a key/value pair that stores the property IDs of the managed properties of the ScopesManager.
Protected field managedPropertiesByName Represents a key/value pair that stores the names of the managed properties of the ScopesManager.

Top

See Also

Reference

ScopesManager Class

Microsoft.Office.Server.Search.Administration Namespace