Skip to main content

aras.getItemByName Method (aras Object)

aras.getItemByName Method

Gets Item node by Item name. System will load data from server when:
  • Item node exists in cache and is dirty, but contained levels is less than requested levels.
  • Item node does not exists in cache.
Otherwise, cached data will be returned.

Syntax

aras.getItemByName(typeName,name,levels,configPath,select)

Parameters

NameTypeDescription
typeNameStringRequired. Item type.
nameStringRequired. Item name.
levelsStringOptional. Expanding depth for Relationships. Default is 0.
configPathStringOptional. RelationshipType name which should be loaded together. Default is empty. When specifying this parameter, "levels" must be greater than zero. If there are various values, use "|" to separate.
selectStringOptional. The Property to return. Separating by comma. Default is empty (select all Properties).

Return Value

An Object or Null.
Returns Item node if the data is loaded successfully, otherwise returns Null.

See Also

aras Object
Aras Innovator Client Framework
標籤：

Comments

Post a Comment

Popular posts from this blog

aras.uiShowItemEx Method (aras Object)

aras.uiShowItemEx Method Shows Item with Item node. Syntax aras.uiShowItem( itemNd , viewMode , isOpenInTearOff ) Parameters Name Type Description itemNd Object Required. Item node. viewMode String Optional. Unknown purpose but only supports the following values: tab view (Default) openFile new ※Each supported value will get same result. Therefore, call method and pass undefined for this parameter is OK. isOpenInTearOff Boolean Optional. Specifies whether show Item with tear-off window. true - open in a tear-off window. false - open in a tab. (Default) Return Value An AsyncResult object or a Boolean. Returns AsyncResult object if the Item winodw is opened successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework
Post a Comment
Read more

aras.uiShowItem Method (aras Object)

aras.uiShowItem Method Gets Item by Item ID and then shows the Item. Syntax aras.uiShowItem( itemTypeName , itemID , viewMode ) Parameters Name Type Description itemTypeName String Required. Name of the ItemType. itemID String Required. ID of the Item. viewMode String Optional. Unknown purpose but only supports the following values: tab view - This is default. openFile new ※Each supported value will get same result. Therefore, call method without this parameter is OK. Return Value An AsyncResult object or a Boolean. Returns AsyncResult object if the Item winodw is opened successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework
Post a Comment
Read more

window.handleItemChange Method (Instance Window Object)

window.handleItemChange Method Changes current Item's property value. If Item is not locked, the function will do nothing. Syntax window.handleItemChange( propNm , propVal , dataType , datePattern ) Parameters Name Type Description propNm String Required. Property name. propVal String Required. Property value. dataType String Optional. Property data type. If the data type is "date", this parameter is required, otherwise it is not necessary to pass. datePattern String Optional. Date pattern, supports the following values: short_date (Default) short_date_time long_date long_date_time See Also Instance Window Object Aras Innovator Client Framework
Post a Comment
Read more