Class NSArchiveAgent

ArchiveList functions of all kinds.

Syntax

Examples

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

Constructors

NSArchiveAgent()

ArchiveList functions of all kinds.

Introduced or updated in version: 7

Declaration

NSArchiveAgent

Examples

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

Methods

CreateDefaultArchiveListResult()

Sets default values into a new NSArchiveListResult.

Introduced or updated in version: 7

Declaration

NSArchiveListResult CreateDefaultArchiveListResult()

Returns

Type	Description
NSArchiveListResult	A new NSArchiveListResult with default values.

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance.

Examples

NSArchiveAgent agent;
NSArchiveListResult thing = agent.CreateDefaultArchiveListResult();
thing = agent.SaveArchiveListResult(thing);

ExportArchive(String,String,String[],String[],String,String[],Integer)

Exports the target archive to a downloadable format.

Introduced or updated in version: 7

Declaration

NSExportArchiveResult ExportArchive(String providerName, String context, String[] desiredEntities, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restrictions, String exportType, String[] selectedRowIds, Integer estimatedRowCount)

Parameters

Type	Name	Description
String	providerName
String	context
String[]	desiredEntities
String[]	columns
String	exportType
String[]	selectedRowIds
Integer	estimatedRowCount

Returns

Type	Description
NSExportArchiveResult

GetActivityFilter()

Gets activity filter for the specified list.

Introduced or updated in version: 7

Declaration

NSActivityFilter GetActivityFilter()

Returns

Type	Description
NSActivityFilter	The activity filter for the specified list.

Examples

NSArchiveAgent agent;
NSActivityFilter res = agent.GetActivityFilter();

GetArchiveConfiguration(String,String)

Gets the configuration for one archive. The configuration is keyed by a combination of archive provider name and gui name.

Introduced or updated in version: 7

Declaration

NSArchiveConfiguration GetArchiveConfiguration(String guiName, String providerName)

Parameters

Type	Name	Description
String	guiName	An arbitrary string used to distinguish multiple occurrences of the same underlying provider in a gui.
String	providerName	Must match an archive provider plugin.

Returns

Type	Description
NSArchiveConfiguration

Examples

NSArchiveAgent agent;
String guiName;
String providerName;
NSArchiveConfiguration res = agent.GetArchiveConfiguration(guiName, providerName);

GetArchiveConfigurationV2(String,String,String,String)

Gets the configuration for one archive. The configuration is keyed by a combination of archive provider name (plus optional context), gui name, and optional table binding.

Introduced or updated in version: 7

Declaration

NSArchiveConfiguration GetArchiveConfigurationV2(String guiName, String providerName, String context, String ownerKeys)

Parameters

Type	Name	Description
String	guiName	An arbitrary string used to distinguish multiple occurrences of the same underlying provider in a gui.
String	providerName	Must match an archive provider plugin.
String	context
String	ownerKeys

Returns

Type	Description
NSArchiveConfiguration

Examples

NSArchiveAgent agent;
String guiName;
String providerName;
String context;
String ownerKeys;
NSArchiveConfiguration res = agent.GetArchiveConfigurationV2(guiName, providerName, context, ownerKeys);

GetArchiveConfigurationWithContext(String,String,String)

Gets the configuration for one archive, with context parameter. The configuration is keyed by a combination of archive provider name and gui name.

Introduced or updated in version: 7.5

Declaration

NSArchiveConfiguration GetArchiveConfigurationWithContext(String guiName, String providerName, String context)

Parameters

Type	Name	Description
String	guiName	An arbitrary string used to distinguish multiple occurrences of the same underlying provider in a gui.
String	providerName	Must match an archive provider plugin
String	context

Returns

Type	Description
NSArchiveConfiguration

Examples

NSArchiveAgent agent;
String guiName;
String providerName;
String context;
NSArchiveConfiguration res = agent.GetArchiveConfigurationWithContext(guiName, providerName, context);

GetArchiveList(String,String,String[],Integer,Integer)

Gets a page of data for an archive.

Introduced or updated in version: 7

Declaration

NSArchiveListItem[] GetArchiveList(String guiName, String providerName, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize)

Parameters

Type	Name	Description
String	guiName
String	providerName
String[]	entities
Integer	page
Integer	pageSize

Returns

Type	Description
NSArchiveListItem[]	The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.

Examples

NSArchiveAgent agent;
String guiName;
String providerName;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveList(guiName, providerName, sortOrder, restriction, entities, page, pageSize);

GetArchiveList2(String,String,String,String,String,Integer,Integer)

Gets a page of data for an archive using a restriction string.

Introduced or updated in version: 8.0sr3

Declaration

NSArchiveListItem[] GetArchiveList2(String guiName, String providerName, String sortOrder, String restriction, String entities, Integer page, Integer pageSize)

Parameters

Type	Name	Description
String	guiName
String	providerName
String	sortOrder
String	restriction
String	entities
Integer	page
Integer	pageSize

Returns

Type	Description
NSArchiveListItem[]	The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.

Examples

NSArchiveAgent agent;
String guiName;
String providerName;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveList2(guiName, providerName, sortOrder, restriction, entities, page, pageSize);

GetArchiveListByColumns(String,String[],String[],Integer,Integer)

Gets a page of results for an archive list, explicitly specifying the restrictions, orderby and chosen columns.

Introduced or updated in version: 7

Declaration

NSArchiveListItem[] GetArchiveListByColumns(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize)

Parameters

Type	Name	Description
String	providerName
String[]	columns
String[]	entities
Integer	page
Integer	pageSize

Returns

Type	Description
NSArchiveListItem[]

Examples

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveListByColumns(providerName, columns, sortOrder, restriction, entities, page, pageSize);

GetArchiveListByColumns2(String,String,String,String,String,Integer,Integer)

Gets a page of results for an archive list, explicitly specifying the restrictions as a string, orderby and chosen columns.

Introduced or updated in version: 8.0sr3

Declaration

NSArchiveListItem[] GetArchiveListByColumns2(String providerName, String columns, String sortOrder, String restrictions, String entities, Integer page, Integer pageSize)

Parameters

Type	Name	Description
String	providerName
String	columns
String	sortOrder
String	restrictions
String	entities
Integer	page
Integer	pageSize

Returns

Type	Description
NSArchiveListItem[]

Examples

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restrictions;
String entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveListByColumns2(providerName, columns, sortOrder, restrictions, entities, page, pageSize);

GetArchiveListByColumnsWithContext(String,String[],String[],Integer,Integer,String)

Gets a page of results for an archive list with context parameter, explicitly specifying the restrictions, orderby and chosen columns.

Introduced or updated in version: 7

Declaration

NSArchiveListItem[] GetArchiveListByColumnsWithContext(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String context)

Parameters

Type	Name	Description
String	providerName
String[]	columns
String[]	entities
Integer	page
Integer	pageSize
String	context

Returns

Type	Description
NSArchiveListItem[]

Examples

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListByColumnsWithContext(providerName, columns, sortOrder, restriction, entities, page, pageSize, context);

GetArchiveListByColumnsWithContext2(String,String,String,String,String,Integer,Integer,String)

Gets a page of results for an archive list with context parameter, explicitly specifying the restrictions as a string, orderby and chosen columns.

Introduced or updated in version: 8.0sr3

Declaration

NSArchiveListItem[] GetArchiveListByColumnsWithContext2(String providerName, String columns, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String context)

Parameters

Type	Name	Description
String	providerName
String	columns
String	sortOrder
String	restriction
String	entities
Integer	page
Integer	pageSize
String	context

Returns

Type	Description
NSArchiveListItem[]

Examples

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListByColumnsWithContext2(providerName, columns, sortOrder, restriction, entities, page, pageSize, context);

GetArchiveListByColumnsWithHeader(String,String[],String[],Integer,Integer,String)

Gets a page of results for an archive list, explicitly specifying the restrictions, orderby and chosen columns; as well as a name/value string formatted set of options. The return value includes a header that has various extra information, in addition to the actual rows.

Introduced or updated in version: 7

Declaration

NSArchiveListResult GetArchiveListByColumnsWithHeader(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String options)

Parameters

Type	Name	Description
String	providerName
String[]	columns
String[]	entities
Integer	page
Integer	pageSize
String	options

Returns

Type	Description
NSArchiveListResult

Examples

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String options;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeader(providerName, columns, sortOrder, restriction, entities, page, pageSize, options);

GetArchiveListByColumnsWithHeader2(String,String,String,String,String,Integer,Integer,String)

Gets a page of results for an archive list, explicitly specifying the restrictions as strings, orderby and chosen columns; as well as a name/value string formatted set of options.

Introduced or updated in version: 8.0sr3

Declaration

NSArchiveListResult GetArchiveListByColumnsWithHeader2(String providerName, String columns, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String options)

Parameters

Type	Name	Description
String	providerName
String	columns
String	sortOrder
String	restriction
String	entities
Integer	page
Integer	pageSize
String	options

Returns

Type	Description
NSArchiveListResult	Includes a header that has various extra information, in addition to the actual rows.

Examples

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String options;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeader2(providerName, columns, sortOrder, restriction, entities, page, pageSize, options);

GetArchiveListByColumnsWithHeaderWithContext(String,String[],String[],Integer,Integer,String,String)

Gets a page of results for an archive list, with context parameter, explicitly specifying the restrictions, orderby and chosen columns; as well as a name/value string formatted set of options.

Introduced or updated in version: 7

Declaration

NSArchiveListResult GetArchiveListByColumnsWithHeaderWithContext(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String options, String context)

Parameters

Type	Name	Description
String	providerName
String[]	columns
String[]	entities
Integer	page
Integer	pageSize
String	options
String	context

Returns

Type	Description
NSArchiveListResult	Includes a header that has various extra information, in addition to the actual rows.

Examples

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String options;
String context;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeaderWithContext(providerName, columns, sortOrder, restriction, entities, page, pageSize, options, context);

GetArchiveListByColumnsWithHeaderWithContext2(String,String,String,String,String,Integer,Integer,String,String)

Gets a page of results for an archive list, with context parameter, explicitly specifying the restrictions as strings, orderby and chosen columns; as well as a name/value string formatted set of options.

Introduced or updated in version: 8.0sr3

Declaration

NSArchiveListResult GetArchiveListByColumnsWithHeaderWithContext2(String providerName, String columns, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String options, String context)

Parameters

Type	Name	Description
String	providerName
String	columns
String	sortOrder
String	restriction
String	entities
Integer	page
Integer	pageSize
String	options
String	context

Returns

Type	Description
NSArchiveListResult	Includes a header that has various extra information, in addition to the actual rows.

Examples

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String options;
String context;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeaderWithContext2(providerName, columns, sortOrder, restriction, entities, page, pageSize, options, context);

GetArchiveListWithContext(String,String,String[],Integer,Integer,String)

Gets a page of data for an archive, with context parameter. The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.

Introduced or updated in version: 7

Declaration

NSArchiveListItem[] GetArchiveListWithContext(String guiName, String providerName, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String context)

Parameters

Type	Name	Description
String	guiName
String	providerName
String[]	entities
Integer	page
Integer	pageSize
String	context

Returns

Type	Description
NSArchiveListItem[]

Examples

NSArchiveAgent agent;
String guiName;
String providerName;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListWithContext(guiName, providerName, sortOrder, restriction, entities, page, pageSize, context);

GetArchiveListWithContext2(String,String,String,String,String,Integer,Integer,String)

Gets a page of data for an archive using restrictions as strings, with context parameter.

Introduced or updated in version: 8.0sr3

Declaration

NSArchiveListItem[] GetArchiveListWithContext2(String guiName, String providerName, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String context)

Parameters

Type	Name	Description
String	guiName
String	providerName
String	sortOrder
String	restriction
String	entities
Integer	page
Integer	pageSize
String	context

Returns

Type	Description
NSArchiveListItem[]	The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.

Examples

NSArchiveAgent agent;
String guiName;
String providerName;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListWithContext2(guiName, providerName, sortOrder, restriction, entities, page, pageSize, context);

GetAvailableColumns(String,String)

Returns list of all columns supported by an archive provider. See also GetArchiveConfiguration(String,String).

Introduced or updated in version: 8.0sr3

Declaration

NSArchiveColumnInfo[] GetAvailableColumns(String providerName, String context)

Parameters

Type	Name	Description
String	providerName
String	context

Returns

Type	Description
NSArchiveColumnInfo[]

Examples

NSArchiveAgent agent;
String providerName;
String context;
NSArchiveColumnInfo[] res = agent.GetAvailableColumns(providerName, context);

GetAvailableEntities(String,String)

Returns list of all entities supported by an archive provider. See also GetArchiveConfiguration(String,String).

Introduced or updated in version: 8.0sr3

Declaration

NSMDOListItem[] GetAvailableEntities(String providerName, String context)

Parameters

Type	Name	Description
String	providerName
String	context

Returns

Type	Description
NSMDOListItem[]

Examples

NSArchiveAgent agent;
String providerName;
String context;
NSMDOListItem[] res = agent.GetAvailableEntities(providerName, context);

GetGroupAssociateIds(Integer[])

Returns the associate IDs that belongs to the given groups.

Introduced or updated in version: 7

Declaration

Integer[] GetGroupAssociateIds(Integer[] groupIds)

Parameters

Type	Name	Description
Integer[]	groupIds

Returns

Type	Description
Integer[]	The associate IDs.

Examples

NSArchiveAgent agent;
Integer[] groupIds;
Integer[] res = agent.GetGroupAssociateIds(groupIds);

GetProviderNames()

Returns list of all archive provider names.

Introduced or updated in version: 7.5

Declaration

String[] GetProviderNames()

Returns

Type	Description
String[]	Array of all archive provider names.

Examples

NSArchiveAgent agent;
String[] res = agent.GetProviderNames();

SetActivityFilter(NSActivityFilter)

Sets activity filter for the specified list.

Introduced or updated in version: 7

Declaration

Void SetActivityFilter(NSActivityFilter activityFilter)

Parameters

Type	Name	Description
NSActivityFilter	activityFilter

Returns

Type	Description
Void

SetChosenColumns(String,String,String[])

Sets the currently chosen columns for the given gui name/provider name combination.

Introduced or updated in version: 7

Declaration

Void SetChosenColumns(String guiName, String providerName, String[] chosenColumns)

Parameters

Type	Name	Description
String	guiName
String	providerName
String[]	chosenColumns

Returns

Type	Description
Void

Remarks

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveColumns: plus the archive provider name and gui name as its additionalInfo.

SetChosenColumnsV2(String,String,String,String,String[])

Sets the currently chosen columns for the given gui name/provider name combination.

Introduced or updated in version: 7

Declaration

Void SetChosenColumnsV2(String guiName, String providerName, String context, String ownerKeys, String[] chosenColumns)

Parameters

Type	Name	Description
String	guiName
String	providerName
String	context
String	ownerKeys
String[]	chosenColumns

Returns

Type	Description
Void

Remarks

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveColumns: plus the archive provider name and gui name as its additionalInfo.

SetChosenEntities(String,String,String[])

Sets the currently chosen entities for the given gui name/provider name combination.

Introduced or updated in version: 7

Declaration

Void SetChosenEntities(String guiName, String providerName, String[] entities)

Parameters

Type	Name	Description
String	guiName
String	providerName
String[]	entities

Returns

Type	Description
Void

Remarks

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveEntities: plus the archive provider name and gui name as its additionalInfo.

SetChosenEntitiesV2(String,String,String,String,String[])

Sets the currently chosen entities for the given gui name/provider name combination.

Introduced or updated in version: 7

Declaration

Void SetChosenEntitiesV2(String guiName, String providerName, String context, String ownerKeys, String[] entities)

Parameters

Type	Name	Description
String	guiName
String	providerName
String	context
String	ownerKeys
String[]	entities

Returns

Type	Description
Void

Remarks

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveEntities: plus the archive provider name and gui name as its additionalInfo.

SetColumnWidths(String,String[])

Sets the column widths for the given set of columns and GUI name.

Introduced or updated in version: 7

Declaration

Void SetColumnWidths(String guiName, String[] columnWidths)

Parameters

Type	Name	Description
String	guiName
String[]	columnWidths

Returns

Type	Description
Void

SetColumnWidthsV2(String,String,String,String,String[])

Sets the column widths for the given set of columns and GUI name.

Introduced or updated in version: 7

Declaration

Void SetColumnWidthsV2(String guiName, String providerName, String context, String ownerKeys, String[] columnWidths)

Parameters

Type	Name	Description
String	guiName
String	providerName
String	context
String	ownerKeys
String[]	columnWidths

Returns

Type	Description
Void