Click or drag to resize

IGHAObject Methods

[This is preliminary documentation and is subject to change.]

The IGHAObject type exposes the following members.

Methods
  NameDescription
Public methodAddToGroup
Adds this instance to the specified group. Creates the group if it does not exist
Public methodCreateObject
Creates an object of the specified class name as a child of the calling object
Public methodDeleteGroup
Deletes the specified group
Public methodDeleteObject
Deletes a child object of the calling object matching the specified name
Public methodGetBindableObjects
Returns objects implementing the IBindable interface
Public methodGetCapabilities
Returns all capabilities currently defined by GHA
Public methodGetChildren
Returns a collection of objects containing the children of the calling object, optionally done recursively and sorted
Public methodGetClasses
Returns all currently available classes that inherit from IGHAObject
Public methodGetCompatibleGroups
Returns GHAGroup objects for which this object can be a member
Public methodGetContainedTypes
Returns the types that can be children for the owning object
Public methodGetEnumerations
Returns all enumeration types defined in GHA
Public methodGetGroupingCompatibleObjects
Returns objects that are groupable and of the same type as the calling object
Public methodGetGroupMemberships
Gets the groups of which this instance is a member
Public methodGetInheritanceHierarchy
Returns the inheritence tree for the owning object
Public methodGetInheritedClasses
Returns the inheritance tree for the specified class
Public methodGetMyCapabilities
Returns the list of capabilities implemented by the owning object
Public methodGetObject(Guid)
Returns the object with the requested Object ID
Public methodGetObject(String)
Returns the object at the specified relative path
Public methodGetObject(Uri)
Returns an object at the specified absolute Uri
Public methodGetObjectsByCapability
Returns objects that match the specified capability
Public methodGetObjectsByPropertyName
Returns a collection of child objects that have the specified property
Public methodGetObjectsByPropertySearch
Returns a collection of objects that contain properties that match the specified search string
Public methodGetObjectsByPropertyValue
Returns a collection of objects that have the specified property and match the specified value
Public methodGetObjectsByType
Returns objects of the specified type
Public methodGetObjectsByTypeAndPropertyValue
Returns a collection of objects of the specified type containing the specified property and matches the property value
Public methodGetProperties
Returns a list of Property descriptors for the calling object
Public methodGetProperty
Returns the property descriptor for the specified property
Public methodGetPropertyNames
Returns a list of the calling object's property names
Public methodGetSubscription
Returns Subscription descriptor for the specified subscription ID
Public methodGetTypesWithCategory
Returns types tagged with the specified category
Public methodGetValue
Returns the value of the specified property
Public methodInvoke
Invokes the specified method with the supplied arguments
Public methodIsBindable
Determines if the current object is Bindable
Public methodIsChildOf
Determines if the specified object is one of the calling object's children
Public methodIsOfExplicitType
Determines if the calling object inherits from the specified class
Public methodIsWebViewable
Determines if the current object implements an internal web page which can be accessed via a browser
Public methodMarkForDelete
Sets the _markForDelete field to support deferred deletes druing system startup. The object should have been d deleted using the DeleteObject method by the parent.
Public methodMove
Moves the current object and its children to a new parent object
Public methodPostLoadFixup
Called by the GHA Executive after the object is loaded to perform any initialization tasks for the object
Public methodPrepareForDelete
Called by the GHA executive just prior to the owning object's deletion so that it can perform any cleanup tasks
Public methodRebuildSubscriptions
Internal use only
Public methodRecover(String)
Internal use only
Public methodRecover(XmlElement)
Internal use only
Public methodRemoveFromGroup
Removes this instance from the specified group. Deletes the group if empty
Public methodRename
Renames the calling object to the specified new name
Public methodRunCommand
Invoke the specified method of the calling object
Public methodSerialize
Returns an XML string representing the calling object's state
Public methodSerialize(XmlDocument, XmlElement)
Internal use only
Public methodSetExec
Internal use only
Public methodSetGHAObjectsDatabase
Internal use only
Public methodSetProxy
Internal use only
Public methodSetValue(String, Object)
Sets the specified property to the specified value
Public methodSetValue(String, Object, Int32)
Internal use only
Public methodSetValueForced
Performs the standard SetValue but also triggers the PropertyChanged handler regardless of whether the property has changed or not
Public methodSubscribeToCreate
Subscribes to the Create object event for the object. Invokes event handler if a new object is created under the owning object.
Public methodSubscribeToDelete
Subscribes to the Delete object event for the object. Invokes event handler if a child object is deleted under the owning object.
Public methodSubscribeToProperty
Subscribes to any changes to the specified property
Public methodUnsubscribe
Unsubscribes from the specified subscription (property change, create, or delete)
Top
See Also