NSViewStateAgent - SuperOffice

User interface view state, history, currentXXX values.

Constructors

NSViewStateAgent()

NSViewStateAgent

User interface view state, history, currentXXX values.

Methods

DeleteHistory(String,Integer)

Deletes the history element

Void DeleteHistory(String historyName, Integer id)

Returns: CRMScript.Global.Void

GetCurrent(String)

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

NSHistory GetCurrent(String historyName)

Returns: CRMScript.NetServer.NSHistory

This is the item with rank = 1. If no item exists a default value is returned. This is usually the first item in the table representing the history list.

Example:

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

GetHistories()

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

NSHistory[] GetHistories()

Returns: CRMScript.NetServer.NSHistory[] Example:

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

GetHistoriesByName(String)

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

NSHistory[] GetHistoriesByName(String historyName)

Returns: CRMScript.NetServer.NSHistory[] Example:

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

GetHistoriesByNames(String[])

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

NSHistory[] GetHistoriesByNames(String[] historyNames)

Returns: CRMScript.NetServer.NSHistory[] Example:

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

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.<para/>Use this method if you know exactly which items you need, regardless of whether they are in the current history or not.<para/>The history in the database is not changed or even looked at by this method.

NSHistory[] GetHistoriesByNamesAndIds(NSHistoryRequest[] requests)

Returns: CRMScript.NetServer.NSHistory[] Example:

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

GetHistory(Integer)

Gets an NSHistory object.

NSHistory GetHistory(Integer historyId)

Returns: CRMScript.NetServer.NSHistory Example:

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

GetHistoryLengthPrefValue()

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

Integer GetHistoryLengthPrefValue()

Returns: CRMScript.Global.Integer Example:

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

GetNextCurrent(String,Integer)

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

NSHistory GetNextCurrent(String historyName, Integer id)

Returns: CRMScript.NetServer.NSHistory

This is usually the first item in the table representing the history list.

Example:

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

GetPreviousCurrent(String,Integer)

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

NSHistory GetPreviousCurrent(String historyName, Integer id)

Returns: CRMScript.NetServer.NSHistory

This is usually the first item in the table representing the history list.

Example:

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

SaveCurrent(NSHistory)

Saves the current history item.

NSHistory SaveCurrent(NSHistory current)

Returns: CRMScript.NetServer.NSHistory

This history item is saved with Rank = 1, and all the remaining elements rank values are shifted one down.The list is maintained with the max lenght of the History list length preference.

Example:

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

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.

NSHistory[] SaveCurrents(NSHistory[] currents)

Returns: CRMScript.NetServer.NSHistory[] Example:

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

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.

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

Returns: CRMScript.NetServer.NSHistory[] Example:

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

SetHistoryLengthPrefValue(Integer)

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

Void SetHistoryLengthPrefValue(Integer length)

Returns: CRMScript.Global.Void

​Constructors

​NSViewStateAgent()

​Methods

​DeleteHistory(String,Integer)

​GetCurrent(String)

​GetHistories()

​GetHistoriesByName(String)

​GetHistoriesByNames(String[])

​GetHistoriesByNamesAndIds(NSHistoryRequest[])

​GetHistory(Integer)

​GetHistoryLengthPrefValue()

​GetNextCurrent(String,Integer)

​GetPreviousCurrent(String,Integer)

​SaveCurrent(NSHistory)

​SaveCurrents(NSHistory[])

​SaveHistories(String,NSHistory[])

​SetHistoryLengthPrefValue(Integer)

Constructors

NSViewStateAgent()

Methods

DeleteHistory(String,Integer)

GetCurrent(String)

GetHistories()

GetHistoriesByName(String)

GetHistoriesByNames(String[])

GetHistoriesByNamesAndIds(NSHistoryRequest[])

GetHistory(Integer)

GetHistoryLengthPrefValue()

GetNextCurrent(String,Integer)

GetPreviousCurrent(String,Integer)

SaveCurrent(NSHistory)

SaveCurrents(NSHistory[])

SaveHistories(String,NSHistory[])

SetHistoryLengthPrefValue(Integer)