Promote item to the specified state.
Namespace:
Aras.IOM
Assembly:
IOM (in IOM.dll) Version: 14.0.9.36244
Syntaxpublic Item promote(
string state,
string comments
)
Public Function promote (
state As String,
comments As String
) As Item
public Item promote(
String state,
String comments
)
public function promote(
state : String,
comments : String
) : Item
Parameters
- state
- Type: SystemString
State to promote. - comments
- Type: SystemString
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
Type:
Item"Result" item with inner text "Ok" in case of success. Otherwise "error" item (if promote failed).
ExceptionsException | Condition |
---|
Exception | The instance doesn't represent a single item. |
ArgumentException | Argument 'state' is either 'null' or an empty string. |
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.
See Also