TRIM.SDK.ConsignmentCreationOptions Class Reference

A helper class that encapsulates the settings to use when creating a consignment. More...

Inheritance diagram for TRIM.SDK.ConsignmentCreationOptions:

Public Member Functions
	ConsignmentCreationOptions (Database fromDB)
	Construct a default set of consignment creation options for creating a new consignment. More...
Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
ConsignmentDisposalType	InitializeAsType [get, set]
	Gets or sets a ConsignmentDisposalType value to be the type of record disposal being performed with the consignment to be created. More...
TrimDateTime	CutoffDate [get, set]
	Gets or sets the cutoff date for the scheduled disposal date for all records to be processed with the consignment to be created. More...
TrimMainObjectSearch?	RecordSubSelection [get, set]
	Gets or sets the additional record search criteria to be applied when selecting records to be processed with the consignment to be created. More...
bool	OnlyScheduledDisposals [get, set]
	Gets or sets a boolean value to indicate that only records that have a non-blank scheduled disposal date before the cutoff date will be included in the consignment to be created. More...
bool	IncludeRecordsBeyondScheduledDisposal [get, set]
	Gets or sets a boolean value to indicate that only records that have a scheduled disposal date before the cutoff date will be included in the consignment to be created. More...
bool	IncludeRecordsOnHold [get, set]
	Gets or sets a boolean value to indicate that records that are currently on hold will be included in the consignment to be created. More...
bool	RequireOwnerApproval [get, set]
	Gets or sets an boolean value indicating that the consignment to be created will require an approval process that includes the owner location of the records. More...
LocationList?	ExtraLocationsToApprove [get, set]
	Gets or sets a list of additional locations that will be required to approve the final disposal of the consignment to be created. More...
bool	UseOwnerAdministratorForApproval [get, set]
	Gets or sets an boolean value indicating that the consignment to be created will require an approval process that includes the administrator of the owner location of the records. More...
bool	UseBoxSelectionStyle [get, set]
	Gets or sets a boolean value indicating that all disposal schedule dates should be aggregated up to the box level before determining if a box or anyu of its contents can be included in the consignment that is being created. More...
bool	BasicRecordsOnly [get, set]
	Gets or sets a boolean value indicating if this consignment will only select those records that implement a basic set of metadata. Consignments with this setting can use more high volume, bulk-processing functions to speed up disposal. More...
bool	ExcludeXDMSRecords [get, set]
	Gets or sets a boolean value indicating if this consignment will exclude any external document management system records.. More...
Properties inherited from TRIM.SDK.TrimSDKObject
string	ErrorMessage [get]
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
TrimException	Error [get]
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Detailed Description

A helper class that encapsulates the settings to use when creating a consignment.

Constructor & Destructor Documentation

ConsignmentCreationOptions()

TRIM.SDK.ConsignmentCreationOptions.ConsignmentCreationOptions

(

Database

fromDB

)

Construct a default set of consignment creation options for creating a new consignment.

Property Documentation

BasicRecordsOnly

bool TRIM.SDK.ConsignmentCreationOptions.BasicRecordsOnly

getset

Gets or sets a boolean value indicating if this consignment will only select those records that implement a basic set of metadata. Consignments with this setting can use more high volume, bulk-processing functions to speed up disposal.

CutoffDate

TrimDateTime TRIM.SDK.ConsignmentCreationOptions.CutoffDate

getset

Gets or sets the cutoff date for the scheduled disposal date for all records to be processed with the consignment to be created.

ExcludeXDMSRecords

bool TRIM.SDK.ConsignmentCreationOptions.ExcludeXDMSRecords

getset

Gets or sets a boolean value indicating if this consignment will exclude any external document management system records..

ExtraLocationsToApprove

LocationList? TRIM.SDK.ConsignmentCreationOptions.ExtraLocationsToApprove

getset

Gets or sets a list of additional locations that will be required to approve the final disposal of the consignment to be created.

IncludeRecordsBeyondScheduledDisposal

bool TRIM.SDK.ConsignmentCreationOptions.IncludeRecordsBeyondScheduledDisposal

getset

Gets or sets a boolean value to indicate that only records that have a scheduled disposal date before the cutoff date will be included in the consignment to be created.

IncludeRecordsOnHold

bool TRIM.SDK.ConsignmentCreationOptions.IncludeRecordsOnHold

getset

Gets or sets a boolean value to indicate that records that are currently on hold will be included in the consignment to be created.

InitializeAsType

ConsignmentDisposalType TRIM.SDK.ConsignmentCreationOptions.InitializeAsType

getset

Gets or sets a ConsignmentDisposalType value to be the type of record disposal being performed with the consignment to be created.

OnlyScheduledDisposals

bool TRIM.SDK.ConsignmentCreationOptions.OnlyScheduledDisposals

getset

Gets or sets a boolean value to indicate that only records that have a non-blank scheduled disposal date before the cutoff date will be included in the consignment to be created.

RecordSubSelection

TrimMainObjectSearch? TRIM.SDK.ConsignmentCreationOptions.RecordSubSelection

getset

Gets or sets the additional record search criteria to be applied when selecting records to be processed with the consignment to be created.

RequireOwnerApproval

bool TRIM.SDK.ConsignmentCreationOptions.RequireOwnerApproval

getset

Gets or sets an boolean value indicating that the consignment to be created will require an approval process that includes the owner location of the records.

UseBoxSelectionStyle

bool TRIM.SDK.ConsignmentCreationOptions.UseBoxSelectionStyle

getset

Gets or sets a boolean value indicating that all disposal schedule dates should be aggregated up to the box level before determining if a box or anyu of its contents can be included in the consignment that is being created.

UseOwnerAdministratorForApproval

bool TRIM.SDK.ConsignmentCreationOptions.UseOwnerAdministratorForApproval

getset

Gets or sets an boolean value indicating that the consignment to be created will require an approval process that includes the administrator of the owner location of the records.