Item Methods |
The Item type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | addRelationship |
Add specified item as a relationship item to the instance.
|
| appendItem |
Appends passed item to this.nodeList.
|
| apply |
Applies the AML, which is the XML of this.dom.
|
| apply(Hashtable) |
Sets specified properties and applies the AML, which is the XML of this.dom.
|
| apply(String) |
Sets action attribute on the item and applies the AML, which is the XML of this.dom.
|
| apply(String, Hashtable) |
Sets action attribute on the item; sets specified properties and applies the AML,
which is the XML of this.dom.
|
| apply(String, Hashtable, String) | Obsolete.
Applies the AML, which is the XML of 'this.dom'.
|
| applyStylesheet |
Performs XSL transformation of the item's DOM and returns the result of the transformation.
IMPORTANT: Be very carefull when using slylesheets from untrusted urls, there's a possibility to use scripts in the stylesheets with the code that can cause damage.
Make sure that the stylesheet doesn't contain intrader's script code before using.
|
| attachPhysicalFile(String) |
Attach physical file to the item. Calling the method means that the physical will be streamed to the server
when apply() is called on the item.
|
| attachPhysicalFile(String, String) | Obsolete.
Attach physical file to the item. Calling the method means that the physical will be streamed to the server
when apply() is called on the item.
|
| attachPhysicalFileViaStream |
Attach physical file as a stream to the item. Calling the method means that the physical will be streamed to the server
when apply() is called on the item.
|
| cancelWorkflow | Obsolete.
Cancels the workflow process. Item's type must be "Workflow Process".
|
 | checkout |
Checkout physical file from the vault to the specified local directory.
|
| clone |
Clones the item.
|
| closeWorkflow | Obsolete.
Closes the workflow process. Item's type must be "Workflow Process".
|
| createPropertyItem |
Creates an item with the specified type and action and sets it as the specified property of this item.
|
| createRelatedItem |
Creates an item with the specified type and action and sets it as the related item on this item.
|
| createRelationship |
Creates new <Item> node with specified 'type' and 'action' under <Relationships> node
inside this.node.
|
|
Send e-mail to the specified identity. In order to do so, the method sends a special
request to the Innovator server.
| |
| fetchDefaultPropertyValues |
Fetches from server default values for all properties of the item's ItemType and sets them on the item.
|
| fetchFileProperty |
Downloads a file to target path.
|
| fetchFilePropertyWithStream |
Downloads a file to target path via stream
|
| fetchLockStatus |
Fetches from the server the locked status of the item using the item's ID.
|
| fetchRelationships(String) |
Fetches relationships of specified type from the server and sets them on the item.
|
| fetchRelationships(String, String) |
Fetches relationships of specified type from the server and sets them on the item. Specified
select list will be set on the request AML.
|
| fetchRelationships(String, String, String) |
Fetches relationships of specified type from the server and sets them on the item. Specified
select list and order are set on the request AML.
|
| getAction |
Returns the 'action' attribute from the Item node.
|
| getAttribute(String) |
Returns value of the attribute with the specified name on the item's node.
|
| getAttribute(String, String) |
Returns value of the attribute with the specified name on the item's node.
|
| getErrorCode |
Gets error code of the "error" item.
|
| getErrorDetail |
Returns details of the error item.
|
| getErrorSource |
Returns the content of the <faultactor> element of SOAP Fault element.
|
| getErrorString |
Returns the error message.
|
| getErrorWho | Obsolete.
Same as getErrorCode().
|
| getFileName | Obsolete.
Returns the filename for the attached file.
This is only is meaningful if the type="File", otherwise throws an exception.
|
| 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.
|
| getInnovator |
Returns instance of Innovator this Item "belongs" to.
|
| getItemByIndex |
Gets an item by index.
|
| getItemCount |
Returns the number of items that the instance represents.
|
| getItemsByXPath |
Gets an item (single or collection) resolving xpath specified.
|
| getLockStatus |
Gets item's lock status based on the property locked_by_id.
|
| getLogicalChildren |
Returns Item object with the nodeList containing logical nodes that are children of the this.node.
|
| getLogicalItems | Obsolete.
Returns the Item object with the nodeList containing all logical nodes of this.node.
|
| getNewID |
Generate new 32 character hex string globally unique identifier.
|
| getParentItem |
Returns a parent item of the instance.
|
| getProperty(String) |
Gets value of the property with the specified name.
|
| getProperty(String, String) |
Gets value of the property with the specified name.
|
| getProperty(String, String, String) |
Gets value of the property with the specified name.
|
| getPropertyAttribute(String, String) |
Gets the specified attribute of the property with the specified name.
|
| getPropertyAttribute(String, String, String) |
Gets the specified attribute of the property with the specified name.
|
| getPropertyAttribute(String, String, String, String) |
Gets the specified attribute of the property with the specified name and language.
|
| getPropertyCondition(String) |
Gets the 'condition' attribute of the property with the specified name.
|
| getPropertyCondition(String, String) |
Gets the 'condition' attribute of the property with the specified name and language.
|
| getPropertyItem |
Gets item-property by name.
|
| getRelatedItem |
Gets related item of the relationship.
|
| getRelatedItemID |
Tries to find related item (xpath: "./related_id") on item's node and
returns its ID.
|
| getRelationships |
Returns an item that is a collection of all relationships items available on the instance.
|
| getRelationships(String) |
Returns an item that is a collection of relationships item with specified type available on the instance.
|
| getRelationships(String, String) | Obsolete.
Returns an item that is a collection of relationship item with specified type; each relationship item has
only properties specified in the select list.
|
| getRelationships(String, String, String) | Obsolete.
Returns an item that is a collection of relationship item with specified type; each relationship item has
only properties specified in the select list.
|
| getResult |
Returns 'InnerText' property of ArasXmlNode with xpath = Item.XPathResult from the
item's dom.
|
| getType |
Returns value of the 'type' attribute of the Item node.
|
| instantiateWorkflow |
Instantiates workflow for the item using specified workflow map.
|
| isCollection |
Checks if the instance represents a set of items and not a single item.
|
| isEmpty |
This is the replacement for the old hasFault() function
with the Boolean argument of false to indicate to ignore the zero based faults.
|
| isError |
Checks if the item is an "error item".
|
| isLocked | Obsolete.
Fetches from the server the locked status of the item using the item's ID.
|
| isLogical |
Find out if the item's node is a "logical" node ("AND", "OR", "NOT").
|
| isNew |
Checks the attribute 'isNew' on the item.
|
| isRoot |
Checks if this.node is the root item in this.dom.
|
| loadAML |
This loads the dom property for the Item object with the passed AML.
The method will also set the node and nodeList properties for the Item object
according to the content of the loaded AML.
|
| lockItem |
Applies the 'lock' action on the item and returns the server response.
|
| newAND |
Inserts logical node with tag <and> under the parent node, which can be Item or Logical,
and returns an Item Object that represents a newly inserted logical node.
|
| newInnovator | Obsolete.
Creates a new Innovator object.
|
| newItem |
Returns a new Item.
|
| newItem(String) |
Returns a new Item with the specified type.
|
| newItem(String, String) |
Returns a new Item with the specified type and action.
|
| newNOT |
Inserts logical node with tag <not> under the parent node, which can be Item or Logical,
and returns an Item Object that represents a newly inserted logical node.
|
| newOR |
Inserts logical node with tag <or> under the parent node, which can be Item or Logical,
and returns an Item Object that represents a newly inserted logical node.
|
| newXMLDocument |
Creates new ArasXmlDocument.
|
| promote |
Promote item to the specified state.
|
| removeAttribute |
Removes the specified attribute if the attribute exist; does nothing otherwise.
|
| removeItem |
Remove specified item from the this.dom |
| removeLogical |
Removes logical node referenced by the passed item from this.node.
|
| removeProperty(String) |
Removes the property tag with the specified name from the item's dom.
|
| removeProperty(String, String) |
Removes the property tag with the specified name and language from the item's dom.
|
| removePropertyAttribute(String, String) |
Modifies item's node by removing attribute on the specified property.
|
| removePropertyAttribute(String, String, String) |
Modifies item's node by removing attribute on the specified property with the specified
xml:lang attribute.
|
| removeRelationship |
Removes the passed item's node from the 'Relationships' node of the item.
|
| setAction |
Set the 'action' attribute on this.node.
|
| setAttribute |
Set the value of the attribute with the specified name on the item's node.
|
| setErrorCode |
Sets error code on the "error" item.
|
| setErrorDetail |
Sets the detailed error message of the error item.
|
| setErrorSource |
Sets the <faultactor> of the SOAP Fault element. If the instance is not an error item, the method does nothing.
|
| setErrorString |
Sets the error message of the error item.
|
| setErrorWho | Obsolete.
Same as setErrorCode().
|
| setFileName | Obsolete.
Set the filename for the attached file. This is only is meaningful if the type="File"
and will cause the apply() to submit multipart/form-data to the VaultServer.
|
| setFileProperty |
Set a file to an item reference.
|
| setFilePropertyViaStream |
Set a file stream to an item reference.
|
| setID |
Set the id attribute on the Item node. If the item has the property id as well,
the property is set too.
|
| setNewID |
Gets new ID by calling getNewID() then passes obtained ID to setID(id).
|
| setProperty(String, String) |
Set the property with the specified name. If property doesn't exist on the item, create it
first and then set.
|
| setProperty(String, String, String) |
Set the property with the specified name and language. If property doesn't exist on the item, create it
first and then set.
|
| setPropertyAttribute(String, String, String) |
Set the attribute for the specified property.
|
| setPropertyAttribute(String, String, String, String) |
Set the attribute for the specified property and language.
|
| setPropertyCondition(String, String) |
Sets the attribute 'condition' on the specified property.
|
| setPropertyCondition(String, String, String) |
Sets the attribute 'condition' on the specified property with the specified language.
|
| setPropertyItem |
Sets a property to an item reference.
|
| setRelatedItem |
Sets the 'related_id' property to an item reference.
|
| setType |
Set the 'type' attribute on the Item node.
|
| startWorkflow | Obsolete.
Starts the workflow process. Item's type must be "Workflow Process".
|
| ToString |
Returns AML string that represents the current Item.
(Overrides ObjectToString.) |
| unlockItem |
Applies the 'unlock' action on the item and returns the server response.
|
See Also