CategoryBase Class
The CategoryBase class is a base class that is used in the construction of the JobCategory class, the OperatorCategory class, and the AlertCategory class. It contains functionality that is common to all three category classes.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.NamedSmoObject
Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase
Microsoft.SqlServer.Management.Smo.Agent.CategoryBase
Microsoft.SqlServer.Management.Smo.Agent.AlertCategory
Microsoft.SqlServer.Management.Smo.Agent.JobCategory
Microsoft.SqlServer.Management.Smo.Agent.OperatorCategory
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public Class CategoryBase _
Inherits AgentObjectBase _
Implements ICreatable, IDroppable, IRenamable, IScriptable
'Usage
Dim instance As CategoryBase
public class CategoryBase : AgentObjectBase,
ICreatable, IDroppable, IRenamable, IScriptable
public ref class CategoryBase : public AgentObjectBase,
ICreatable, IDroppable, IRenamable, IScriptable
type CategoryBase =
class
inherit AgentObjectBase
interface ICreatable
interface IDroppable
interface IRenamable
interface IScriptable
end
public class CategoryBase extends AgentObjectBase implements ICreatable, IDroppable, IRenamable, IScriptable
The CategoryBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
CategoryBase | Initializes a new instance of the JobCategory class, or the OperatorCategory class, or the AlertCategory class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.) |
|
IsTouched | Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.) |
.gif "Public property") |
Name | Gets or sets the name of the object. (Inherited from NamedSmoObject.) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
|
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
|
ScalarResult | Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.) |
|
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
|
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddDatabaseContext | Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.) |
|
AlterImpl | Activates the object altered event. (Inherited from SqlSmoObject.) |
|
AlterImplWorker | Calls the Alter methods. (Inherited from SqlSmoObject.) |
|
BindDefaultImpl | Binds the default items identified by the parameters. (Inherited from SqlSmoObject.) |
|
BindRuleImpl | Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.) |
|
CheckObjectState() | Validates the state of the referenced object. (Inherited from SqlSmoObject.) |
|
CheckObjectState(Boolean) | Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.) |
|
CheckObjectStateImpl | Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.) |
|
CheckVersion100 | Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.) |
|
CheckVersion110() | Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.) |
|
CheckVersion110(String) | Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.) |
|
CheckVersion80 | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) |
|
CheckVersion80SP3 | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) |
|
CheckVersion90 | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) |
|
CheckVersionBelow110 | Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.) |
|
CheckVersionBelow90 | Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.) |
|
CleanObject | Sets the object to its unmodified state. (Inherited from SqlSmoObject.) |
.gif "Public method") |
Create | Creates the job category, the operator category, or the alert category based on the JobCategory object, the OperatorCategory object, or the AlertCategory object respectively. |
|
CreateImpl | Creates an object with scripting options. (Inherited from SqlSmoObject.) |
|
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
|
Drop | Removes an existing job category, operator category, or alert category. |
|
DropImpl | Drops a SqlSmoObject. (Inherited from SqlSmoObject.) |
|
DropImplWorker | Calls the drop methods. (Inherited from SqlSmoObject.) |
|
Equals | (Inherited from Object.) |
|
ExecuteNonQuery | Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.) |
|
ExecuteRenameQuery | Executes the rename query for the object. (Inherited from NamedSmoObject.) |
|
Finalize | (Inherited from Object.) |
|
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) |
|
GenerateAlterEvent() | Generates the alter event with the specified value. (Inherited from SqlSmoObject.) |
|
GenerateAlterEvent(Urn, Object) | Generates alter event with the specified URN and inner object value. (Inherited from SqlSmoObject.) |
|
GetCatTypeName | Returns a String with the name of the specified category type. |
|
GetContextDB | Gets the context database that is associated with this object. (Inherited from SqlSmoObject.) |
|
GetDBName | Gets the database name that is associated with the object. (Inherited from AgentObjectBase.) |
|
GetFragOptionString | Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetRealValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetServerName | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
|
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetSqlServerVersionName | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
|
GetType | (Inherited from Object.) |
|
GetUrnRecursive(StringBuilder) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetUrnRecursive(StringBuilder, UrnIdOption) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
ImplInitialize | Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
|
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
|
IsObjectDirty | Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (Inherited from SqlSmoObject.) |
|
IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
|
IsVersion80SP3 | Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.) |
|
IsVersion90AndAbove | Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.) |
|
MarkDropped | Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.) |
|
MarkForDropImpl | Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.) |
|
MemberwiseClone | (Inherited from Object.) |
|
PostAlter | The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.) |
|
PostCreate | The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.) |
|
PostDrop | The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.) |
|
Refresh | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) |
|
Rename | Renames the job category, the operator category, or the alert category. |
|
RenameImpl | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
RenameImplWorker | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.) |
|
Script() | Generates a Transact-SQL script that can be used to re-create the job category, the operator category, or the alert category. |
|
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the job category, the operator category, or the alert category as specified by the scripting options. |
|
ScriptImpl() | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) |
|
ScriptImpl(ScriptingOptions) | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) |
|
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) |
|
SetSchemaOwned | Sets the schema owned value. (Inherited from NamedSmoObject.) |
|
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
|
TouchImpl | Not implemented. (Inherited from SqlSmoObject.) |
|
UnbindDefaultImpl | Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.) |
|
UnbindRuleImpl | Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.) |
|
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) |
|
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
m_ExtendedProperties | Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.) |
|
singletonParent | Represents the singleton parent. (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetParent | Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetUrn | Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.) |
|
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) |
|
IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) |
|
ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.) |
Top
Remarks
SQL Server Agent categories are optional attributes that are used to group alerts, jobs, and operators.
With the JobCategory, OperatorCategory, and AlertCategory objects, you can:
- Create groupings for alerts, jobs, and operators.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.