Public Member Functions
TrimSearchDataStreamItem	Current ()
	Gets the current item in the search result. The current item is setup by a successful call to MoveNext. More...

bool	MoveNext ()
	Moves to the next selected object in the search result. Returns false if the search results have been exhausted. More...

void	Reset ()
	Resets the data streaming iterator back to its initial state More...

void	SetBufferSize (long newBufferSize)
	Sets an underlying buffer size that may be useful to align with any external buffering by web services, etc. Call prior to any retrieval operation. More...

void	Release ()
	Indicates that this search data stream is no longer needed. Allows the resources allocated for making unstreamed pending results available to be freed. More...

Static Public Member Functions
static bool	IsObjectSupported (Database db, BaseObjectTypes forObject)
	A static function to determine if a particular type of object is supported for high performance data streaming by the TrimSearchDataStream class. All objects are supported by the data streaming class, as it now degrades gracefully. For multi-threaded server applications, this degraded performance can still be preferable to the normal client access methods of TrimMainObjectSearch. More...

static bool	IsPropertyOrFieldSupported (Database db, PropertyOrFieldDef propOrField, BaseObjectTypes forObject)
	A static function to determine if a particular property or field is supported for high performance data streaming by the TrimSearchDataStream class. All properties are supported by the data streaming class, as it now degrades gracefully. For multi-threaded server applications, this degraded performance can still be preferable to the normal client access methods of TrimMainObjectSearch. More...

Properties
bool	RetrieveLoginIdForLocations `[get, set]`
	Gets or sets a boolean value indicating whether to return location login id when retrieving properties of type Location. More...

bool	HasMoreItems `[get]`
	Gets a boolean property indicating if there are more items in the collection beyond the current one More...

Member Function Documentation

◆ Current()

TrimSearchDataStreamItem TRIM.SDK.TrimSearchDataStream.Current ( )

Gets the current item in the search result. The current item is setup by a successful call to MoveNext.

◆ IsObjectSupported()

static bool TRIM.SDK.TrimSearchDataStream.IsObjectSupported	(	Database	db,
		BaseObjectTypes	forObject
	)

static

A static function to determine if a particular type of object is supported for high performance data streaming by the TrimSearchDataStream class. All objects are supported by the data streaming class, as it now degrades gracefully. For multi-threaded server applications, this degraded performance can still be preferable to the normal client access methods of TrimMainObjectSearch.

◆ IsPropertyOrFieldSupported()

static bool TRIM.SDK.TrimSearchDataStream.IsPropertyOrFieldSupported	(	Database	db,
		PropertyOrFieldDef	propOrField,
		BaseObjectTypes	forObject
	)

static

A static function to determine if a particular property or field is supported for high performance data streaming by the TrimSearchDataStream class. All properties are supported by the data streaming class, as it now degrades gracefully. For multi-threaded server applications, this degraded performance can still be preferable to the normal client access methods of TrimMainObjectSearch.

◆ MoveNext()

bool TRIM.SDK.TrimSearchDataStream.MoveNext ( )

Moves to the next selected object in the search result. Returns false if the search results have been exhausted.

◆ Release()

void TRIM.SDK.TrimSearchDataStream.Release ( )

Indicates that this search data stream is no longer needed. Allows the resources allocated for making unstreamed pending results available to be freed.

◆ Reset()

void TRIM.SDK.TrimSearchDataStream.Reset ( )

Resets the data streaming iterator back to its initial state

◆ SetBufferSize()

void TRIM.SDK.TrimSearchDataStream.SetBufferSize ( long newBufferSize )

Sets an underlying buffer size that may be useful to align with any external buffering by web services, etc. Call prior to any retrieval operation.

Property Documentation

◆ HasMoreItems

bool TRIM.SDK.TrimSearchDataStream.HasMoreItems

get

Gets a boolean property indicating if there are more items in the collection beyond the current one

◆ RetrieveLoginIdForLocations

bool TRIM.SDK.TrimSearchDataStream.RetrieveLoginIdForLocations

getset

Gets or sets a boolean value indicating whether to return location login id when retrieving properties of type Location.

Public Member Functions

Static Public Member Functions

Properties