AgentObjectBase Class

 

The AgentObjectBase class is a base class that is inherited by all the SQL Server Agent classes and contains common members.

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


public class AgentObjectBase : NamedSmoObject

NameDescription
System_CAPS_protmethodAgentObjectBase()

Initializes a new instance of the AgentObjectBase class.

NameDescription
System_CAPS_protpropertyExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExecutionManager

Gets the object to execute to the manager.(Inherited from SqlSmoObject.)

System_CAPS_protpropertyIsTouched

Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_protpropertyObjectInSpace

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

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_protpropertyScalarResult

Gets the scalar result for the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_protmethodAddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.(Inherited from SqlSmoObject.)

System_CAPS_protmethodAlterImpl()

Activates the object altered event.(Inherited from SqlSmoObject.)

System_CAPS_protmethodAlterImplWorker()

Calls the Alter methods.(Inherited from SqlSmoObject.)

System_CAPS_protmethodBindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.(Inherited from SqlSmoObject.)

System_CAPS_protmethodBindRuleImpl(String, String, Boolean)

Binds the rule schema to the rule and columns identified by the parameters.(Inherited from SqlSmoObject.)

System_CAPS_protmethodCheckObjectState()

Validates the state of the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodCheckObjectState(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.)

System_CAPS_protmethodCheckObjectStateImpl(Boolean)

Checks the state of a SqlSmoObject.(Inherited from SqlSmoObject.)

System_CAPS_protmethodCleanObject()

Sets the object to its unmodified state.(Inherited from SqlSmoObject.)

System_CAPS_protmethodCreateImpl()

Creates an object with scripting options.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodDropImpl(Boolean)

Drops a SqlSmoObject.(Inherited from SqlSmoObject.)

System_CAPS_protmethodDropImplWorker(Urn, Boolean)

Drops the IMPL worker.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.(Inherited from SqlSmoObject.)

System_CAPS_protmethodExecuteRenameQuery(String)

Executes the rename query for the object.(Inherited from NamedSmoObject.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGenerateAlterEvent()

Generates the alter event with the specified value.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGenerateAlterEvent(Urn, Object)

Generates alter event with the specified URN and inner object value.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Overrides SqlSmoObject.GetDBName().)

System_CAPS_protmethodGetFragOptionString(FragmentationOption)

Gets a FragmentationOption object as a string value.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetRealValue(Property, Object)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerName()

Gets the name of the instance of SQL Server with which the object is associated.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetSqlServerVersionName()

Gets the version name of the instance of SQL Server with which the object is associated.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetUrnRecursive(StringBuilder)

Assigns an Urn object of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetUrnRecursive(StringBuilder, UrnIdOption)

Assigns an Urn object of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodImplInitialize(String[], OrderBy[])

Initializes the fields of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectDirty()

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

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsVersion80SP3()

Determines whether the version of SQL Server is SQL Server 2000 with SP3.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsVersion90AndAbove()

Determines whether the version of SQL Server is SQL Server 2005 or later.(Inherited from SqlSmoObject.)

System_CAPS_protmethodMarkDropped()

Sets the SqlSmoState to dropped.(Inherited from SqlSmoObject.)

System_CAPS_protmethodMarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.(Inherited from SqlSmoObject.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodPostAlter()

The method that is activated after the SqlSmoObject is altered.(Inherited from SqlSmoObject.)

System_CAPS_protmethodPostCreate()

The method that is activated after the SqlSmoObject is created.(Inherited from SqlSmoObject.)

System_CAPS_protmethodPostDrop()

The method that is activated after the SqlSmoObject is dropped.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_protmethodRenameImpl(String)

This method supports the SMO infrastructure and is not intended to be used directly from your code.(Inherited from NamedSmoObject.)

System_CAPS_protmethodRenameImplWorker(String)

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.(Inherited from NamedSmoObject.)

System_CAPS_protmethodScriptImpl()

Gets a collection of scripts of the SqlSmoObject.(Inherited from SqlSmoObject.)

System_CAPS_protmethodScriptImpl(ScriptingOptions)

Gets a collection of scripts of the SqlSmoObject.(Inherited from SqlSmoObject.)

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_protmethodSetSchemaOwned()

Sets the schema owned value. (Inherited from NamedSmoObject.)

System_CAPS_protmethodThrowIfAboveVersion100(String)

Throws the object if above version 100.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfAboveVersion80(String)

Throws SqlSmoObject if version is above 80.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion100(String)

Throws exception if the version is below 100.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion110(String)

Throws the object if the version belows 110.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion110Prop(String)

Throws the SqlSmoObject if version is below 110Prop.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion120(String)

Throws the object if the version is below 120.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion120Prop(String)

Throws the object if the version belows 120 property.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion130(String)

Throws the object if the version is below 130.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion130Prop(String)

Throws an object if BelowVersion130Prop.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion80(String)

Throws the object if the version is below 80.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion80SP3()

Throws an exception if the version is below 80SP3.(Inherited from SqlSmoObject.)

System_CAPS_protmethodThrowIfBelowVersion90(String)

Throws the object if the version is below 90.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodTouchImpl()

Not implemented.(Inherited from SqlSmoObject.)

System_CAPS_protmethodUnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.(Inherited from SqlSmoObject.)

System_CAPS_protmethodUnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_protfieldm_ExtendedProperties

Represents a property that is defined to extend the properties provided by a SqlSmoObject.(Inherited from SqlSmoObject.)

System_CAPS_protfieldsingletonParent

Represents the singleton parent.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: