SearchOptionsKit

class HPS.SearchOptionsKit : HPS.Kit

The SearchOptionsKit class is a user space object. It contains options used when performing a search.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this SearchOptionsKit has any values set on it.

Return:true if no values are set on this SearchOptionsKit, false otherwise.

bool Equals (HPS.SearchOptionsKit in_kit)

Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit.

Param in_kit:The source SearchOptionsKit to compare to this SearchOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

SearchOptionsKit ()

The default constructor creates an empty SearchOptionsKit object.

SearchOptionsKit (HPS.SearchOptionsKit in_kit)

The copy constructor creates a new SearchOptionsKit object that contains the same settings as the source SearchOptionsKit.

Param in_kit:The source SearchOptionsKit to copy.

void Set (HPS.SearchOptionsKit in_kit)

Copies the source SearchOptionsKit into this SearchOptionsKit.

Param in_kit:The source SearchOptionsKit to copy.

HPS.SearchOptionsKit SetBehavior (HPS.Search.Behavior in_behavior)

Sets the behavior to use when performing a search.

Param in_behavior:  The behavior to use when performing a search. Return:A reference to this SearchOptionsKit.

HPS.SearchOptionsKit SetCriteria (HPS.Search.Type in_request)

Sets the type of entity to look for when performing a search.

Param in_request:  The type of entity to look for. Return:A reference to this SearchOptionsKit.

HPS.SearchOptionsKit SetCriteria (HPS.Search.Type[] in_requests)

Sets the type of entities to look for when performing a search.

Param in_requests:  Array of the entity types to look for. Return:A reference to this SearchOptionsKit.

HPS.SearchOptionsKit SetSearchSpace (HPS.Search.Space in_search_space)

Sets which segments to look in when performing a search.

Param in_search_space:  Which segments to look in when performing a search. Return:A reference to this SearchOptionsKit.

void Show (out HPS.SearchOptionsKit out_kit)

Copies this SearchOptionsKit into the given SearchOptionsKit.

Param out_kit:The SearchOptionsKit to populate with the contents of this SearchOptionsKit.

bool ShowBehavior (out HPS.Search.Behavior out_behavior)

Shows the behavior to use when performing a search.

Param out_behavior:  The behavior to use when performing a search. Return:true if a behavior was set, false otherwise.

bool ShowCriteria (out HPS.Search.Type[] out_types)

Shows the entity types to look for when performing a search.

Param out_types:  Array of the entity types to look for. Return:true if the array is valid, false otherwise.

bool ShowSearchSpace (out HPS.Search.Space out_search_space)

Shows which segments to look in when performing a search.

Param out_search_space:  Which segments to look in when performing a search. Return:true if the search space is valid, false otherwise.

HPS.SearchOptionsKit UnsetBehavior ()

Removes the behavior to use when performing a search.

Return:A reference to this SearchOptionsKit.

HPS.SearchOptionsKit UnsetCriteria ()

Removes the entity types to look for when performing a search.

Return:A reference to this SearchOptionsKit.

HPS.SearchOptionsKit UnsetEverything ()

Removes all settings from this SearchOptionsKit.

Return:A reference to this SearchOptionsKit.

HPS.SearchOptionsKit UnsetSearchSpace ()

Removes which segments to look in when performing a search.

Return:A reference to this SearchOptionsKit.

Public Static Functions

HPS.SearchOptionsKit GetDefault ()

Creates a SearchOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return:A SearchOptionsKit with the default settings.

bool operator!= (HPS.SearchOptionsKit a, HPS.SearchOptionsKit b)

bool operator== (HPS.SearchOptionsKit a, HPS.SearchOptionsKit b)