Show / Hide Table of Contents

Interface IReadOnlyItem

Represents an Aras Item that is read only. By default, the connection object returns IReadOnlyItems to encouarge treating the results as immutable

Inherited Members
IReadOnlyElement.Attribute(String)
IReadOnlyElement.Attributes()
IReadOnlyElement.Elements()
IReadOnlyElement.AmlContext
IReadOnlyElement.Exists
IReadOnlyElement.Name
IReadOnlyElement.Parent
IReadOnlyElement.Value
IAmlNode.ToAml(XmlWriter, AmlWriterSettings)
IItemRef.Id()
IItemRef.TypeName()
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public interface IReadOnlyItem : IReadOnlyElement, IAmlNode, IItemRef
Remarks

An IReadOnlyItem only ever represents a single Item AML tag. It never represents multiple items, a string, or an exception

<Item>
 <prop1>a</prop1>
 <prop2>b</prop2>
</Item>

Methods

| Improve this Doc View Source

Clone()

Creates a duplicate of the item object. All properties (including the ID) are preserved

Declaration
IItem Clone()
Returns
Type Description
IItem

A mutable copy of the current item

| Improve this Doc View Source

Property(String)

Returns a reference to the property with the specified name

Declaration
IReadOnlyProperty Property(string name)
Parameters
Type Name Description
System.String name

Name of the property

Returns
Type Description
IReadOnlyProperty
  • If the property exists, a valid IReadOnlyProperty will be returned
  • If the property does not exists, a "null" IReadOnlyProperty will be returned where Exists = false
| Improve this Doc View Source

Property(String, String)

Returns a reference to the property with the specified name and language

Declaration
IReadOnlyProperty Property(string name, string lang)
Parameters
Type Name Description
System.String name

Name of the property

System.String lang

Language of the (multilingual) property

Returns
Type Description
IReadOnlyProperty
  • If the property exists, a valid IReadOnlyProperty will be returned
  • If the property does not exists, a "null" IReadOnlyProperty will be returned where Exists = false
| Improve this Doc View Source

Relationships()

Returns the set of relationships associated with this item

Declaration
IEnumerable<IReadOnlyItem> Relationships()
Returns
Type Description
System.Collections.Generic.IEnumerable<IReadOnlyItem>

An System.Collections.Generic.IEnumerable<T> containing all relationship items

| Improve this Doc View Source

Relationships(String)

Returns the set of relationships associated with this item of the specified type

Declaration
IEnumerable<IReadOnlyItem> Relationships(string type)
Parameters
Type Name Description
System.String type

Name of the ItemType for the relationships you wish to retrieve

Returns
Type Description
System.Collections.Generic.IEnumerable<IReadOnlyItem>

An System.Collections.Generic.IEnumerable<T> containing relationship items whose type name is equal to type

Extension Methods

Core.Action(IReadOnlyItem)
Core.DoGetItem(IReadOnlyItem)
Core.IdList(IReadOnlyItem)
Core.MaxRecords(IReadOnlyItem)
Core.OrderBy(IReadOnlyItem)
Core.Page(IReadOnlyItem)
Core.PageSize(IReadOnlyItem)
Core.QueryDate(IReadOnlyItem)
Core.QueryType(IReadOnlyItem)
Core.RelatedExpand(IReadOnlyItem)
Core.Select(IReadOnlyItem)
Core.ServerEvents(IReadOnlyItem)
Core.Type(IReadOnlyItem)
Core.TypeId(IReadOnlyItem)
Core.Where(IReadOnlyItem)
Core.Classification(IReadOnlyItem)
Core.ConfigId(IReadOnlyItem)
Core.CreatedById(IReadOnlyItem)
Core.CreatedOn(IReadOnlyItem)
Core.Css(IReadOnlyItem)
Core.CurrentState(IReadOnlyItem)
Core.Generation(IReadOnlyItem)
Core.IdProp(IReadOnlyItem)
Core.IsCurrent(IReadOnlyItem)
Core.IsReleased(IReadOnlyItem)
Core.KeyedName(IReadOnlyItem)
Core.LockedById(IReadOnlyItem)
Core.MajorRev(IReadOnlyItem)
Core.ManagedById(IReadOnlyItem)
Core.MinorRev(IReadOnlyItem)
Core.ModifiedById(IReadOnlyItem)
Core.ModifiedOn(IReadOnlyItem)
Core.NewVersion(IReadOnlyItem)
Core.NotLockable(IReadOnlyItem)
Core.OwnedById(IReadOnlyItem)
Core.PermissionId(IReadOnlyItem)
Core.RelatedId(IReadOnlyItem)
Core.RelatedItem(IReadOnlyItem)
Core.State(IReadOnlyItem)
Core.SourceId(IReadOnlyItem)
Core.SourceItem(IReadOnlyItem)
Core.TeamId(IReadOnlyItem)
ItemExtensions.AsResult(IReadOnlyItem)
ItemExtensions.ToAml(IAmlNode, AmlWriterSettings)
ItemExtensions.ToAml(IAmlNode, XmlWriter)
ItemExtensions.Apply(IReadOnlyItem, IConnection)
ItemExtensions.ApplyAsync(IReadOnlyItem, IAsyncConnection)
ItemExtensions.ApplyAsync(IReadOnlyItem, IAsyncConnection, CancellationToken)
ItemExtensions.ClassStartsWith(IReadOnlyItem, String[])
ItemExtensions.Edit(IItemRef, IConnection, Object[])
ItemExtensions.FetchLockStatus(IItemRef, IConnection)
ItemExtensions.Element(IReadOnlyElement, String)
ItemExtensions.Lock(IItemRef, IConnection)
ItemExtensions.LockStatus(IReadOnlyItem, IConnection)
ItemExtensions.Promote(IItemRef, IConnection, String, String)
ItemExtensions.ToXml(IAmlNode)
ItemExtensions.Unlock(IItemRef, IConnection)
ItemExtensions.LazyMap<T>(IReadOnlyItem, IConnection, Func<IReadOnlyItem, T>)
ItemExtensions.CreateReader(IReadOnlyElement)
ItemExtensions.Parents(IReadOnlyElement)
ItemExtensions.ParentsAndSelf(IReadOnlyElement)
ItemExtensions.InnerText(IReadOnlyElement)
  • Improve this Doc
  • View Source
Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX