JobCategory Class

The JobCategory class contains attributes that allow alerts to be categorized.

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.JobCategory

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class JobCategory _
    Inherits CategoryBase
'Usage
Dim instance As JobCategory

public sealed class JobCategory : CategoryBase

public ref class JobCategory sealed : public CategoryBase

[<SealedAttribute>]
type JobCategory =  
    class 
        inherit CategoryBase 
    end

public final class JobCategory extends CategoryBase

The JobCategory type exposes the following members.

Constructors

	Name	Description
	JobCategory()	Initializes a new instance of the JobCategory class.
	JobCategory(JobServer, String)	Initializes a new instance of the JobCategory class.

Top

Properties

	Name	Description
	CategoryType	Gets or sets the type of job category.
	ID	Gets the ID value that uniquely identifies the job category.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Parent	Gets the JobServer object that is the parent of the JobCategory object.
	Properties	Gets a collection of Property objects that represent the object properties. (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
	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. (Inherited from CategoryBase.)
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes an existing job category, operator category, or alert category. (Inherited from CategoryBase.)
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	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.)
	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.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	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.)
	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.)
	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. (Inherited from CategoryBase.)
	Script()	Generates a Transact-SQL script that can be used to re-create the job category, the operator category, or the alert category. (Inherited from CategoryBase.)
	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. (Inherited from CategoryBase.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	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

Explicit Interface Implementations

	Name	Description
	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 provide optional attributes that are used to distinguish groups of jobs.

With the JobCategory object, you can:

• Create groupings for jobs.

The category name must be unique.

To get JobCategory object properties, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role.

To set JobCategory object properties, users must be a member of the sysadmin fixed server role.

To create or drop a job category, users must be a member of the sysadmin fixed server role.

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.

Examples

Calling Methods

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.

See Also

Reference

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

sp_add_category (Transact-SQL)