Class Item

Wraps an AML object with a API which is compatible with Aras's IOM

Inheritance

System.Object

Item

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Innovator.Client.IOM

Assembly: Innovator.Client.dll

Syntax

public class Item : IReadOnlyResult, IItem, IElement, IReadOnlyItem, IReadOnlyElement, IAmlNode, IItemRef, IEnumerable<Item>, IEnumerable

Properties

AmlContext

Retrieve the context used for rendering primitive values

Declaration

public ElementFactory AmlContext { get; }

Property Value

Type	Description
ElementFactory

Implements

IReadOnlyElement.AmlContext

Exception

Return an exception (if there is one), otherwise, return null

Declaration

public ServerException Exception { get; }

Property Value

Type	Description
ServerException

Implements

IReadOnlyResult.Exception

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

Declaration

public bool Exists { get; }

Property Value

Type	Description
System.Boolean

Implements

IReadOnlyElement.Exists

Message

Get messages (such as permissions warnings) from the database

Declaration

public IReadOnlyElement Message { get; }

Property Value

Type	Description
IReadOnlyElement

Implements

IReadOnlyResult.Message

Name

Local XML name of the element

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Implements

IReadOnlyElement.Name

Parent

Retrieve the parent element

Declaration

public IElement Parent { get; }

Property Value

Type	Description
IElement

Implements

IElement.Parent

Value

Return the string value of the result

Declaration

public string Value { get; }

Property Value

Type	Description
System.String

Implements

IReadOnlyResult.Value

IReadOnlyElement.Value

Methods

Add(Object)

Add new content to the element

Declaration

public IElement Add(object content)

Parameters

Type	Name	Description
System.Object	content	IElement, IAttribute, or System.Object to add as a child of the element

Returns

Type	Description
IElement	The current element for chaining additional calls

Implements

IElement.Add(Object)

addRelationship(Item)

Add specified item as a relationship item to the instance.

Declaration

public void addRelationship(Item item)

Parameters

Type	Name	Description
Item	item	Item(s) to be added to item's relationships.

appendItem(Item)

Appends the item.

Declaration

public void appendItem(Item item)

Parameters

Type	Name	Description
Item	item	Item to append.

apply()

Applies the AML.

Declaration

public Item apply()

Returns

Type	Description
Item	An Item containing result of the AML call

apply(String)

Sets the action property and applies the AML.

Declaration

public Item apply(string action)

Parameters

Type	Name	Description
System.String	action	The action.

Returns

Type	Description
Item	An Item containing result of the AML call

AssertItem(String)

Return a single item. If that is not possible, throw an appropriate exception (e.g. the exception returned by the server where possible)

Declaration

public IReadOnlyItem AssertItem(string type = null)

Parameters

Type	Name	Description
System.String	type	If specified, throw an exception if the item doesn't have the specified type

Returns

Type	Description
IReadOnlyItem	A single IReadOnlyItem

Implements

IReadOnlyResult.AssertItem(String)

Exceptions

Type	Condition
System.InvalidOperationException

AssertItems()

Return an enumerable of items. Throw an exception for any error including 'No items found'

Declaration

public IEnumerable<IReadOnlyItem> AssertItems()

Returns

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

Implements

IReadOnlyResult.AssertItems()

AssertNoError()

Do nothing other than throw an exception if there is an error other than 'No Items Found'

Declaration

public IReadOnlyResult AssertNoError()

Returns

Type	Description
IReadOnlyResult

Implements

IReadOnlyResult.AssertNoError()

Attribute(String)

Retrieve the attribute with the specified name

Declaration

public IAttribute Attribute(string name)

Parameters

Type	Name	Description
System.String	name	Name of the XML attribute

Returns

Type	Description
IAttribute	If the property exists, a valid IAttribute will be returned If the property does not exists, a "null" IAttribute will be returned where Exists = false

Implements

IElement.Attribute(String)

Attributes()

Retrieve all attributes specified for the element

Declaration

public IEnumerable<IAttribute> Attributes()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IAttribute>

Implements

IElement.Attributes()

Clone()

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

Declaration

public IItem Clone()

Returns

Type	Description
IItem	A mutable copy of the current item

Implements

IReadOnlyItem.Clone()

clone(Boolean)

Clones the item.

Declaration

public Item clone(bool cloneRelationships)

Parameters

Type	Name	Description
System.Boolean	cloneRelationships	If true, all relationships of the item are cloned as well.

Returns

Type	Description
Item	Cloned item.

Remarks

Cloned item as well as cloned relationships have new IDs and action attributes set to 'add'.

createPropertyItem(String, String, String)

Creates an item with the specified type and action and sets it as the specified property of this item.

Declaration

public Item createPropertyItem(string propName, string type, string action)

Parameters

Type	Name	Description
System.String	propName	Name of the property.
System.String	type	Type of the item property.
System.String	action	Name of the action that will be set on the item property.

Returns

Type	Description
Item	Created item with the specified type and action.

Remarks

The method is similar to setPropertyItem(String, Item) except that setPropertyItem(String, Item) gets an item as the method argument and doesn't create it internally.

createRelatedItem(String, String)

Creates an item with the specified type and action and sets it as the related item on this item.

Declaration

public Item createRelatedItem(string type, string action)

Parameters

Type	Name	Description
System.String	type	Type of the related item.
System.String	action	Name of the action that will be set on created related item.

Returns

Type	Description
Item	Created related item with specified type and action.

Remarks

If property related_id doesn't exist on this item, it's created. The method is similar to setRelatedItem(Item) except that setRelatedItem(Item) gets the related item as a method argument and doesn't create it internally.

createRelationship(String, String)

Creates new <Item> node with specified 'type' and 'action' under <Relationships> node.

Declaration

public Item createRelationship(string type, string action)

Parameters

Type	Name	Description
System.String	type	Value of attribute 'type' that will be set on the created <Item> node.
System.String	action	Value of attribute 'action' that will be set on the created <Item> node.

Returns

Type	Description
Item	Item that reference newly created <Item> node.

Remarks

If a <Relationships> node doesn't exist, it's created.

Elements()

Retrieve all child elements

Declaration

public IEnumerable<IElement> Elements()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IElement>

Implements

IElement.Elements()

fetchDefaultPropertyValues(Boolean)

Fetches from server default values for all properties of the item's ItemType and sets them on the item.

Declaration

public Item fetchDefaultPropertyValues(bool overwrite_current)

Parameters

Type	Name	Description
System.Boolean	overwrite_current	If true, overwrite existing property values.

Returns

Type	Description
Item	If fetching failed, returns "error" item that contains information about the failure. Otherwise, returns this with set property values.

Remarks

If a property doesn't have a default value, the property is not set.

fetchLockStatus()

Fetches from the server the locked status of the item using the item's ID.

Declaration

public int fetchLockStatus()

Returns

Type	Description
System.Int32	Value Meaning -1 failed to fetch item's lock status from server 0 0 not locked 1 1 locked by user 2 2 locked by other

Remarks

The method sends a request to the server in order to fetch the latest lock status of the item on server and updates the item's property locked_by_id.

fetchRelationships(String)

Fetches relationships of specified type from the server and sets them on the item.

Declaration

public Item fetchRelationships(string relationshipTypeName)

Parameters

Type	Name	Description
System.String	relationshipTypeName	Name of the relationship type.

Returns

Type	Description
Item	It returns this.

Exceptions

Type	Condition
ServerException	If an error was returned from the server

fetchRelationships(String, String)

Fetches relationships of specified type from the server and sets them on the item.

Declaration

public Item fetchRelationships(string relationshipTypeName, string selectList)

Parameters

Type	Name	Description
System.String	relationshipTypeName	Name of the relationship type.
System.String	selectList	Select list that is set on attribute select of the request

Returns

Type	Description
Item	It returns this.

Exceptions

Type	Condition
ServerException	If an error was returned from the server

fetchRelationships(String, String, String)

Fetches relationships of specified type from the server and sets them on the item.

Declaration

public Item fetchRelationships(string relationshipTypeName, string selectList, string orderBy)

Parameters

Type	Name	Description
System.String	relationshipTypeName	Name of the relationship type.
System.String	selectList	Select list that is set on attribute select of the request
System.String	orderBy	The value is set on attribute orderBy of the request

Returns

Type	Description
Item	It returns this.

Exceptions

Type	Condition
ServerException	If an error was returned from the server

getAction()

Returns the action attribute from the Item node.

Declaration

public string getAction()

Returns

Type	Description
System.String	Value of the action attribute if the attribute exists, null otherwise

getAttribute(String)

Returns value of the attribute with the specified name on the item's node.

Declaration

public string getAttribute(string attributeName)

Parameters

Type	Name	Description
System.String	attributeName	The qualified name of the attribute.

Returns

Type	Description
System.String	Attribute value or null if the attribute doesn't exist

getAttribute(String, String)

Returns value of the attribute with the specified name on the item's node.

Declaration

public string getAttribute(string attributeName, string defaultValue)

Parameters

Type	Name	Description
System.String	attributeName	The qualified name of the attribute.
System.String	defaultValue	Default value of the attribute.

Returns

Type	Description
System.String	Attribute value or defaultValue if the attribute doesn't exist

GetEnumerator()

Returns an enumerator that iterates through the items in the collection.

Declaration

public IEnumerator<Item> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<Item>	An enumerator that can be used to iterate through the items in the collection.

Implements

System.Collections.Generic.IEnumerable<T>.GetEnumerator()

getErrorCode()

Gets the error code of the "error" item.

Declaration

public string getErrorCode()

Returns

Type	Description
System.String	Value of <faultcode>. If the item is not an "error" item, null is returned.

getErrorDetail()

Returns details of the error item.

Declaration

public string getErrorDetail()

Returns

Type	Description
System.String	If the instance is not an error item, null is returned.

Remarks

In most cases error details contains a low level error details (e.g. actual SQL error message) obtained from server.

getErrorSource()

Returns the content of the <faultactor> element of SOAP Fault element.

Declaration

public string getErrorSource()

Returns

Type	Description
System.String	If the instance is not an error item, null is returned.

getErrorString()

Returns the error message.

Declaration

public string getErrorString()

Returns

Type	Description
System.String	The returned value is obtained from the <faultstring> tag of <Fault>. If the instance is not an error item, null is returned.

getID()

Returns ID of the Item node. According to AML standard ID could be set on <Item> either as the attribute with name 'id' or as a sub-tag <id> (i.e. item property) or both.

Declaration

public string getID()

Returns

Type	Description
System.String	ID of the item or null if ID was not found.

getInnovator()

Returns instance of Innovator this Item "belongs" to.

Declaration

public Innovator getInnovator()

Returns

Type	Description
Innovator	An Innovator for creating AML

getItemByIndex(Int32)

Gets an item by index.

Declaration

public Item getItemByIndex(int index)

Parameters

Type	Name	Description
System.Int32	index	The 0-based index.

Returns

Type	Description
Item	Found item

getItemCount()

Returns the number of items that the instance represents.

Declaration

public int getItemCount()

Returns

Type	Description
System.Int32	Value Condition 0 The item contains an exception of type NoItemsFoundException -1 The item is not NoItemsFoundException and does not contain any items N Where N >= 1 and N is the number of items contained in the instance

getLockStatus()

Gets item's lock status based on the property locked_by_id.

Declaration

public int getLockStatus()

Returns

Type	Description
System.Int32	Like with the LockStatusType enumeration, the values are Value Description 0 The item is not locked 1 The item is locked by the user 2 The item is locked by the someone else

getNewID()

Generate new 32 character hex string globally unique identifier.

Declaration

public string getNewID()

Returns

Type	Description
System.String	GUID as a string

getParentItem()

Returns a parent item of the instance.

Declaration

public Item getParentItem()

Returns

Type	Description
Item	If there is no parent, null is returned

getProperty(String)

Gets value of the property with the specified name.

Declaration

public string getProperty(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.

Returns

Type

Description

System.String

If the property is an item-property, ID of the item-property is returned. If the property doesn't exist or it's an item-property without ID, null is returned; otherwise the method returns value of the specified property. Note, that if the property has attribute is_null set to 1 and the property value is empty string (e.g. <p1 is_null='1'/> or <p1 is_null='1'></p1>) then the property value is interpreted as null.

getProperty(String, String)

Gets value of the property with the specified name.

Declaration

public string getProperty(string propertyName, string defaultValue)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.
System.String	defaultValue	Default value of the property.

Returns

Type

Description

System.String

If the property is an item-property, ID of the item-property is returned. If the property doesn't exist or it's an item-property without ID, defaultValue is returned; otherwise the method returns value of the specified property. Note, that if the property has attribute is_null set to 1 and the property value is empty string (e.g. <p1 is_null='1'/> or <p1 is_null='1'></p1>) then the property value is interpreted as null.

getProperty(String, String, String)

Gets value of the property with the specified name.

Declaration

public string getProperty(string propertyName, string defaultValue, string lang)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.
System.String	defaultValue	Default value of the property.
System.String	lang	Language for which the property value has to be returned. If null value is passed, the language of the current session is assumed.

Returns

Type

Description

System.String

If the property is an item-property, ID of the item-property is returned. If the property doesn't exist or it's an item-property without ID, defaultValue is returned; otherwise the method returns value of the specified property. Note, that if the property has attribute is_null set to 1 and the property value is empty string (e.g. <p1 is_null='1'/> or <p1 is_null='1'></p1>) then the property value is interpreted as null.

getPropertyAttribute(String, String)

Declaration

public string getPropertyAttribute(string propertyName, string attributeName)

Parameters

Type	Name	Description
System.String	propertyName
System.String	attributeName

Returns

Type	Description
System.String

getPropertyAttribute(String, String, String)

Declaration

public string getPropertyAttribute(string propertyName, string attributeName, string defaultValue)

Parameters

Type	Name	Description
System.String	propertyName
System.String	attributeName
System.String	defaultValue

Returns

Type	Description
System.String

getPropertyAttribute(String, String, String, String)

Declaration

public string getPropertyAttribute(string propertyName, string attributeName, string defaultValue, string lang)

Parameters

Type	Name	Description
System.String	propertyName
System.String	attributeName
System.String	defaultValue
System.String	lang

Returns

Type	Description
System.String

getPropertyCondition(String)

Declaration

public string getPropertyCondition(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
System.String

getPropertyCondition(String, String)

Declaration

public string getPropertyCondition(string propertyName, string lang)

Parameters

Type	Name	Description
System.String	propertyName
System.String	lang

Returns

Type	Description
System.String

getPropertyItem(String)

Declaration

public Item getPropertyItem(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
Item

getRelatedItem()

Declaration

public Item getRelatedItem()

Returns

Type	Description
Item

getRelatedItemID()

Declaration

public string getRelatedItemID()

Returns

Type	Description
System.String

getRelationships()

Declaration

public Item getRelationships()

Returns

Type	Description
Item

getRelationships(String)

Declaration

public Item getRelationships(string itemTypeName)

Parameters

Type	Name	Description
System.String	itemTypeName

Returns

Type	Description
Item

getResult()

Declaration

public string getResult()

Returns

Type	Description
System.String

getType()

Declaration

public string getType()

Returns

Type	Description
System.String

Id()

The ID of the item as retrieved from either the attribute or the property

Declaration

public string Id()

Returns

Type	Description
System.String

Implements

IItemRef.Id()

isCollection()

Declaration

public bool isCollection()

Returns

Type	Description
System.Boolean

isEmpty()

Declaration

public bool isEmpty()

Returns

Type	Description
System.Boolean

isError()

Declaration

public bool isError()

Returns

Type	Description
System.Boolean

isLogical()

Declaration

public bool isLogical()

Returns

Type	Description
System.Boolean

isNew()

Declaration

public bool isNew()

Returns

Type	Description
System.Boolean

isRoot()

Declaration

public bool isRoot()

Returns

Type	Description
System.Boolean

Items()

Return an enumerable of items. Throw an exception if there is an error other than 'No Items Found'

Declaration

public IEnumerable<IReadOnlyItem> Items()

Returns

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

Implements

IReadOnlyResult.Items()

loadAML(String)

Declaration

public void loadAML(string AML)

Parameters

Type	Name	Description
System.String	AML

newItem()

Declaration

public Item newItem()

Returns

Type	Description
Item

newItem(String)

Declaration

public Item newItem(string itemTypeName)

Parameters

Type	Name	Description
System.String	itemTypeName

Returns

Type	Description
Item

newItem(String, String)

Declaration

public Item newItem(string itemTypeName, string action)

Parameters

Type	Name	Description
System.String	itemTypeName
System.String	action

Returns

Type	Description
Item

promote(String, String)

Declaration

public Item promote(string state, string comments)

Parameters

Type	Name	Description
System.String	state
System.String	comments

Returns

Type	Description
Item

Property(String)

Returns a reference to the property with the specified name

Declaration

public IProperty Property(string name)

Parameters

Type	Name	Description
System.String	name	Name of the property

Returns

Type	Description
IProperty	If the property exists, a valid IProperty will be returned If the property does not exists, a "null" IProperty will be returned where Exists = false

Implements

IItem.Property(String)

Remarks

If the property does not exist, a non-null object will be returned that has an Exists member which will return false

Property(String, String)

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

Declaration

public IProperty 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
IProperty	If the property exists, a valid IProperty will be returned If the property does not exists, a "null" IProperty will be returned where Exists = false

Implements

IItem.Property(String, String)

Remarks

If the property does not exist, a non-null object will be returned that has an Exists member which will return false

Exceptions

Type	Condition
System.InvalidOperationException

Relationships()

Returns the set of relationships associated with this item

Declaration

public IRelationships Relationships()

Returns

Type	Description
IRelationships

Implements

IItem.Relationships()

Relationships(String)

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

Declaration

public IEnumerable<IItem> 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<IItem>

Implements

IItem.Relationships(String)

Remove()

Remove the element from its parent

Declaration

public void Remove()

Implements

IElement.Remove()

removeAttribute(String)

Declaration

public void removeAttribute(string attributeName)

Parameters

Type	Name	Description
System.String	attributeName

RemoveAttributes()

Remove attributes from the element

Declaration

public void RemoveAttributes()

Implements

IElement.RemoveAttributes()

removeItem(Item)

Declaration

public void removeItem(Item item)

Parameters

Type	Name	Description
Item	item

RemoveNodes()

Remove child nodes from the element

Declaration

public void RemoveNodes()

Implements

IElement.RemoveNodes()

removeProperty(String)

Declaration

public void removeProperty(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

removeProperty(String, String)

Declaration

public void removeProperty(string propertyName, string lang)

Parameters

Type	Name	Description
System.String	propertyName
System.String	lang

removePropertyAttribute(String, String)

Declaration

public void removePropertyAttribute(string propertyName, string attributeName)

Parameters

Type	Name	Description
System.String	propertyName
System.String	attributeName

removePropertyAttribute(String, String, String)

Declaration

public void removePropertyAttribute(string propertyName, string attributeName, string lang)

Parameters

Type	Name	Description
System.String	propertyName
System.String	attributeName
System.String	lang

removeRelationship(Item)

Declaration

public void removeRelationship(Item item)

Parameters

Type	Name	Description
Item	item

setAction(String)

Declaration

public void setAction(string action)

Parameters

Type	Name	Description
System.String	action

setAttribute(String, String)

Declaration

public void setAttribute(string attributeName, string attributeValue)

Parameters

Type	Name	Description
System.String	attributeName
System.String	attributeValue

setID(String)

Declaration

public void setID(string id)

Parameters

Type	Name	Description
System.String	id

setNewId()

Declaration

public void setNewId()

setProperty(String, Object)

Declaration

public void setProperty(string propertyName, object propertyValue)

Parameters

Type	Name	Description
System.String	propertyName
System.Object	propertyValue

setProperty(String, Object, String)

Declaration

public void setProperty(string propertyName, object propertyValue, string lang)

Parameters

Type	Name	Description
System.String	propertyName
System.Object	propertyValue
System.String	lang

setPropertyAttribute(String, String, String)

Declaration

public void setPropertyAttribute(string propertyName, string attributeName, string attributeValue)

Parameters

Type	Name	Description
System.String	propertyName
System.String	attributeName
System.String	attributeValue

setPropertyAttribute(String, String, String, String)

Declaration

public void setPropertyAttribute(string propertyName, string attributeName, string attributeValue, string lang)

Parameters

Type	Name	Description
System.String	propertyName
System.String	attributeName
System.String	attributeValue
System.String	lang

setPropertyCondition(String, String)

Declaration

public void setPropertyCondition(string propertyName, string condition)

Parameters

Type	Name	Description
System.String	propertyName
System.String	condition

setPropertyCondition(String, String, String)

Declaration

public void setPropertyCondition(string propertyName, string condition, string lang)

Parameters

Type	Name	Description
System.String	propertyName
System.String	condition
System.String	lang

setPropertyItem(String, Item)

Declaration

public Item setPropertyItem(string propertyName, Item item)

Parameters

Type	Name	Description
System.String	propertyName
Item	item

Returns

Type	Description
Item

setRelatedItem(Item)

Declaration

public void setRelatedItem(Item ritem)

Parameters

Type	Name	Description
Item	ritem

setType(String)

Declaration

public void setType(string itemTypeName)

Parameters

Type	Name	Description
System.String	itemTypeName

ToAml(XmlWriter, AmlWriterSettings)

Write the node to the specified System.Xml.XmlWriter as AML

Declaration

public void ToAml(XmlWriter writer, AmlWriterSettings settings)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	System.Xml.XmlWriter to write the node to
AmlWriterSettings	settings	Settings controlling how the node is written

Implements

IAmlNode.ToAml(XmlWriter, AmlWriterSettings)

ToAmlRoot()

Returns the AML of the root parent

Declaration

public string ToAmlRoot()

Returns

Type	Description
System.String	The AML of the root parent

ToString()

Returns a System.String that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

Overrides

System.Object.ToString()

TypeName()

The type of the item as retrieved from either the attribute or the property

Declaration

public string TypeName()

Returns

Type	Description
System.String

Implements

IItemRef.TypeName()

Explicit Interface Implementations

IReadOnlyElement.Attribute(String)

Declaration

IReadOnlyAttribute IReadOnlyElement.Attribute(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
IReadOnlyAttribute

Implements

IReadOnlyElement.Attribute(String)

IReadOnlyElement.Attributes()

Declaration

IEnumerable<IReadOnlyAttribute> IReadOnlyElement.Attributes()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IReadOnlyAttribute>

Implements

IReadOnlyElement.Attributes()

IReadOnlyElement.Elements()

Declaration

IEnumerable<IReadOnlyElement> IReadOnlyElement.Elements()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IReadOnlyElement>

Implements

IReadOnlyElement.Elements()

IReadOnlyElement.Parent

Retrieve the parent element

Declaration

IReadOnlyElement IReadOnlyElement.Parent { get; }

Returns

Type	Description
IReadOnlyElement

Implements

IReadOnlyElement.Parent

IReadOnlyItem.Property(String)

Declaration

IReadOnlyProperty IReadOnlyItem.Property(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
IReadOnlyProperty

Implements

IReadOnlyItem.Property(String)

IReadOnlyItem.Property(String, String)

Declaration

IReadOnlyProperty IReadOnlyItem.Property(string name, string lang)

Parameters

Type	Name	Description
System.String	name
System.String	lang

Returns

Type	Description
IReadOnlyProperty

Implements

IReadOnlyItem.Property(String, String)

IReadOnlyItem.Relationships()

Declaration

IEnumerable<IReadOnlyItem> IReadOnlyItem.Relationships()

Returns

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

Implements

IReadOnlyItem.Relationships()

IReadOnlyItem.Relationships(String)

Declaration

IEnumerable<IReadOnlyItem> IReadOnlyItem.Relationships(string type)

Parameters

Type	Name	Description
System.String	type

Returns

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

Implements

IReadOnlyItem.Relationships(String)

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

Implements

System.Collections.IEnumerable.GetEnumerator()

Extension Methods

Core.Action(IItem)

Core.DoGetItem(IItem)

Core.IdList(IItem)

Core.MaxRecords(IItem)

Core.OrderBy(IItem)

Core.Page(IItem)

Core.PageSize(IItem)

Core.QueryDate(IItem)

Core.QueryType(IItem)

Core.RelatedExpand(IItem)

Core.Select(IItem)

Core.ServerEvents(IItem)

Core.Type(IItem)

Core.TypeId(IItem)

Core.Where(IItem)

Core.Classification(IItem)

Core.ConfigId(IItem)

Core.CreatedById(IItem)

Core.CreatedOn(IItem)

Core.Css(IItem)

Core.CurrentState(IItem)

Core.Generation(IItem)

Core.IdProp(IItem)

Core.IsCurrent(IItem)

Core.IsReleased(IItem)

Core.KeyedName(IItem)

Core.LockedById(IItem)

Core.MajorRev(IItem)

Core.ManagedById(IItem)

Core.MinorRev(IItem)

Core.ModifiedById(IItem)

Core.ModifiedOn(IItem)

Core.NewVersion(IItem)

Core.NotLockable(IItem)

Core.OwnedById(IItem)

Core.PermissionId(IItem)

Core.RelatedId(IItem)

Core.RelatedItem(IItem)

Core.State(IItem)

Core.SourceId(IItem)

Core.SourceItem(IItem)

Core.TeamId(IItem)

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.AssertItem<T>(IReadOnlyResult)

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.FirstOrNullElement(IEnumerable<IElement>)

ItemExtensions.FirstOrNullItem<T>(IEnumerable<T>)

ItemExtensions.FirstOrNullItem<T>(IEnumerable<T>, Func<T, Boolean>)

ItemExtensions.ItemMax(IReadOnlyResult)

ItemExtensions.ItemsWithNoAccessCount(IReadOnlyResult)

ItemExtensions.Lock(IItemRef, IConnection)

ItemExtensions.LockStatus(IReadOnlyItem, IConnection)

ItemExtensions.Add(IElement, Object[])

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.CreateReader(IReadOnlyResult)

ItemExtensions.Parents(IReadOnlyElement)

ItemExtensions.ParentsAndSelf(IReadOnlyElement)

ItemExtensions.InnerText(IReadOnlyElement)

Extensions.GroupConcat<T>(IEnumerable<T>, String, Func<T, String>)