IGHAObject Interface |
[This is preliminary documentation and is subject to change.]
Definition for the base object in GHA
Namespace: GHASchema
Assembly: GHASchema (in GHASchema.dll) Version: 1.1.8074.31450 (1.0.0.0)
SyntaxC#
public interface IGHAObject
The IGHAObject type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Children |
Collection containing the children of the object
|
| Class |
Type from which the object is derived
|
| Description |
Free-form description of the object
|
| DisplayName |
Name to be used by end-user displays to refer to the object
|
| Icon |
Icon used to represent the object
|
| IsMarkedForDelete |
Returns the mark for delete flag
|
| Name |
Name of the object
|
| Navigation |
Defines how UI's should treat this class
|
| ObjectID |
Unique ID of the object expressed as a .NET GUID
|
| Parent |
The object owning the current object in the hierarchy
|
| Path |
URI pointing to the location of the object in the hierarchy
|
Methods| Name | Description | |
|---|---|---|
 | AddToGroup |
Adds this instance to the specified group. Creates the group if it does not exist
|
| CreateObject |
Creates an object of the specified class name as a child of the calling object
|
| DeleteGroup |
Deletes the specified group
|
| DeleteObject |
Deletes a child object of the calling object matching the specified name
|
| GetBindableObjects |
Returns objects implementing the IBindable interface
|
| GetCapabilities |
Returns all capabilities currently defined by GHA
|
| GetChildren |
Returns a collection of objects containing the children of the calling object, optionally done recursively and sorted
|
| GetClasses |
Returns all currently available classes that inherit from IGHAObject
|
| GetCompatibleGroups |
Returns GHAGroup objects for which this object can be a member
|
| GetContainedTypes |
Returns the types that can be children for the owning object
|
| GetEnumerations |
Returns all enumeration types defined in GHA
|
| GetGroupingCompatibleObjects |
Returns objects that are groupable and of the same type as the calling object
|
| GetGroupMemberships |
Gets the groups of which this instance is a member
|
| GetInheritanceHierarchy |
Returns the inheritence tree for the owning object
|
| GetInheritedClasses |
Returns the inheritance tree for the specified class
|
| GetMyCapabilities |
Returns the list of capabilities implemented by the owning object
|
| GetObject(Guid) |
Returns the object with the requested Object ID
|
| GetObject(String) |
Returns the object at the specified relative path
|
| GetObject(Uri) |
Returns an object at the specified absolute Uri
|
| GetObjectsByCapability |
Returns objects that match the specified capability
|
| GetObjectsByPropertyName |
Returns a collection of child objects that have the specified property
|
| GetObjectsByPropertySearch |
Returns a collection of objects that contain properties that match the specified search string
|
| GetObjectsByPropertyValue |
Returns a collection of objects that have the specified property and match the specified value
|
| GetObjectsByType |
Returns objects of the specified type
|
| GetObjectsByTypeAndPropertyValue |
Returns a collection of objects of the specified type containing the specified property and matches the property value
|
| GetProperties |
Returns a list of Property descriptors for the calling object
|
| GetProperty |
Returns the property descriptor for the specified property
|
| GetPropertyNames |
Returns a list of the calling object's property names
|
| GetSubscription |
Returns Subscription descriptor for the specified subscription ID
|
| GetTypesWithCategory |
Returns types tagged with the specified category
|
| GetValue |
Returns the value of the specified property
|
| Invoke |
Invokes the specified method with the supplied arguments
|
| IsBindable |
Determines if the current object is Bindable
|
| IsChildOf |
Determines if the specified object is one of the calling object's children
|
| IsOfExplicitType |
Determines if the calling object inherits from the specified class
|
| IsWebViewable |
Determines if the current object implements an internal web page which can be accessed via a browser
|
| MarkForDelete |
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.
|
| Move |
Moves the current object and its children to a new parent object
|
| PostLoadFixup |
Called by the GHA Executive after the object is loaded to perform any initialization tasks for the object
|
| PrepareForDelete |
Called by the GHA executive just prior to the owning object's deletion so that it can perform any cleanup tasks
|
| RebuildSubscriptions |
Internal use only
|
| Recover(String) |
Internal use only
|
| Recover(XmlElement) |
Internal use only
|
| RemoveFromGroup |
Removes this instance from the specified group. Deletes the group if empty
|
| Rename |
Renames the calling object to the specified new name
|
| RunCommand |
Invoke the specified method of the calling object
|
| Serialize |
Returns an XML string representing the calling object's state
|
| Serialize(XmlDocument, XmlElement) |
Internal use only
|
| SetExec |
Internal use only
|
| SetGHAObjectsDatabase |
Internal use only
|
| SetProxy |
Internal use only
|
| SetValue(String, Object) |
Sets the specified property to the specified value
|
| SetValue(String, Object, Int32) |
Internal use only
|
| SetValueForced |
Performs the standard SetValue but also triggers the PropertyChanged handler regardless of whether the
property has changed or not
|
| SubscribeToCreate |
Subscribes to the Create object event for the object. Invokes event handler if a new object is created under the owning object.
|
| SubscribeToDelete |
Subscribes to the Delete object event for the object. Invokes event handler if a child object is deleted under the owning object.
|
| SubscribeToProperty |
Subscribes to any changes to the specified property
|
| Unsubscribe |
Unsubscribes from the specified subscription (property change, create, or delete)
|
See Also