HP.HPTRIM.SDK.TrimSearchTopContainersFilter Class Reference

The ApiTrimSearchTopContainersFilter is a special filter applied to a search which is used to select top containers using an aggregated disposal method technique More...

Public Member Functions
	TrimSearchTopContainersFilter ()
	Construct a top container filter object More...

Properties
ConsignmentDisposalType	DisposalType [get, set]
	Gets or sets a ConsignmentDisposalType enumerated value indicating what type of disposal method will be required for this selection. More...
TrimDateTime	OnOrBeforeArchiveDate [get, set]
	Gets or sets a date object indicating the cutoff date for any archiving action to be due. More...
long	MaxResults [get, set]
	Gets or sets a number indicating the maximum number of results to be returned by this search. More...
bool	OnlyBoxes [get, set]
	Gets or sets a boolean value indicating if only record types that have behavior of 'Box' will be selected (a common archiving use case for physical records). More...
bool	IncludeItemsOnHold [get, set]
	Gets or sets a boolean value indicating if records that are currently on hold will be retrieved when using this filter. More...
bool	IncludeItemsInAConsignment [get, set]
	Gets or sets a boolean value indicating if records that are currently part of an existing consignment process will be retrieved when using this filter. More...
bool	AggregateContents [get, set]
	Gets or sets a boolean value indicating if the contents of a top level folder should be examined for a conflicting disposal instructions (contents with a more severe disposal instruction will case the top container not to be selected). More...
bool	AggregateContentsRecursive [get, set]
	Gets or sets a boolean value indicating that if contents are being aggregated, whether to look inside the contents of the contents recursively. More...
bool	AggregateExcludeScheduled [get, set]
	Gets or sets a boolean value indicating that the search should exclude any top level container that has a specific (i.e. not aggregated) disposal instruction specified. More...

Detailed Description

The ApiTrimSearchTopContainersFilter is a special filter applied to a search which is used to select top containers using an aggregated disposal method technique

Constructor & Destructor Documentation

HP.HPTRIM.SDK.TrimSearchTopContainersFilter.TrimSearchTopContainersFilter

(

)

Construct a top container filter object

Property Documentation

bool HP.HPTRIM.SDK.TrimSearchTopContainersFilter.AggregateContents

getset

Gets or sets a boolean value indicating if the contents of a top level folder should be examined for a conflicting disposal instructions (contents with a more severe disposal instruction will case the top container not to be selected).

bool HP.HPTRIM.SDK.TrimSearchTopContainersFilter.AggregateContentsRecursive

getset

Gets or sets a boolean value indicating that if contents are being aggregated, whether to look inside the contents of the contents recursively.

bool HP.HPTRIM.SDK.TrimSearchTopContainersFilter.AggregateExcludeScheduled

getset

Gets or sets a boolean value indicating that the search should exclude any top level container that has a specific (i.e. not aggregated) disposal instruction specified.

ConsignmentDisposalType HP.HPTRIM.SDK.TrimSearchTopContainersFilter.DisposalType

getset

Gets or sets a ConsignmentDisposalType enumerated value indicating what type of disposal method will be required for this selection.

bool HP.HPTRIM.SDK.TrimSearchTopContainersFilter.IncludeItemsInAConsignment

getset

Gets or sets a boolean value indicating if records that are currently part of an existing consignment process will be retrieved when using this filter.

bool HP.HPTRIM.SDK.TrimSearchTopContainersFilter.IncludeItemsOnHold

getset

Gets or sets a boolean value indicating if records that are currently on hold will be retrieved when using this filter.

long HP.HPTRIM.SDK.TrimSearchTopContainersFilter.MaxResults

getset

Gets or sets a number indicating the maximum number of results to be returned by this search.

bool HP.HPTRIM.SDK.TrimSearchTopContainersFilter.OnlyBoxes

getset

Gets or sets a boolean value indicating if only record types that have behavior of 'Box' will be selected (a common archiving use case for physical records).

TrimDateTime HP.HPTRIM.SDK.TrimSearchTopContainersFilter.OnOrBeforeArchiveDate

getset

Gets or sets a date object indicating the cutoff date for any archiving action to be due.