AnalyticsJobBase members
Provides a base class for analysis jobs.
The AnalyticsJobBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AnalyticsJobBase() | Creates an instance of a class that inherits from AnalyticsJobBase. This constructor is required for deserialization and is used for recreating a SPPersistedObject based on data that already exists. |
|
AnalyticsJobBase(Guid, String, SPPersistedObject) | Creates an instance of a class that inherits from AnalyticsJobBase. This constructor is used to create the initial class instance, creating a new SPPersistedObject instance. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
CompletedRuns | Gets or sets a Int64 value that keeps track of the view this analytics job has, of completed analysis runs. This property indicates if a new analysis is complete. |
.gif "Public property") |
Description | Gets the localized description of the analysis job definition as a String |
|
DisplayName | (Inherited from SPPersistedObject.) |
|
Farm | (Inherited from SPPersistedObject.) |
|
GetNextRunStartTime | Gets the time for when the next analysis job is scheduled to run. |
|
Id | (Inherited from SPPersistedObject.) |
|
IsDirty | Gets or sets a Boolean that indicates if the state of the timer job object has changed. |
|
JobScheduleDisabled | Gets or sets a Boolean value to enable or disable analysis job scheduling. |
|
Name | (Inherited from SPPersistedObject.) |
|
NextScheduledRun | Gets or sets a DateTime value holding the time for the next scheduled analysis job. |
|
Parent | (Inherited from SPPersistedObject.) |
|
Properties | (Inherited from SPPersistedObject.) |
|
Status | (Inherited from SPPersistedObject.) |
|
TypeName | (Inherited from SPPersistedObject.) |
|
UlsPrefix | Gets a String value used to prefix ULS log messages. |
|
UpgradedPersistedProperties | (Inherited from SPAutoSerializingObject.) |
|
Version | (Inherited from SPPersistedObject.) |
|
WasCreated | (Inherited from SPPersistedObject.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
ClearAnalysis | Clears the analysis cache, which must be in the stopped or failed state before its cache can be cleared. |
|
Clone | (Inherited from SPPersistedObject.) |
|
CompletedRunsIsIncremented | Checks if the analysis job has completed a new run. |
|
Delete | (Inherited from SPPersistedObject.) |
|
DisableJobSchedule | Disables scheduling of the current job. |
|
EnableJobSchedule | Enables scheduling of the current analysis job. |
|
Equals | (Inherited from SPPersistedObject.) |
|
ExecuteInternal | Called regularly by an instance of AnalyticsJobDefinition, which represents the general timer job for SearchAnalyticsJob and SearchReportsJob. |
|
Finalize | (Inherited from Object.) |
|
GetAnalysisConfiguration | Gets the configuration settings for the current analysis. |
|
GetAnalysisInfo | Gets analysis information for the current analysis. |
|
GetChild<T>() | (Inherited from SPPersistedObject.) |
|
GetChild<T>(String) | (Inherited from SPPersistedObject.) |
|
GetHashCode | (Inherited from SPPersistedObject.) |
|
GetObjectData | (Inherited from SPAutoSerializingObject.) |
|
GetType | (Inherited from Object.) |
|
HasAdditionalUpdateAccess | (Inherited from SPPersistedObject.) |
|
MemberwiseClone | (Inherited from Object.) |
|
OnDeserialization | (Inherited from SPPersistedObject.) |
|
Provision | (Inherited from SPPersistedObject.) |
|
RefreshAnalysisConfiguration | Refreshes the configuration settings for the current analysis by reloading the settings from the internal location where they are stored. |
|
ResumeAnalysis | Resumes the analysis job, which must be in a paused state. |
|
SaveStateIfChanged | Saves the state to the configuration database if the state has changed since the last check. |
|
SetValue<T> | Use when asserting a new value to certain properties to ensure state changes that need to be written to the database are tracked. |
|
StartAnalysis | Starts the analysis, which must be in the stopped or failed state before it can be started. |
|
StopAnalysis | Stops the analysis, which must be in the running or paused state. |
|
SuspendAnalysis | Suspends the analysis, which must be in the running state. |
|
ToString | (Inherited from SPPersistedObject.) |
|
Uncache | (Inherited from SPPersistedObject.) |
|
Unprovision | (Inherited from SPPersistedObject.) |
|
Update() | (Inherited from SPPersistedObject.) |
|
Update(Boolean) | (Inherited from SPPersistedObject.) |
|
UpdateParent | (Inherited from SPAutoSerializingObject.) |
|
Validate | (Inherited from SPPersistedObject.) |
Top