Naanou.Common.Search
Class SearchResultSet

Search result set, which contains 0 or more SearchResults.

Field Summary
string ClientIdSerial
         The client's id
System.Exception exception
string Key
         Key for set
string requestSerial
Naanou.Common.Search.SearchResult[] result
int resultCount

Constructor Summary
SearchResultSet(string key, string clientIdSerial, string reqSerial)
         Constructor
SearchResultSet(string key, string clientIdSerial, string reqSerial, System.Exception e)
         Constructor

Property Summary
Naanou.Common.Search.SearchResult[] Result
         Gets the results (copy)
string Serial
         Gets client's id

Method Summary
void Add(Naanou.Common.Search.SearchResult newResult)
         Adds a search result to set
string Dump()
         Dump details of result set into as string
void SetSerial(string serial)
         Sets a serial for result set. Serial cannot be changed once set

Methods inherited from class System.Object
Equals, Finalize, GetHashCode, GetType, MemberwiseClone, ToString


Field Detail

ClientIdSerial

public string ClientIdSerial

The client's id


exception

private System.Exception exception


Key

public string Key

Key for set


requestSerial

private string requestSerial


result

private Naanou.Common.Search.SearchResult[] result


resultCount

private int resultCount

Constructor Detail

SearchResultSet

public SearchResultSet(string key,
                       string clientIdSerial,
                       string reqSerial)

Constructor

Parameters:
key - Key
clientIdSerial - Client id serial
reqSerial - Request serial

SearchResultSet

public SearchResultSet(string key,
                       string clientIdSerial,
                       string reqSerial,
                       System.Exception e)

Constructor

Parameters:
key - Key
clientIdSerial - Client id
e - Exception that occurred
reqSerial - Request serial
Throws:
System.ArgumentNullException - A required parameter has a null value
Property Detail

Result

public Naanou.Common.Search.SearchResult[] Result

Gets the results (copy)


Serial

public string Serial

Gets client's id

Method Detail

Add

public void Add(Naanou.Common.Search.SearchResult newResult)

Adds a search result to set

Parameters:
newResult - Result

Dump

public string Dump()

Dump details of result set into as string

Returns:
Dump

SetSerial

public void SetSerial(string serial)

Sets a serial for result set. Serial cannot be changed once set

Parameters:
serial - Serial to set
Throws:
System.InvalidOperationException - Serial is already set