Class NSMDOAgent

MDO Lists, reading, searching, and item lookup.

Syntax

Examples

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

Constructors

NSMDOAgent()

MDO Lists, reading, searching, and item lookup.

Introduced or updated in version: 7

Declaration

NSMDOAgent

Examples

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

Methods

GetList(String,Bool,String,Bool)

Gets an MDO list.

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
String	name
Bool	forceFlatList
String	additionalInfo
Bool	onlyHistory

Returns

Type	Description
NSMDOListItem[]

Examples

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

GetListIdByListName(String)

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

Introduced or updated in version: 8.0sr3

Declaration

Integer GetListIdByListName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Integer

Remarks

Not all lists have such an ID, but those that are based on tables do (the list name is then the same as the table name)

Examples

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

GetListItem(String,Integer)

Returns a single list item

Introduced or updated in version: 7.5

Declaration

NSMDOListItem GetListItem(String listName, Integer id)

Parameters

Type	Name	Description
String	listName
Integer	id

Returns

Type	Description
NSMDOListItem

Examples

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

GetListNames()

Returns a list of all MDO List names.

Introduced or updated in version: 7.5

Declaration

String[] GetListNames()

Returns

Type	Description
String[]

Remarks

These names can also be used with the Archive agent as ProviderNames.

Examples

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

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

Get an MDO list with own history list.

Introduced or updated in version: 7

Declaration

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

Parameters

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

Returns

Type	Description
NSMDOListItem[]

Examples

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

GetListWithRestriction(String,String,String)

Gets an MDO list with restrictions.

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
String	name
String	additionalInfo
String	searchValue

Returns

Type	Description
NSMDOListItem[]

Examples

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

GetSelectableList(String,Bool,String,Bool)

Gets a Selectable MDO list.

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
String	name
Bool	forceFlatList
String	additionalInfo
Bool	onlyHistory

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

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

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

Gets a Selectable MDO list with own history list.

Introduced or updated in version: 7

Declaration

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

Parameters

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

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

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

GetSelectableListWithRestriction(String,String,String)

Gets a Selectable MDO list with restrictions.

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
String	name
String	additionalInfo
String	searchValue

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

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

GetSelectableSimpleList(String)

Returns a flat Selectable MDO List.

Introduced or updated in version: 7

Declaration

NSSelectableMDOListItem[] GetSelectableSimpleList(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

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

GetSimpleList(String)

Returns a simple flat MDO List.

Introduced or updated in version: 7

Declaration

NSMDOListItem[] GetSimpleList(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
NSMDOListItem[]

Examples

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

SetSelected(String,String)

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

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
String	name
String	additionalInfo

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

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