HP.HPTRIM.SDK.TrimSearchStack Class Reference

The TrimSearchStack object is an array of TrimSearchStackItem objects, providing search parsing, clause iteration and conversion from linear (normal user presentation) to reverse-polish(as used by TrimMainItemSearch) More...

Inheritance diagram for HP.HPTRIM.SDK.TrimSearchStack:

Public Member Functions
System.Collections.IEnumerator	GetEnumerator ()
void	DisposeEnumerator (System.Collections.IEnumerator enumerator)
	TrimSearchStack (BaseObjectTypes forTrimObjectType, Database database)
	Construct a TrimSearchStack - basically an array of TrimSearchStackItem objects More...
TrimSearchStackItem	getItem (int idx)
	Gets a copy of the TrimSearchStackItem at the specified index More...
TrimSearchStackItem	get_Item (int idx)
TrimParserException	SetSearchString (string newSearch)
	Sets a string value representing the main search criteria for this list. See the TRIM HELP documentation for a comprehensive description of the Query String formatting rules. More...
void	ConvertToLinear ()
	Converts the stack to represent a linear stack representing what a user would type. Includes bracket operators to indicate order-of-precedence. More...
void	ConvertToReversePolish ()
	Converts the stack to a reverse-polish stack which is the way TRIM searches are formatted in the TrimMainObjectSearch search object. More...

Properties
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...
Database	Database [get]
	Gets the TRIM Database object in which this search stack resides. More...
BaseObjectTypes	TrimType [get]
	Gets a BaseObjectTypes enum value indicating the type of object for this search stack More...
uint	Length [get]
	Gets the number of TrimSearchStackItem objects in this array More...
string	SearchString [get]
	Gets a string value representing the main search criteria for this list. See the TRIM HELP documentation for a comprehensive description of the Query String formatting rules. More...
bool	IsReversePolish [get]
	Gets a boolean property indicating if the stack is currently in reverse-polish format (otherwise it will be a linear stack). In most cases, stacks provided by SDK functions will be reverse-polish, so the only time the stack will be linear is if a specific call has been made to ConvertToLinear. More...
TrimSearchStackIterator	TrimSearchStackIterator [get]

Detailed Description

The TrimSearchStack object is an array of TrimSearchStackItem objects, providing search parsing, clause iteration and conversion from linear (normal user presentation) to reverse-polish(as used by TrimMainItemSearch)

Constructor & Destructor Documentation

HP.HPTRIM.SDK.TrimSearchStack.TrimSearchStack	(	BaseObjectTypes	forTrimObjectType,
		Database	database
	)

Construct a TrimSearchStack - basically an array of TrimSearchStackItem objects

Member Function Documentation

void HP.HPTRIM.SDK.TrimSearchStack.ConvertToLinear

(

)

Converts the stack to represent a linear stack representing what a user would type. Includes bracket operators to indicate order-of-precedence.

void HP.HPTRIM.SDK.TrimSearchStack.ConvertToReversePolish

(

)

Converts the stack to a reverse-polish stack which is the way TRIM searches are formatted in the TrimMainObjectSearch search object.

void HP.HPTRIM.SDK.TrimSearchStack.DisposeEnumerator

(

System.Collections.IEnumerator

enumerator

)

TrimSearchStackItem HP.HPTRIM.SDK.TrimSearchStack.get_Item

(

int

idx

)

System.Collections.IEnumerator HP.HPTRIM.SDK.TrimSearchStack.GetEnumerator

(

)

TrimSearchStackItem HP.HPTRIM.SDK.TrimSearchStack.getItem

(

int

idx

)

Gets a copy of the TrimSearchStackItem at the specified index

TrimParserException HP.HPTRIM.SDK.TrimSearchStack.SetSearchString

(

string

newSearch

)

Sets a string value representing the main search criteria for this list. See the TRIM HELP documentation for a comprehensive description of the Query String formatting rules.

Property Documentation

Database HP.HPTRIM.SDK.TrimSearchStack.Database

get

Gets the TRIM Database object in which this search stack resides.

TrimException HP.HPTRIM.SDK.TrimSearchStack.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.

string HP.HPTRIM.SDK.TrimSearchStack.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.

bool HP.HPTRIM.SDK.TrimSearchStack.IsReversePolish

get

Gets a boolean property indicating if the stack is currently in reverse-polish format (otherwise it will be a linear stack). In most cases, stacks provided by SDK functions will be reverse-polish, so the only time the stack will be linear is if a specific call has been made to ConvertToLinear.

uint HP.HPTRIM.SDK.TrimSearchStack.Length

get

Gets the number of TrimSearchStackItem objects in this array

string HP.HPTRIM.SDK.TrimSearchStack.SearchString

get

Gets a string value representing the main search criteria for this list. See the TRIM HELP documentation for a comprehensive description of the Query String formatting rules.

TrimSearchStackIterator HP.HPTRIM.SDK.TrimSearchStack.TrimSearchStackIterator

get

BaseObjectTypes HP.HPTRIM.SDK.TrimSearchStack.TrimType

get

Gets a BaseObjectTypes enum value indicating the type of object for this search stack