TRIM.SDK.CloseRecordOptions Class Reference

A helper class that encapsulates the settings to use when closing a container record. More...

Inheritance diagram for TRIM.SDK.CloseRecordOptions:

Public Member Functions
	CloseRecordOptions ()
	Constructs a CloseRecordOptions class with all the settings set to default. More...
Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
bool	FinalizeContents [get, set]
	Gets or sets a boolean property indicating that when the container record is closed, all contents of this container should be finalized. More...
bool	PurgeContentRevisions [get, set]
	Gets or sets a boolean property indicating that when the container record is closed, all contents of the container should have all their older revisions removed. More...
bool	EncloseContents [get, set]
	Gets or sets a boolean property indicating that when the container record is closed, all contents of the container should be relocated to 'enclosed in container'. More...
bool	ContinueOnError [get, set]
	Gets or sets a boolean property indicating that when the container record is closed, whether to continue if an error occurs during any content update. More...
TrimDateTime	SpecificCloseDate [get, set]
	Gets or sets a datetime property indicating an alternate date and time to use for DateClosed when closing the container record. If not specified, DateClosed will be set to the current date and time. More...
string	LogFileName [get, set]
	Gets or sets the log file name that will be used to record processing activity. More...
bool	LogErrorsOnly [get, set]
	Gets or sets a boolean value indicating whether to just log errors to the log. 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 closing a container record.

Constructor & Destructor Documentation

CloseRecordOptions()

TRIM.SDK.CloseRecordOptions.CloseRecordOptions

(

)

Constructs a CloseRecordOptions class with all the settings set to default.

Property Documentation

ContinueOnError

bool TRIM.SDK.CloseRecordOptions.ContinueOnError

getset

Gets or sets a boolean property indicating that when the container record is closed, whether to continue if an error occurs during any content update.

EncloseContents

bool TRIM.SDK.CloseRecordOptions.EncloseContents

getset

Gets or sets a boolean property indicating that when the container record is closed, all contents of the container should be relocated to 'enclosed in container'.

FinalizeContents

bool TRIM.SDK.CloseRecordOptions.FinalizeContents

getset

Gets or sets a boolean property indicating that when the container record is closed, all contents of this container should be finalized.

LogErrorsOnly

bool TRIM.SDK.CloseRecordOptions.LogErrorsOnly

getset

Gets or sets a boolean value indicating whether to just log errors to the log.

LogFileName

string TRIM.SDK.CloseRecordOptions.LogFileName

getset

Gets or sets the log file name that will be used to record processing activity.

PurgeContentRevisions

bool TRIM.SDK.CloseRecordOptions.PurgeContentRevisions

getset

Gets or sets a boolean property indicating that when the container record is closed, all contents of the container should have all their older revisions removed.

SpecificCloseDate

TrimDateTime TRIM.SDK.CloseRecordOptions.SpecificCloseDate

getset

Gets or sets a datetime property indicating an alternate date and time to use for DateClosed when closing the container record. If not specified, DateClosed will be set to the current date and time.