IAdgObject interface
Estimated reading time: 4 minutes
Defines the properties and methods for an ADG (ASNA DataGate) object.
Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll
Extends: IComparable, IConnectionHandler, IDisposable
Thread Safety
Implementations of IAdgObject are safe for multithreaded operations.
Remarks
An ADG object represents a resource in an ASNA DataGate environment, such as a file or a database object. This interface defines the common properties and methods that all ADG objects must implement, such as methods for managing authorities, locks, and XML serialization, and properties for getting object information.
Properties
| Type | Name | Description |
|---|---|---|
| AdgObjectTypes | AdgObjectType | Gets the type of the ADG object. |
| AdgSubTypes | AdgSubType | Gets the subtype of the ADG object. |
| IEnumerable<AuthorityEntry> | Authorities | Gets the authorities of the ADG object. |
| String | Basename | Gets the base name of the ADG object. |
| IEnumerable<String> | BaseObjects | Setting this property to null assigns an empty enumerable value. |
| XmlDocument | BasesXml | Gets or sets the XML document representing the base objects of the ADG object. |
| IEnumerable<IAdgObject> | ChildObjects | Gets the child objects of the ADG object. |
| AdgConnection | Connection | Gets the connection associated with the ADG object. |
| DateTime | DateCreated | Gets the date and time when the ADG object was created. |
| DateTime | DateModified | Gets the date and time when the ADG object was last modified. |
| DateTime | DateReferenced | Gets the date and time when the ADG object was last referenced. |
| IEnumerable<Dependent> | DependentObjects | Gets the dependent objects of the ADG object. |
| Boolean | IsSystemObject | Gets a value indicating whether the ADG object is a system object. |
| String | NameOnServer | Gets the name of the ADG object on the server. |
| Int32 | ObjectID | Gets the ID of the ADG object. |
| String | Owner | Gets the owner of the ADG object. |
| Boolean | OwnerIsGroup | Gets a value indicating whether the owner of the ADG object is a group. |
| Int32 | ParentID | Gets the ID of the parent of the ADG object. |
| String | PrimaryGroup | Gets the primary group of the ADG object. |
| XmlSchemaSet | Schema | Gets the XML schema for the ADG object. |
| IComparer | SortByName | Gets the comparer for sorting ADG objects by name. |
| IComparer | SortByNameCaseInsensitive | Gets the comparer for sorting ADG objects by name, ignoring case. |
| String | Text | Setting this property to null assigns an empty string value. |
Methods
| Signature | Description |
|---|---|
| Create() | Creates the ADG object. |
| Duplicate(String, String, String, DuplicateOptions) | Duplicates the ADG object. |
| GrantAuthority(String, AuthorityTypes) | Grants authority to a user or group for the ADG object. |
| HasLock(ShareTypes) | Determines whether the ADG object has a lock of the specified type. |
| Lock(ShareTypes, WaitOptions, Int16) | Locks the ADG object with the specified share type and wait option. |
| MoveTo(String) | Moves the ADG object to a new path. |
| ReadBases(XmlReader) | Reads the base objects of the ADG object from an XML reader. |
| Remove() | Removes the ADG object. |
| Rename(String) | Renames the ADG object. |
| ResolvePathName() | Resolves the path name of the ADG object. |
| RevokeAuthority(String, AuthorityTypes) | Revokes a specific authority from a user for the ADG object. |
| ToString() | Returns a string that represents the ADG object. |
| Unlock(ShareTypes) | Unlocks the ADG object with the specified share type. |
| WriteBases(XmlWriter) | Writes the base objects of the ADG object to an XML writer. |
| WriteXml(XmlWriter, XmlOptions) | Writes the ADG object to an XML writer using the specified options. |
| WriteXml(XmlWriter, XmlOptions, XmlCancelEventHandler) | Writes the ADG object to an XML writer using the specified options and event handler. |
| WriteXml(XmlWriter, XmlOptions, XmlCancelEventHandler, OpenFileAdapterDelegate) | Writes the ADG object to an XML writer using the specified options, event handler, and file opener delegate. |