Module

IMu.Module

IMu.Module

Since: 1.0

Description

Provides access to an EMu module.

Constructors

Constructor

Details

Module(table, session)

Module(string table, Session session)

Creates an object which can be used to access the EMu module specified by table.

Parameters:

table (string)

Name of the EMu module to be accessed.

session (Session)

A Session object to be used to communicate with the IMu server.

Module(table)

Module(string table)

Creates an object which can be used to access the EMu module specified by table and the Session class's default host and port values.

Parameters:

table (string)

Name of the EMu module to be accessed.

Properties

Property

Details
Table

string Table

The name of the table associated with the Module object.

Methods

Method

Details

AddFetchSet(name, columns)

int AddFetchSet(string name, string columns)

Associates a set of columns with a logical name on the server. The name can be used instead of a column list when retrieving data using Fetch( ).

Parameters:

name (string)

The logical name to associate with the set of columns.

columns (string)

A string containing the names of the columns to be used when name is passed to Fetch( ). The column names must be separated by a semi-colon or a comma.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddFetchSet(name, columns)

int AddFetchSet(string name, string[] columns)

Associates a set of columns with a logical name on the server. The name can be used instead of a column list when retrieving data using Fetch( ).

Parameters:

name (string)

The logical name to associate with the set of columns.

columns (string[])

An array of strings containing the names of the columns to be used when name is passed to Fetch( ).

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddFetchSet(name, columns)

int AddFetchSet(string name, List<string> columns)

Associates a set of columns with a logical name on the server. The name can be used instead of a column list when retrieving data using Fetch( ).

Parameters:

name (string)

The logical name to associate with the set of columns.

columns (List<string>)

A list of strings containing the names of the columns to be used when name is passed to Fetch( ).

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddFetchSets(sets)

int AddFetchSets(Map sets)

Associates several sets of columns with logical names on the server.

This is the equivalent of calling AddFetchSet( ) for each entry in the map but is more efficient.

Parameters:

sets (Map)

A Map containing a set of mappings between a name and a set of columns.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSearchAlias(name, columns)

int AddSearchAlias(string name, string columns)

Associates a set of columns with a logical name on the server.

The name can be used when specifying search terms to be passed to FindTerms( ). The search becomes the equivalent of an OR search involving the columns.

Parameters:

name (string)

The logical name to associate with the set of columns.

columns (string)

A string containing the names of columns to be used when name is passed to FindTerms( ). The column names must be separated by a semi-colon or a comma.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSearchAlias(name, columns)

int AddSearchAlias(string name, string[] columns)

Associates a set of columns with a logical name on the server.

The name can be used when specifying search terms to be passed to FindTerms( ). The search becomes the equivalent of an OR search involving the columns.

Parameters:

name (string)

The logical name to associate with the set of columns.

columns (string[])

An array of strings containing the names of columns to be used when name is passed to FindTerms( ).

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSearchAlias(name, columns)

int AddSearchAlias(string name, List<string> columns)

Associates a set of columns with a logical name on the server.

The name can be used when specifying search terms to be passed to FindTerms( ). The search becomes the equivalent of an OR search involving the columns.

Parameters:

name (string)

The logical name to associate with the set of columns.

columns (List<string>)

A list of strings containing the names of columns to be used when name is passed to FindTerms( ).

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSearchAliases(aliases)

int AddSearchAliases(Map aliases)

Associates a set of columns with a logical name on the server.

This is the equivalent of calling AddSearchAlias( ) for each entry in the map but is more efficient.

Parameters:

aliases (Map)

A Map containing a set of mappings between a name and a set of columns.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSortSet(name, keys)

int AddSortSet(string name, string keys)

Associates a set of sort keys with a logical name on the server.

The name can be used instead of a sort key list when sorting the current result set using Sort( ).

Parameters:

name (string)

The logical name to associate with the set of columns.

keys (string)

A string containing the names of the keys to be used when name is passed to Sort( ). The keys must be separated by a semi-colon or a comma.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSortSet(name, keys)

Associates a set of sort keys with a logical name on the server.

int AddSortSet(string name, string[] keys)

Associates a set of sort keys with a logical name on the server.

Parameters:

name (string)

The logical name to associate with the set of columns.

keys (string[])

An array of strings containing the names of the keys to be used when name is passed to Sort( ). The keys must be separated by a semi-colon or a comma.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSortSet(name, keys)

int AddSortSet(string name, List<string> keys)

Associates a set of sort keys with a logical name on the server.

Parameters:

name (string)

The logical name to associate with the set of columns.

keys (List<string>)

A list of strings containing the names of the keys to be used when name is passed to Sort( ). The keys must be separated by a semi-colon or a comma.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

AddSortSets(sets)

Associates several sets of sort keys with logical names on the server.

int AddSortSets(Map sets)

Associates several sets of sort keys with logical names on the server.

This is the equivalent of calling AddSortSet( ) for each entry in the map but is more efficient.

Parameters:

sets (Map)

A Map containing a set of mappings between a name and a set of keys.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

Fetch(flag, offset, count, columns)

ModuleFetchResult Fetch(string flag, long offset, int count, string columns)

Fetches count records from the position described by a combination of flag and offset.

Parameters:

flag (string)

The position to start fetching records from. Must be one of: start, current, end

offset (long)

The position relative to flag to start fetching from.

count (int)

The number of records to fetch. A count of 0 is permitted to change the location of the current record without returning any results. A count of less than 0 causes all the remaining records in the result set to be returned.

columns (string)

 

A string containing the names of the columns to be returned for each record or the name of a column set which has been registered previously using AddFetchSet( ). The column names must be separated by a semi-colon or a comma.

Returns:

ModuleFetchResult

A ModuleFetchResult object.

Throws:

IMuException

If a server-side error occurred.

Fetch(flag, offset, count, columns)

ModuleFetchResult Fetch(string flag, long offset, int count, string[] columns)

Fetches count records from the position described by a combination of flag and offset.

Parameters:

flag (string)

The position to start fetching records from. Must be one of: start, current, end

offset (long)

The position relative to flag to start fetching from.

count (int)

The number of records to fetch. A count of 0 is permitted to change the location of the current record without returning any results. A count of less than 0 causes all the remaining records in the result set to be returned.

columns (string[])

 

An array of strings containing the names of the columns to be returned for each record or the name of a column set which has been registered previously using AddFetchSet( ).

Returns:

ModuleFetchResult

A ModuleFetchResult object.

Throws:

IMuException

If a server-side error occurred.

Fetch(flag, offset, count, columns)

ModuleFetchResult Fetch(string flag, long offset, int count, List<string> columns)

Fetches count records from the position described by a combination of flag and offset.

Parameters:

flag (string)

The position to start fetching records from. Must be one of: start, current, end

offset (long)

The position relative to flag to start fetching from.

count (int)

The number of records to fetch. A count of 0 is permitted to change the location of the current record without returning any results. A count of less than 0 causes all the remaining records in the result set to be returned.

columns (List<string>)

A list of strings containing the names of the columns to be returned for each record or the name of a column set which has been registered previously using AddFetchSet( ).

Returns:

ModuleFetchResult

A ModuleFetchResult object.

Throws:

IMuException

If a server-side error occurred.

Fetch(flag, offset, count)

ModuleFetchResult Fetch(string flag, long offset, int count)

Fetches count records from the position described by a combination of flag and offset.

Parameters:

flag (string)

The position to start fetching records from. Must be one of: start, current, end

offset (long)

The position relative to flag to start fetching from.

count (int)

The number of records to fetch. A count of 0 is permitted to change the location of the current record without returning any results. A count of less than 0 causes all the remaining records in the result set to be returned.

Returns:

ModuleFetchResult

A ModuleFetchResult object.

Throws:

IMuException

If a server-side error occurred.

FindKey(key)

long FindKey(long key)

Searches for a record with the key value key.

Parameters:

key (long)

The key of the record being searched for.

Returns:

long

The number of records found. This will be either 1 if the record was found or 0 if not found.

Throws:

IMuException

If a server-side error occurred.

FindKeys(keys)

long FindKeys(long[] keys)

Searches for records with key values in the array keys.

Parameters:

keys (long[])

The list of keys being searched for.

Returns:

long

 
long - The number of records found.

Throws:

IMuException

If a server-side error occurred.

FindKeys(keys)

long FindKeys(List<long> keys)

Searches for records with key values in the array keys.

Parameters:

keys (List<long>)

An array of keys being searched for.

Returns:

long

The number of records found.

Throws:

IMuException

If a server-side error occurred.

FindTerms(terms)

long FindTerms(Terms terms)

Searches for records which match the search terms specified in terms.

Parameters:

terms (Terms)

The search terms.

Returns:

long

An estimate of the number of records found.

Throws:

IMuException

If a server-side error occurred.

FindWhere(where)

long FindWhere(string where)

Searches for records which match the TexQL WHERE clause.

Parameters:

where (string)

The TexQL WHERE clause to use.

Returns:

long

An estimate of the number of records found.

Throws:

IMuException

If a server-side error occurred.

RestoreFromFile(file)

long RestoreFromFile(string file)

Restores a set of records from a file on the server machine which contains a list of keys, one per line.

Parameters:

file (string)

The file on the server machine containing the keys.

Returns:

long

The number of records found.

Throws:

IMuException

If a server-side error occurred.

RestoreFromTemp(file)

long RestoreFromTemp(string file)

Restores a set of records from a temporary file on the server machine which contains a list of keys, one per line. Operates the same way as RestoreFromFile( ) except that the file parameter is relative to the server's temporary directory.

Parameters:

file (string)

The file on the server machine containing the keys.

Returns:

long

The number of records found.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(string keys, string flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (string)

A string containing the list of sort keys. The keys must be separated by a semi-colon or a comma.

flags (string)

A string containing a set of flags specifying the behaviour of the sort. The flags must be separated by a semi-colon or a comma.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(string keys, string[] flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (string)

A string containing the list of sort keys. The keys must be separated by a semi-colon or a comma.

flags (string[])

An array of strings specifying the behaviour of the sort.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(string keys, List<string> flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (string)

A string containing the list of sort keys. The keys must be separated by a semi-colon or a comma.

flags (List<string>)

A list of strings specifying the behaviour of the sort.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(string[] keys, string flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (string[])

An array of strings containing the list of sort keys.

flags (string)

A string containing a set of flags specifying the behaviour of the sort. The flags must be separated by a semi-colon or a comma.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(string[] keys, string[] flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (string[])

An array of strings containing the list of sort keys.

flags (string[])

An array of strings specifying the behaviour of the sort.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)
ModuleSortResult Sort(string[] keys, List<string> flags)

Sorts the current result set by the sort keys in keys.

Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (string[])

An array of strings containing the list of sort keys.

flags (List<string>)

A list of strings specifying the behaviour of the sort.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(List<string> keys, string flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (List<string>)

A list of strings containing the list of sort keys.

flags (string)

A string containing a set of flags specifying the behaviour of the sort. The flags must be separated by a semi-colon or a comma.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(List<string> keys, string[] flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (List<string>)

A list of strings containing the list of sort keys.

flags (string[])

An array of strings specifying the behaviour of the sort.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.

Sort(keys, flags)

ModuleSortResult Sort(List<string> keys, List<string> flags)

Sorts the current result set by the sort keys in keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for a descending sort).

Parameters:

keys (List<string>)

A list of strings containing the list of sort keys.

flags (List<string>)

A list of strings specifying the behaviour of the sort.

Returns:

ModuleSortResult

A ModuleSortResult object. If the report flag has not been specified, the result will be null.

Throws:

IMuException

If a server-side error occurred.