| IReadOnlyItem Interface |
Represents an Aras Item that is read only. By default, the connection object returns IReadOnlyItems to encouarge
treating the results as immutable
Namespace: Innovator.Client
Assembly: Innovator.Client (in Innovator.Client.dll) Version: 2016.1.15.1759 (2016.01.15.1759)
SyntaxThe IReadOnlyItem type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Context | Retrieve the context used for rendering primitive values (Inherited from IReadOnlyElement.) |
| Exists | Returns true if this element actually exists in the underlying AML,
otherwise, returns false to indicate that the element is just a null placeholder
put in place to reduce unnecessary null reference checks (Inherited from IReadOnlyElement.) |
| Name | Local XML name of the element (Inherited from IReadOnlyElement.) |
| Parent | Retrieve the parent element (Inherited from IReadOnlyElement.) |
| Value | String value of the element (Inherited from IReadOnlyElement.) |
Methods| Name | Description | |
|---|---|---|
 | AsResult |
Convert the Item to a Result object that can be returned by a server method
|
| Attribute | Retrieve the attribute with the specified name (Inherited from IReadOnlyElement.) |
| Attributes | Retrieve all attributes specified for the element (Inherited from IReadOnlyElement.) |
| Clone | Creates a duplicate of the item object. All properties (including the ID) are preserved |
| Elements | Retrieve all child elements (Inherited from IReadOnlyElement.) |
| Id | The ID of the item as retrieved from either the attribute or the property (Inherited from IItemRef.) |
| Property(String) | Returns a reference to the property with the specified name |
| Property(String, String) | Returns a reference to the property with the specified name and language |
| Relationships | Returns the set of relationships associated with this item |
| Relationships(String) | Returns the set of relationships associated with this item of the specified type |
| ToAml |
Render the node to a string
(Inherited from IAmlNode.) |
| ToAml(XmlWriter) |
Write the node to the specified XmlWriter (Inherited from IAmlNode.) |
| TypeName | The type of the item as retrieved from either the attribute or the property (Inherited from IItemRef.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Action | Retrieve the action attribute of the item (Defined by Core.) |
| Apply |
Apply this item in the database
(Defined by ItemExtensions.) |
| Classification | Retrieve the classification property of the item (Defined by Core.) |
| ClassStartsWith | Determine if the classification starts with one of the specified root paths (Defined by ItemExtensions.) |
| ConfigId | Retrieve the config_id property of the item (Defined by Core.) |
| CreatedById | Retrieve the created_by_id property of the item (Defined by Core.) |
 | CreatedOn | Retrieve the created_on property of the item (Defined by Core.) |
| Css | Retrieve the css property of the item (Defined by Core.) |
| CurrentState | Retrieve the current_state property of the item (Defined by Core.) |
| DoGetItem | Retrieve the doGetItem attribute of the item (Defined by Core.) |
| Edit |
Send an AML edit query to the database with the body of the Item tab being the contents specified
(Defined by ItemExtensions.) |
| FetchLockStatus |
Retrieve the lock status from the database
(Defined by ItemExtensions.) |
| Generation | Retrieve the generation property of the item (Defined by Core.) |
| IdList | Retrieve the idlist attribute of the item (Defined by Core.) |
| IsCurrent | Retrieve the is_current property of the item (Defined by Core.) |
| IsReleased | Retrieve the is_released property of the item (Defined by Core.) |
| KeyedName | Retrieve the keyed_name property of the item (Defined by Core.) |
| LazyMapT |
Maps an item to a new object. If there are properties which couldn't be found during the
initial mapping, the method will query the database and run the mapper again with the
database results
(Defined by ItemExtensions.) |
| Lock | (Defined by ItemExtensions.) |
| LockedById | Retrieve the locked_by_id property of the item (Defined by Core.) |
| LockStatus | (Defined by ItemExtensions.) |
| MajorRev | Retrieve the major_rev property of the item (Defined by Core.) |
| ManagedById | Retrieve the managed_by_id property of the item (Defined by Core.) |
| MaxRecords | Retrieve the maxRecords attribute of the item (Defined by Core.) |
| MinorRev | Retrieve the minor_rev property of the item (Defined by Core.) |
| ModifiedById | Retrieve the modified_by_id property of the item (Defined by Core.) |
| ModifiedOn | Retrieve the modified_on property of the item (Defined by Core.) |
| NewVersion | Retrieve the new_version property of the item (Defined by Core.) |
| NotLockable | Retrieve the not_lockable property of the item (Defined by Core.) |
| OrderBy | Retrieve the orderBy attribute of the item (Defined by Core.) |
| OwnedById | Retrieve the owned_by_id property of the item (Defined by Core.) |
| Page | Retrieve the page attribute of the item (Defined by Core.) |
| PageSize | Retrieve the pagesize attribute of the item (Defined by Core.) |
| PermissionId | Retrieve the permission_id property of the item (Defined by Core.) |
| Promote |
Promote the itme to the specified state
(Defined by ItemExtensions.) |
| QueryDate | Retrieve the queryDate attribute of the item (Defined by Core.) |
| QueryType | Retrieve the queryType attribute of the item (Defined by Core.) |
| RelatedExpand | Retrieve the related_expand attribute of the item (Defined by Core.) |
| RelatedId | Retrieve the related_id property of the item (Defined by Core.) |
| RelatedItem | Retrieve the value of the related_id property as an Item (Defined by Core.) |
| Select | Retrieve the select attribute of the item (Defined by Core.) |
| ServerEvents | Retrieve the serverEvents attribute of the item (Defined by Core.) |
| SourceId | Retrieve the source_id property of the item (Defined by Core.) |
| SourceItem | Retrieve the value of the source_id property as an Item (Defined by Core.) |
| State | Retrieve the state property of the item (Defined by Core.) |
| ToXml |
Renders an AML node to XML
(Defined by ItemExtensions.) |
| Type | Retrieve the type attribute of the item (Defined by Core.) |
| TypeId | Retrieve the typeId attribute of the item (Defined by Core.) |
| Unlock | (Defined by ItemExtensions.) |
| Where | Retrieve the where attribute of the item (Defined by Core.) |
See Also