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:\, and entities can be set through the selectable MDO list archiveEntities:\. 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.

Constructors

NSArchiveConfiguration()

Initializes a new instance of the NSArchiveConfiguration class.

Declaration

NSArchiveConfiguration

Methods

GetArchiveColumnInfo()

Declaration

NSArchiveColumnInfo[] GetArchiveColumnInfo()

Examples

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

Returns

Type	Description
NSArchiveColumnInfo[]

GetArchiveEntityInfo()

Declaration

NSSelectableMDOListItem[] GetArchiveEntityInfo()

Examples

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

Returns

Type	Description
NSSelectableMDOListItem[]

GetArchiveOrderByInfo()

Declaration

NSArchiveOrderByInfo[] GetArchiveOrderByInfo()

Examples

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

Returns

Type	Description
NSArchiveOrderByInfo[]

GetOwnerKeys()

Declaration

String GetOwnerKeys()

Examples

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

Returns

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

SetArchiveColumnInfo(NSArchiveColumnInfo[])

Declaration

Void SetArchiveColumnInfo(NSArchiveColumnInfo[] archiveColumnInfo)

Examples

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

Parameters

Type	Name	Description
NSArchiveColumnInfo[]	archiveColumnInfo

Returns

Type	Description
Void

SetArchiveEntityInfo(NSSelectableMDOListItem[])

Declaration

Void SetArchiveEntityInfo(NSSelectableMDOListItem[] archiveEntityInfo)

Examples

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

Parameters

Type	Name	Description
NSSelectableMDOListItem[]	archiveEntityInfo

Returns

Type	Description
Void

SetArchiveOrderByInfo(NSArchiveOrderByInfo[])

Declaration

Void SetArchiveOrderByInfo(NSArchiveOrderByInfo[] archiveOrderByInfo)

Examples

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

Parameters

Type	Name	Description
NSArchiveColumnInfo[]	archiveColumnInfo

Returns

Type	Description
Void

SetOwnerKeys(String)

Declaration

Void SetOwnerKeys(String ownerKeys)

Examples

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

Parameters

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

Returns

Type	Description
Void