Class NSMDOAgent

MDO Lists, reading, searching, and item lookup.

Examples

NSMDOAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSMDOAgent()

MDO Lists, reading, searching, and item lookup.

Declaration

NSMDOAgent

Examples

NSMDOAgent agent;
agent.callMethod(arg1, arg2);

Methods

GetList(String,Bool,String,Bool)

Gets an MDO list.

Declaration

NSMDOListItem[] GetList(String name, Bool forceFlatList, String additionalInfo, Bool onlyHistory)

Examples

NSMDOAgent agent;
String name;
Bool forceFlatList;
String additionalInfo;
Bool onlyHistory;
NSMDOListItem[] res = agent.GetList(name, forceFlatList, additionalInfo, onlyHistory);

Parameters

Type Name Description
String name
Bool forceFlatList
String additionalInfo
Bool onlyHistory

Returns

Type Description
NSMDOListItem[]

GetListIdByListName(String)

Retrieves the UdListDefinition ID of a list, by its name.

Declaration

Integer GetListIdByListName(String name)

Examples

NSMDOAgent agent;
String name;
Integer res = agent.GetListIdByListName(name);

Parameters

Type Name Description
String name

Returns

Type Description
Integer

GetListItem(String,Integer)

Returns a single list item

Declaration

NSMDOListItem GetListItem(String listName, Integer id)

Examples

NSMDOAgent agent;
String listName;
Integer id;
NSMDOListItem res = agent.GetListItem(listName, id);

Parameters

Type Name Description
String listName
Integer id

Returns

Type Description
NSMDOListItem

GetListNames()

Returns a list of all MDO List names.

Declaration

String[] GetListNames()

Examples

NSMDOAgent agent;
String[] res = agent.GetListNames();

Returns

Type Description
String[]

GetListWithHistory(String,Bool,String,Integer[],Bool)

Get an MDO list with own history list.

Declaration

NSMDOListItem[] GetListWithHistory(String name, Bool forceFlatList, String additionalInfo, Integer[] historyItems, Bool onlyHistory)

Examples

NSMDOAgent agent;
String name;
Bool forceFlatList;
String additionalInfo;
Integer[] historyItems;
Bool onlyHistory;
NSMDOListItem[] res = agent.GetListWithHistory(name, forceFlatList, additionalInfo, historyItems, onlyHistory);

Parameters

Type Name Description
String name
Bool forceFlatList
String additionalInfo
Integer[] historyItems
Bool onlyHistory

Returns

Type Description
NSMDOListItem[]

GetListWithRestriction(String,String,String)

Gets an MDO list with restrictions.

Declaration

NSMDOListItem[] GetListWithRestriction(String name, String additionalInfo, String searchValue)

Examples

NSMDOAgent agent;
String name;
String additionalInfo;
String searchValue;
NSMDOListItem[] res = agent.GetListWithRestriction(name, additionalInfo, searchValue);

Parameters

Type Name Description
String name
String additionalInfo
String searchValue

Returns

Type Description
NSMDOListItem[]

GetSelectableList(String,Bool,String,Bool)

Gets a Selectable MDO list.

Declaration

NSSelectableMDOListItem[] GetSelectableList(String name, Bool forceFlatList, String additionalInfo, Bool onlyHistory)

Examples

NSMDOAgent agent;
String name;
Bool forceFlatList;
String additionalInfo;
Bool onlyHistory;
NSSelectableMDOListItem[] res = agent.GetSelectableList(name, forceFlatList, additionalInfo, onlyHistory);

Parameters

Type Name Description
String name
Bool forceFlatList
String additionalInfo
Bool onlyHistory

Returns

Type Description
NSSelectableMDOListItem[]

GetSelectableListWithHistory(String,Bool,String,Integer[],Bool)

Gets a Selectable MDO list with own history list.

Declaration

NSSelectableMDOListItem[] GetSelectableListWithHistory(String name, Bool forceFlatList, String additionalInfo, Integer[] historyItems, Bool onlyHistory)

Examples

NSMDOAgent agent;
String name;
Bool forceFlatList;
String additionalInfo;
Integer[] historyItems;
Bool onlyHistory;
NSSelectableMDOListItem[] res = agent.GetSelectableListWithHistory(name, forceFlatList, additionalInfo, historyItems, onlyHistory);

Parameters

Type Name Description
String name
Bool forceFlatList
String additionalInfo
Integer[] historyItems
Bool onlyHistory

Returns

Type Description
NSSelectableMDOListItem[]

GetSelectableListWithRestriction(String,String,String)

Gets a Selectable MDO list with restrictions.

Declaration

NSSelectableMDOListItem[] GetSelectableListWithRestriction(String name, String additionalInfo, String searchValue)

Examples

NSMDOAgent agent;
String name;
String additionalInfo;
String searchValue;
NSSelectableMDOListItem[] res = agent.GetSelectableListWithRestriction(name, additionalInfo, searchValue);

Parameters

Type Name Description
String name
String additionalInfo
String searchValue

Returns

Type Description
NSSelectableMDOListItem[]

GetSelectableSimpleList(String)

Returns a flat Selectable MDO List.

Declaration

NSSelectableMDOListItem[] GetSelectableSimpleList(String name)

Examples

NSMDOAgent agent;
String name;
NSSelectableMDOListItem[] res = agent.GetSelectableSimpleList(name);

Parameters

Type Name Description
String name

Returns

Type Description
NSSelectableMDOListItem[]

GetSimpleList(String)

Returns a simple flat MDO List.

Declaration

NSMDOListItem[] GetSimpleList(String name)

Examples

NSMDOAgent agent;
String name;
NSMDOListItem[] res = agent.GetSimpleList(name);

Parameters

Type Name Description
String name

Returns

Type Description
NSMDOListItem[]

SetSelected(String,String)

Saves the selected values as selected by their given list representation.

Declaration

NSSelectableMDOListItem[] SetSelected(String name, String additionalInfo, NSSelectableMDOListItem[] selectableMDOList)

Examples

NSMDOAgent agent;
String name;
String additionalInfo;
NSSelectableMDOListItem[] selectableMDOList;
NSSelectableMDOListItem[] res = agent.SetSelected(name, additionalInfo, selectableMDOList);

Parameters

Type Name Description
String name
String additionalInfo

Returns

Type Description
NSSelectableMDOListItem[]