Updating an EMu module

The Insert method is used to add a new record to the module.

Arguments

The method takes two arguments:

• values

  Specifies any data values to be inserted into the newly created record. The values argument should be a map object. The keys of the Map object must be column names.

• columns

  Used to specify which columns should be returned once the record has been created. The value of the column is specified in exactly the same way as in the Fetch method. See the section on Specifying columns for details.

  Note: It is very common to include irn as one of the columns to be returned. This gives a way of getting the key of the newly created record.

Return value

The method returns a Map object. The Map contains an entry for each column requested.

Example

C#

Module parties = new Module("eparties", session);

/* Specify the values to insert.

*/

Map values = new Map();

values.Add("NamFirst", "Chris");

values.Add("NamLast", "Froome");

String[] otherNames =

{

"Christopher",

"Froomey",

};

values.Add("NamOtherNames_tab", otherNames);

/* Specify the column values to return after inserting.

*/

String[] columns =

{

"irn",

"NamFirst",

"NamLast",

"NamOtherNames_tab"

};

/* Insert the new record.

*/

Map result = null;

try

{

result = parties.Insert(values, columns);

}

catch (IMuException e)

{

Console.WriteLine("Error: {0}", e);

Environment.Exit(1);

}

/* Output the returned values.

*/

int irn = result.GetInt("irn");

String first = result.GetString("NamFirst");

String last = result.GetString("NamLast");

String[] others = result.GetStrings("NamOtherNames_tab");

Console.WriteLine("{0}, {1} ({2})", last, first, irn);

Console.WriteLine("Other names:");

foreach (String other in others)

{

Console.WriteLine("\t{0}", other);

}

Environment.Exit(0);

If inserting records is allowed, the example will produce output similar to the following:

Froome, Chris (435)

Other names:

Christopher

Froomey

If inserting records is not allowed, the example will produce output similar to the following:

Error: ModuleUpdatesNotAllowed (authenticated,default)

The Update method is used to modify one or more existing records. This method operates very similarly to the Fetch method. The only difference is a values argument which contains a set of values to be applied to each specified record.

Arguments

The method takes five arguments:

• flag
• offset
• count

  These arguments are identical to those used by the Fetch method. They define the starting position and size of the block of records to be updated.

• values

  Specifies the columns to be updated in the specified block of records. The values argument should be a Map object. The keys of the Map object must be column names.

  This is the same as the values argument for the Insert method.

• columns

  Used to specify which columns should be returned once the record has been created. The value of the column is specified in exactly the same way as in the Fetch method. See the section on Specifying Columns for details.

  This is the same as the columns argument for the Insert method.

Return value

The Update method returns an ModuleFetchResult object (the same as the Fetch method). It contains the values for the selected block of records after the updates have been applied.

Example

C#

/* Find all parties records that have a first name of "Chris" and a

** last name of "Froome".

*/

Module parties = new Module("eparties", session);

Terms terms = new Terms();

terms.Add("NamFirst", "Chris");

terms.Add("NamLast", "Froome");

parties.FindTerms(terms);

/* Specify the column to update and the new value.

*/

Map values = new Map();

values.Add("NamFirst", "Christopher");

/* Specify the column values to return after updating.

*/

String[] columns =

{

"irn",

"NamFirst",

"NamLast"

};

/* Run the update.

*/

ModuleFetchResult result = null;

try

{

result = parties.Update("start", 0, -1, values, columns);

}

catch (IMuException e)

{

Console.WriteLine("Error: {0}", e);

Environment.Exit(1);

}

/* Output the returned values.

*/

Console.WriteLine("Count: {0}", result.Count);

Console.WriteLine("Hits: {0}", result.Hits);

Console.WriteLine("Rows:");

foreach (IMu.Map row in result.Rows)

{

int rowNum = row.GetInt("rownum");

int irn = row.GetInt("irn");

String first = row.GetString("NamFirst");

String last = row.GetString("NamLast");

Console.WriteLine("\t{0}. {1}, {2} ({3})", rowNum, last, first,

irn);

}

Environment.Exit(0);

If updating records is allowed, the example will produce output similar to the following:

Count: 1

Hits: 1

Rows:

1. Froome, Christopher (435)

The Remove method is used to remove one or more existing records.

Arguments

The method takes three arguments:

• flag
• offset
• count

  These arguments define the starting position and size of the block of records to be removed. They are identical to those used by the Fetch and Update methods.

Return value

The method returns a long that specifies the number of records that were removed.

Example

C#

/* Find all parties records that have a first name of "Christopher" and

** a last name of "Froome".

*/

Module parties = new Module("eparties", session);

Terms terms = new Terms();

terms.Add("NamFirst", "Christopher");

terms.Add("NamLast", "Froome");

parties.FindTerms(terms);

/* Remove all of the matching records.

*/

long result = 0;

try

{

result = parties.Remove("start", 0, -1);

}

catch (IMuException e)

{

Console.WriteLine("Error: {0}", e);

Environment.Exit(1);

}

/* Output the number of removed records.

*/

Console.WriteLine("Removed {0} record(s)", result);

Environment.Exit(0);

If removing records is allowed, the example will produce output similar to the following:

Removed 1 record(s)