Interface IMDOAgent

Interface for the MDO Agent MDO Lists, reading, searching, and item lookup.

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("MDO Agent", "Interface for the MDO Agent. MDO Lists, reading, searching, and item lookup.")]
public interface IMDOAgent : IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

Methods

GetList(String, Boolean, String, Boolean)

Method to get a MDO list.

Declaration

MDOListItem[] GetList(string name, bool forceFlatList, string additionalInfo, bool onlyHistory)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list-
Boolean	forceFlatList	Force the list to be flat
String	additionalInfo	Additional info to the MDO provider
Boolean	onlyHistory	If true, return only history items

Returns

Type	Description
MDOListItem[]	Array of MDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetListIdByListName(String)

Retrieve the UdListDefinition id of a list, by its name. Not all lists have such an ID, but those that are based on tables do (the list name is then the same as the table name)

Declaration

int GetListIdByListName(string name)

Parameters

Type	Name	Description
String	name	The list name, same as the table name for lists that are backed by tables

Returns

Type	Description
Int32	List id in the UdListDefinition table

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetListItem(String, Int32)

Returns a single list item

Declaration

MDOListItem GetListItem(string listName, int id)

Parameters

Type	Name	Description
String	listName	Conceptual name of the MDO list
Int32	id	Id of list item

Returns

Type	Description
MDOListItem	Single MDO list item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetListNames()

Returns a list of all MDO List names. These names can also be used with the Archive agent as ProviderNames.

Declaration

string[] GetListNames()

Returns

Type	Description
String[]	Array of list names.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetListWithHistory(String, Boolean, String, Int32[], Boolean)

Method to get a MDO list with own history list.

Declaration

MDOListItem[] GetListWithHistory(string name, bool forceFlatList, string additionalInfo, int[] historyItems, bool onlyHistory)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list-
Boolean	forceFlatList	Force the list to be flat
String	additionalInfo	Additional info to the MDO provider
Int32[]	historyItems	An array of ids, used to get the history list
Boolean	onlyHistory	If true, return only history items

Returns

Type	Description
MDOListItem[]	Array of MDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetListWithRestriction(String, String, String)

Method to get a MDO list with restrictions.

Declaration

MDOListItem[] GetListWithRestriction(string name, string additionalInfo, string searchValue)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list-
String	additionalInfo	Additional info to the MDO provider
String	searchValue	the value used to restrict the list

Returns

Type	Description
MDOListItem[]	Array of MDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetSelectableList(String, Boolean, String, Boolean)

Method to get a Selectable MDO list.

Declaration

SelectableMDOListItem[] GetSelectableList(string name, bool forceFlatList, string additionalInfo, bool onlyHistory)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list.
Boolean	forceFlatList	Force the list to be flat
String	additionalInfo	Additional info to the MDO provider
Boolean	onlyHistory	If true, return only history items

Returns

Type	Description
SelectableMDOListItem[]	Array of SelectableMDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetSelectableListWithHistory(String, Boolean, String, Int32[], Boolean)

Method to get a Selectable MDO list with own history list.

Declaration

SelectableMDOListItem[] GetSelectableListWithHistory(string name, bool forceFlatList, string additionalInfo, int[] historyItems, bool onlyHistory)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list.
Boolean	forceFlatList	Force the list to be flat
String	additionalInfo	Additional info to the MDO provider
Int32[]	historyItems	An array of ids, used to get the history list
Boolean	onlyHistory	If true, return only history items

Returns

Type	Description
SelectableMDOListItem[]	Array of SelectableMDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetSelectableListWithRestriction(String, String, String)

Method to get a Selectable MDO list with restrictions.

Declaration

SelectableMDOListItem[] GetSelectableListWithRestriction(string name, string additionalInfo, string searchValue)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list
String	additionalInfo	Additional info to the MDO provider
String	searchValue	the value used to restrict the list

Returns

Type	Description
SelectableMDOListItem[]	Array of SelectableMDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetSelectableSimpleList(String)

Method returns a flat Selectable MDO List.

Declaration

SelectableMDOListItem[] GetSelectableSimpleList(string name)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list

Returns

Type	Description
SelectableMDOListItem[]	Array of SelectableMDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

GetSimpleList(String)

Method returns a simple flat MDO List.

Declaration

MDOListItem[] GetSimpleList(string name)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list.

Returns

Type	Description
MDOListItem[]	Array of MDOListItem

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }

SetSelected(String, String, SelectableMDOListItem[])

Saves the selected values as selected by their given list representation.

Declaration

SelectableMDOListItem[] SetSelected(string name, string additionalInfo, SelectableMDOListItem[] selectableMDOList)

Parameters

Type	Name	Description
String	name	Conceptual name of the MDO list
String	additionalInfo	Additional info to the MDO provider
SelectableMDOListItem[]	selectableMDOList	Items to be updated

Returns

Type	Description
SelectableMDOListItem[]	Array of updated SelectableMDOListItems

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (MDOAgent agent = new MDOAgent())
     {
        // call methods on agent here...
     }
  }