| Syntax | $getDocumentItem{document_items_name}{default_value} |
| Documentation | Returns the value of the document named item:
Parameters:
document_items_name, the name of the document item whos value is requested.
default_value, a optional parameter used as a return value if the named document item does not exist on the current branch.
Returns:
the requested value of the named document item.
Throws:
java.lang.IllegalArgumentException if the requested document item does not exist on the current branch and no 'default_value' parameter specified. |
| Examples |
Requesting the value of a document item named 'some_doc' if exists on the current branch:
$set{name}{some_doc}
$if{$existsDocumentItem{$get{name}}}
{
$set{value}{$getDocumentItem{$get{name}}}
}
Requesting the value of a document item named 'some_doc' without examining its existance:
$set{value}{$getDocumentItem{some_doc}{some_default_value}}
The following call could cause an exception to be thrown:
$set{value}{$getDocumentItem{some_doc}} |
| Group | Branch |
| Minimum required transaction-mode: | READ |
| Required scripting permission of the developer | PERMISSION_FL_BASIC |
| Minimum parameters | 1 |
| Maximum parameters | 2 |