Class NSArchiveAgent

NSArchiveAgent()

ArchiveList functions of all kinds.

Declaration

NSArchiveAgent

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

CreateDefaultArchiveListResult()

Sets default values into a new NSArchiveListResult.

Declaration

NSArchiveListResult CreateDefaultArchiveListResult()

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

Returns

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

Exports the target archive to a downloadable format.

Declaration

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

Parameters

Returns

GetActivityFilter()

Gets activity filter for the specified list.

Declaration

NSActivityFilter GetActivityFilter()

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

Returns

GetArchiveConfiguration(String,String)

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

Declaration

NSArchiveConfiguration GetArchiveConfiguration(String guiName, String providerName)

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

Parameters

Returns

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.

Declaration

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

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

Parameters

Returns

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.

Declaration

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

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

Parameters

Returns

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

Gets a page of data for an archive.

Declaration

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

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);

Parameters

Returns

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

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

Declaration

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

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);

Parameters

Returns

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

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

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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.

Declaration

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

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);

Parameters

Returns

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

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

Declaration

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

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);

Parameters

Returns

GetAvailableColumns(String,String)

Returns list of all columns supported by an archive provider. See also .

Declaration

NSArchiveColumnInfo[] GetAvailableColumns(String providerName, String context)

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

Parameters

Returns

GetAvailableEntities(String,String)

Returns list of all entities supported by an archive provider. See also .

Declaration

NSMDOListItem[] GetAvailableEntities(String providerName, String context)

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

Parameters

Returns

GetGroupAssociateIds(Integer[])

Returns the associate IDs that belongs to the given groups.

Declaration

Integer[] GetGroupAssociateIds(Integer[] groupIds)

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

Parameters

Returns

GetProviderNames()

Returns list of all archive provider names.

Declaration

String[] GetProviderNames()

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

Returns

SetActivityFilter(NSActivityFilter)

Sets activity filter for the specified list.

Declaration

Void SetActivityFilter(NSActivityFilter activityFilter)

Parameters

Returns

SetChosenColumns(String,String,String[])

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

Declaration

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

Parameters

Returns

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

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

Declaration

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

Parameters

Returns

SetChosenEntities(String,String,String[])

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

Declaration

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

Parameters

Returns

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

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

Declaration

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

Parameters

Returns

SetColumnWidths(String,String[])

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

Declaration

Void SetColumnWidths(String guiName, String[] columnWidths)

Parameters

Returns

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

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

Declaration

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

Parameters

Returns