Class NSArchiveConfiguration

Used to store and fetch the configuration of an archive. The configuration consists of entities and columns; entities correspond to archive provider entities and the checkboxes you see in the bottom of standard archives. Column configuration includes both what columns should be visible, what order they are in (left to right), and whether the archive rows should be sorted by one or more columns.

Desired columns can be set through the selectable MDO list called archiveColumns:<perovider name>, and entities can be set through the selectable MDO list archiveEntities:<provider name>. You can also use the SetChosenEntities and SetChosenColumns method of this service. The selectable MDO list implementation is suitable for data binding using mdo list controls.

Syntax

Constructors

NSArchiveConfiguration()

Initializes a new instance of the NSArchiveConfiguration class.

Introduced or updated in version: 7

Declaration

NSArchiveConfiguration

Methods

GetArchiveColumnInfo()

Introduced or updated in version: 7

Declaration

NSArchiveColumnInfo[] GetArchiveColumnInfo()

Returns

Type	Description
NSArchiveColumnInfo[]

Examples

NSArchiveConfiguration thing;
NSArchiveColumnInfo[] archiveColumnInfo = thing.GetArchiveColumnInfo();

GetArchiveEntityInfo()

Introduced or updated in version: 7

Declaration

NSSelectableMDOListItem[] GetArchiveEntityInfo()

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

NSArchiveConfiguration thing;
NSSelectableMDOListItem[] archiveEntityInfo = thing.GetArchiveEntityInfo();

GetArchiveOrderByInfo()

Introduced or updated in version: 7

Declaration

NSArchiveOrderByInfo[] GetArchiveOrderByInfo()

Returns

Type	Description
NSArchiveOrderByInfo[]

Examples

NSArchiveConfiguration thing;
NSArchiveOrderByInfo[] archiveOrderByInfo = thing.GetArchiveOrderByInfo();

GetOwnerKeys()

Introduced or updated in version: 7

Declaration

String GetOwnerKeys()

Returns

Type	Description
String	The actual ownership information for the configuration that was retrieved.

Examples

NSArchiveConfiguration thing;
String ownerKeys = thing.GetOwnerKeys();

SetArchiveColumnInfo(NSArchiveColumnInfo[])

Introduced or updated in version: 7

Declaration

Void SetArchiveColumnInfo(NSArchiveColumnInfo[] archiveColumnInfo)

Parameters

Type	Name	Description
NSArchiveColumnInfo[]	archiveColumnInfo

Returns

Type	Description
Void

Examples

NSArchiveConfiguration thing;
NSArchiveColumnInfo[] archiveColumnInfo;
thing.SetArchiveColumnInfo(archiveColumnInfo);

SetArchiveEntityInfo(NSSelectableMDOListItem[])

Introduced or updated in version: 7

Declaration

Void SetArchiveEntityInfo(NSSelectableMDOListItem[] archiveEntityInfo)

Parameters

Type	Name	Description
NSSelectableMDOListItem[]	archiveEntityInfo

Returns

Type	Description
Void

Examples

NSArchiveConfiguration thing;
NSSelectableMDOListItem[] archiveEntityInfo;
thing.SetArchiveEntityInfo(archiveEntityInfo);

SetArchiveOrderByInfo(NSArchiveOrderByInfo[])

Introduced or updated in version: 7

Declaration

Void SetArchiveOrderByInfo(NSArchiveOrderByInfo[] archiveOrderByInfo)

Parameters

Type	Name	Description
NSArchiveColumnInfo[]	archiveColumnInfo

Returns

Type	Description
Void

Examples

NSArchiveConfiguration thing;
NSArchiveOrderByInfo[] archiveOrderByInfo;
thing.SetArchiveOrderByInfo(archiveOrderByInfo);

SetOwnerKeys(String)

Introduced or updated in version: 7

Declaration

Void SetOwnerKeys(String ownerKeys)

Parameters

Type	Name	Description
String	ownerKeys	The actual ownership information for the configuration that was retrieved.

Returns

Type	Description
Void

Examples

NSArchiveConfiguration thing;
String ownerKeys;
thing.SetOwnerKeys(ownerKeys);