Applies the 'lock' action on the item and returns the server response.

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 11.0.0.6296

Syntax

C#
public Item lockItem()
Visual Basic (Declaration)
Public Function lockItem As Item
J#
public Item lockItem()
JScript
public function lockItem() : Item

Return Value

Response item from the server.

Remarks

The method sends a request to the server to lock the item. This is almost the equivalent to this.apply("lock") except that: a) the method checks that item's type and ID are set before sending the request; b) the method updates locked_by_id property of this item with the value obtained from the server if the server response is not an error.

Exceptions

ExceptionCondition
System..::.Exception
  • The instance doesn't represent a single item.
  • The item's type or ID is not set.

See Also