Promote item to the specified state.

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

Syntax

C#
public Item promote(
	string state,
	string comments
)
Visual Basic (Declaration)
Public Function promote ( _
	state As String, _
	comments As String _
) As Item
J#
public Item promote(
	String state,
	String comments
)
JScript
public function promote(
	state : String, 
	comments : String
) : Item

Parameters

state
Type: System..::.String
State to promote.
comments
Type: System..::.String
If ItemType of the item is configured to log "history" records when items of the ItemType are created\promoted\etc., (i.e. if the ItemType's property "save_history" is set to "1") then the comments will be used as a comment for the "history" record about the promote event.

Return Value

"Result" item with inner text "Ok" in case of success. Otherwise "error" item (if promote failed).

Remarks

The method sends a request to the server to promote item and returns the response. Note that this item is not modified by the method.

Exceptions

ExceptionCondition
System..::.ExceptionThe instance doesn't represent a single item.
System..::.ArgumentExceptionArgument 'state' is either 'null' or an empty string.

See Also