Export (0) Print
Expand All

BrokerObjectBase Class

The BrokerObjectBase class is a base class that is inherited by other Service Broker classes.

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

public class BrokerObjectBase : ScriptNameObjectBase, 
	IScriptable

The BrokerObjectBase type exposes the following members.

  NameDescription
Protected methodBrokerObjectBaseInitializes a new instance of the BrokerObjectBase class.
Top

  NameDescription
Protected propertyExecuteForScalarGets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Protected propertyIsTouchedGets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public propertyNameGets or sets the name of the object. (Overrides NamedSmoObject.Name.)
Protected propertyObjectInSpaceGets 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.)
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Protected propertyScalarResultGets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Protected methodAddDatabaseContextAdd the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Protected methodAlterImplActivates the object altered event. (Inherited from SqlSmoObject.)
Protected methodAlterImplWorkerCalls the Alter methods. (Inherited from SqlSmoObject.)
Protected methodAppendCommaTextAppends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected methodAppendWithCommaTextAppends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected methodAppendWithOptionAppends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected methodAutoGenerateNameGenerates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
Protected methodBindDefaultImplBinds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected methodBindRuleImplBinds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Protected methodCheckObjectDirtyChecks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Protected methodCheckObjectState()Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected methodCheckObjectState(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.)
Protected methodCheckObjectStateImplChecks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodCheckTextCorectnessChecks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
Protected methodCheckTextModeSupportChecks mode of support. (Inherited from ScriptNameObjectBase.)
Protected methodCheckVersion100Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected methodCheckVersion110()Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.)
Protected methodCheckVersion110(String)Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.)
Protected methodCheckVersion120()Checks whether the version of SQL Server is . (Inherited from SqlSmoObject.)
Protected methodCheckVersion120(String)Checks whether the version of SQL Server is . (Inherited from SqlSmoObject.)
Protected methodCheckVersion80Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected methodCheckVersion80SP3Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected methodCheckVersion90Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCheckVersionBelow110Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.)
Protected methodCheckVersionBelow90Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCleanObjectCleans the referenced object. (Inherited from ScriptNameObjectBase.)
Protected methodCreateImplCreates an object with scripting options. (Inherited from SqlSmoObject.)
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Protected methodDropImplDrops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodDropImplWorkerCalls the drop methods. (Inherited from SqlSmoObject.)
Public methodEquals (Inherited from Object.)
Protected methodExecuteNonQueryExecutes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.)
Protected methodExecuteRenameQueryExecutes the rename query for the object. (Inherited from NamedSmoObject.)
Protected methodFinalize (Inherited from Object.)
Protected methodForceTextModeOnTextBodyEnforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGenerateAlterEvent()Generates the alter event with the specified value. (Inherited from SqlSmoObject.)
Protected methodGenerateAlterEvent(Urn, Object)Generates alter event with the specified URN and inner object value. (Inherited from SqlSmoObject.)
Protected methodGetBraketNameForTextGets the bracket name for the text. (Inherited from ScriptNameObjectBase.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameReturns the name of the database on which the instance of Service Broker is implemented. (Overrides SqlSmoObject.GetDBName().)
Protected methodGetFragOptionStringGets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetIsSystemNamedGets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected methodGetIsTextDirtyDetermines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetRealValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerNameGets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetSqlServerVersionNameGets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetTextBody()Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected methodGetTextBody(Boolean)Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected methodGetTextHeaderReturns the text header. (Inherited from ScriptNameObjectBase.)
Protected methodGetTextModeDetermines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
Protected methodGetTextPropertyGets the text of the object, if not available, throw appropriate exception based on the state of the object. (Inherited from ScriptNameObjectBase.)
Public methodGetType (Inherited from Object.)
Protected methodGetUrnRecursive(StringBuilder)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetUrnRecursive(StringBuilder, UrnIdOption)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodImplInitializeInitializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectDirtyDetermines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected methodIsVersion80SP3Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected methodIsVersion90AndAboveDetermines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected methodMarkDroppedSets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected methodMarkForDropImplSets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodPostAlterThe method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected methodPostCreateThe method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected methodPostDropThe method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Protected methodRenameImplThis method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected methodRenameImplWorkerIdentified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Public methodScript()Generates a Transact-SQL script that can be used to re-create the Service Broker object.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the SQL Server Agent alert as specified by the scripting options.
Protected methodScriptImpl()Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptImpl(ScriptingOptions)Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodSetCollectionTextModeSets the collection text mode. (Inherited from ScriptNameObjectBase.)
Protected methodSetIsSystemNamedSets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected methodSetSchemaOwnedSets the schema owned value. (Inherited from NamedSmoObject.)
Protected methodSetTextBodySpecifies the text body. (Inherited from ScriptNameObjectBase.)
Protected methodSetTextHeaderSpecifies the text header. (Inherited from ScriptNameObjectBase.)
Protected methodSetTextModeSpecifies the text mode. (Inherited from ScriptNameObjectBase.)
Protected methodSwitchTextModeSwitches the text mode. (Inherited from ScriptNameObjectBase.)
Protected methodThrowIfTextIsDirtyForAlterThrows an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected methodTouchImplNot implemented. (Inherited from SqlSmoObject.)
Protected methodUnbindDefaultImplUnbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodUnbindRuleImplUnbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Protected fieldm_ExtendedPropertiesRepresents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected fieldsingletonParentRepresents the singleton parent. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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.)
Explicit interface implemetationPrivate methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

The BrokerObjectBase is used in the construction of other Service Broker  objects and contains functionality that is common.

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.

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft