Class NSViewStateAgent

NSViewStateAgent()

User interface view state, history, currentXXX values.

Declaration

NSViewStateAgent

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

DeleteHistory(String,Integer)

Deletes the history element

Declaration

Void DeleteHistory(String historyName, Integer id)

Parameters

Returns

GetCurrent(String)

Gets the current (most recent) value of the history list.

Declaration

NSHistory GetCurrent(String historyName)

NSViewStateAgent agent;
String historyName;
NSHistory res = agent.GetCurrent(historyName);

Parameters

Returns

GetHistories()

Returns all history items that belong to the currently logged in user

Declaration

NSHistory[] GetHistories()

NSViewStateAgent agent;
NSHistory[] res = agent.GetHistories();

Returns

GetHistoriesByName(String)

Returns the named history list that belong to the currently logged in user

Declaration

NSHistory[] GetHistoriesByName(String historyName)

NSViewStateAgent agent;
String historyName;
NSHistory[] res = agent.GetHistoriesByName(historyName);

Parameters

Returns

GetHistoriesByNames(String[])

Returns the named history lists that belong to the currently logged in user

Declaration

NSHistory[] GetHistoriesByNames(String[] historyNames)

NSViewStateAgent agent;
String[] historyNames;
NSHistory[] res = agent.GetHistoriesByNames(historyNames);

Parameters

Returns

GetHistoriesByNamesAndIds(NSHistoryRequest[])

Returns history data for the named entities and the given IDs, which may not directly correspond to the current history records in the database.Use this method if you know exactly which items you need, regardless of whether they are in the current history or not.The history in the database is not changed or even looked at by this method.

Declaration

NSHistory[] GetHistoriesByNamesAndIds(NSHistoryRequest[] requests)

NSViewStateAgent agent;
NSHistoryRequest[] requests;
NSHistory[] res = agent.GetHistoriesByNamesAndIds(requests);

Parameters

Returns

GetHistory(Integer)

Gets an NSHistory object.

Declaration

NSHistory GetHistory(Integer historyId)

NSViewStateAgent agent;
NSHistory thing = agent.GetHistory(123);

Parameters

Returns

GetHistoryLengthPrefValue()

Gets the logged-on user's preferred history list length. Will return the system preference if no user preferences are available.

Declaration

Integer GetHistoryLengthPrefValue()

NSViewStateAgent agent;
Integer res = agent.GetHistoryLengthPrefValue();

Returns

GetNextCurrent(String,Integer)

Returns the next current item. If no item exists a default value is returned.

Declaration

NSHistory GetNextCurrent(String historyName, Integer id)

NSViewStateAgent agent;
String historyName;
Integer id;
NSHistory res = agent.GetNextCurrent(historyName, id);

Parameters

Returns

GetPreviousCurrent(String,Integer)

Returns the previous current item. If no item exists a default value is returned.

Declaration

NSHistory GetPreviousCurrent(String historyName, Integer id)

NSViewStateAgent agent;
String historyName;
Integer id;
NSHistory res = agent.GetPreviousCurrent(historyName, id);

Parameters

Returns

SaveCurrent(NSHistory)

Saves the current history item.

Declaration

NSHistory SaveCurrent(NSHistory current)

NSViewStateAgent agent;
NSHistory current;
NSHistory res = agent.SaveCurrent(current);

Parameters

Returns

SaveCurrents(NSHistory[])

Saves the history elements as the current value for their respective lists. If more than one item is submitted for the same list, they are added sequently, meaning that the last one is the most current.

Declaration

NSHistory[] SaveCurrents(NSHistory[] currents)

NSViewStateAgent agent;
NSHistory[] currents;
NSHistory[] res = agent.SaveCurrents(currents);

Parameters

Returns

SaveHistories(String,NSHistory[])

Replaces the existing history-list for the currently logged-in user. All elements must belong to the same history list. If not they are ignored.

Declaration

NSHistory[] SaveHistories(String historyName, NSHistory[] history)

NSViewStateAgent agent;
String historyName;
NSHistory[] history;
NSHistory[] res = agent.SaveHistories(historyName, history);

Parameters

Returns

SetHistoryLengthPrefValue(Integer)

Sets the logged-on user's preferred history list length.

Declaration

Void SetHistoryLengthPrefValue(Integer length)

Parameters

Returns