IDataObject
Represents the entity of a data object in onion.net
The entity has properties and methods for the administration or calling of meta and status information of the data object.
A data object consists of the content, which is an Xml and follows an Xml schema defined in the schema management. Furthermore, the entity can supply information regarding for example the creator, last editor and versions as well as the position and state in the data structure of the data repository of onion.net.
Properties
| Property | Description |
|---|---|
| Children:IDataObjectChildrenCollection | Returns a collection of the child data objects. |
| History:IDataObjectHistory | Gets the history for a data object. |
| Id:Int32 | Gets the Id of the data object. |
| IncomingReferences:IDataObjectReferenceCollection | Gets a collection of all data objects that reference the current data object. |
| Locks:IDataObjectLockCollection | Gets a collection of locks for the data object. |
| Path:IDataObject[] | Gets a field of data objects that contains all parent data objects up to the root data object. |
| PathNames:String[] | Gets a field of character strings containing the names of all parent data objects up to the root data object. |
| ReferenceIdentifier:String | Gets the reference identifier for this data object. |
| Rights:IDataObjectRightCollection | Gets a collection of all permissions for the data object. |
| Schema:ISchema | Gets the schema which the data object follows. |
Methods
| Method | Description |
|---|---|
| AddRight(Right):Void | Adds permissions for the data object to a group. |
| CanCreate(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, create a new data object underneath the current data object. |
| CanCreate(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, create a new data object underneath the current data object. |
| CanCreate(IUser):Boolean | Checks whether the indicated user may, in the current context, create a new data object underneath the current data object. |
| CanDelete(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, delete the data object. |
| CanDelete(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, delete the data object. |
| CanDelete(IUser):Boolean | Checks whether the indicated user may, in the current context, delete the data object. |
| CanDeleteChildren(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, delete a data object underneath the current data object. |
| CanDeleteChildren(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, delete a data object underneath the current data object. |
| CanDeleteChildren(IUser):Boolean | Checks whether the indicated user may, in the current context, delete a data object underneath the current data object. |
| CanList(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, list the data objects underneath the current data object. |
| CanList(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, list the data objects underneath the current data object. |
| CanList(IUser):Boolean | Checks whether the indicated user may, in the current context, list the data objects underneath the current data object. |
| CanModify(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, edit the data object. |
| CanModify(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, edit the data object. |
| CanModify(IUser):Boolean | Checks whether the indicated user may, in the current context, edit the data object. |
| CanModifyChildren(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, edit data objects underneath the current data object. |
| CanModifyChildren(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, edit data objects underneath the current data object. |
| CanModifyChildren(IUser):Boolean | Checks whether the indicated user may, in the current context, edit data objects underneath the current data object. |
| CanRead(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, read the current data object. |
| CanRead(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, read the current data object. |
| CanRead(IUser):Boolean | Checks whether the indicated user may, in the current context, read the current data object. |
| CanReadChildren(IChangeSet, IUser):Boolean | Checks whether the indicated user may, in the indicated ChangeSet, read data objects underneath the current data object. |
| CanReadChildren(IGroup):Boolean | Checks whether the members of the indicated group may, in the current context, read data objects underneath the current data object. |
| CanReadChildren(IUser):Boolean | Checks whether the indicated user may, in the current context, read data objects underneath the current data object. |
| CheckIn():Void | Returns the editing process for the data object. |
| CheckIn(Boolean):Void | Returns the editing process for the data object. |
| Checkout():Void | Reserves the editing process of the data object for the current user. |
| Delete():Void | Deletes the current data object. |
| Delete(Boolean):Void | Deletes the current data object or a data structure. |
| GetBinary(String):IBinaryObject | Calls a binary object for the current data object. |
| GetBinary(String, Boolean):IBinaryObject | Calls a binary object for the current data object. |
| Move(IDataObject):Void | Moves the current data object under another data object. |
| Move(IDataObject, String):Void | Moves the current data object under another data object and in doing so renames the current data object. |
| RemoveRight(Right):Void | Removes permissions of the data object from a group. |
| UndoCheckout():Void | Discards the current editing process for the data object. |
| UndoCheckout(Boolean):Void | Discards the current editing process for the data object. |
