Class MDOAgent

Proxy class for the MDO Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Inheritance

object

MDOAgent

Implements

IMDOAgent

IAgent

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.Implementation.dll

Syntax

public class MDOAgent : IMDOAgent, IAgent

Constructors

MDOAgent(IMDOListImplementation, ISelectableMDOListImplementation, ISoRequestItemsAccessor)

Proxy class for the MDO Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public MDOAgent(IMDOListImplementation mDOListImplementation, ISelectableMDOListImplementation selectableMDOListImplementation, ISoRequestItemsAccessor accessor)

Parameters

Type	Name	Description
IMDOListImplementation	mDOListImplementation
ISelectableMDOListImplementation	selectableMDOListImplementation
ISoRequestItemsAccessor	accessor

MDOAgent(IMDOListImplementation, ISelectableMDOListImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)

Proxy class for the MDO Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public MDOAgent(IMDOListImplementation mDOListImplementation, ISelectableMDOListImplementation selectableMDOListImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)

Parameters

Type	Name	Description
IMDOListImplementation	mDOListImplementation
ISelectableMDOListImplementation	selectableMDOListImplementation
ISoRequestItemsAccessor	accessor
IDebugUser	debugUser
IServiceCallsRepository	serviceCallsRepository
IScriptingConfiguration	scriptingConfiguration
IOnlineConfiguration	onlineConfiguration

Methods

GetListAsync(string, bool, string, bool, CancellationToken)

Method to get a MDO list.

Declaration

public Task<MDOListItem[]> GetListAsync(string name, bool forceFlatList, string additionalInfo, bool onlyHistory, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Conceptual name of the MDO list-
bool	forceFlatList	Force the list to be flat
string	additionalInfo	Additional info to the MDO provider
bool	onlyHistory	If true, return only history items
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<MDOListItem[]>	Array of MDOListItem

GetListIdByListNameAsync(string, CancellationToken)

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

public Task<int> GetListIdByListNameAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The list name, same as the table name for lists that are backed by tables
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<int>	List id in the UdListDefinition table

GetListItemAsync(string, int, CancellationToken)

Returns a single list item

Declaration

public Task<MDOListItem> GetListItemAsync(string listName, int id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Conceptual name of the MDO list
int	id	Id of list item
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<MDOListItem>	Single MDO list item

GetListNamesAsync(CancellationToken)

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

Declaration

public Task<string[]> GetListNamesAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<string[]>	Array of list names.

GetListWithHistoryAsync(string, bool, string, int[], bool, CancellationToken)

Method to get a MDO list with own history list.

Declaration

public Task<MDOListItem[]> GetListWithHistoryAsync(string name, bool forceFlatList, string additionalInfo, int[] historyItems, bool onlyHistory, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Conceptual name of the MDO list-
bool	forceFlatList	Force the list to be flat
string	additionalInfo	Additional info to the MDO provider
int[]	historyItems	An array of ids, used to get the history list
bool	onlyHistory	If true, return only history items
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<MDOListItem[]>	Array of MDOListItem

GetListWithRestrictionAsync(string, string, string, CancellationToken)

Method to get a MDO list with restrictions.

Declaration

public Task<MDOListItem[]> GetListWithRestrictionAsync(string name, string additionalInfo, string searchValue, CancellationToken cancellationToken = default)

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
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<MDOListItem[]>	Array of MDOListItem

GetSelectableListAsync(string, bool, string, bool, CancellationToken)

Method to get a Selectable MDO list.

Declaration

public Task<SelectableMDOListItem[]> GetSelectableListAsync(string name, bool forceFlatList, string additionalInfo, bool onlyHistory, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Conceptual name of the MDO list.
bool	forceFlatList	Force the list to be flat
string	additionalInfo	Additional info to the MDO provider
bool	onlyHistory	If true, return only history items
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<SelectableMDOListItem[]>	Array of SelectableMDOListItem

GetSelectableListWithHistoryAsync(string, bool, string, int[], bool, CancellationToken)

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

Declaration

public Task<SelectableMDOListItem[]> GetSelectableListWithHistoryAsync(string name, bool forceFlatList, string additionalInfo, int[] historyItems, bool onlyHistory, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Conceptual name of the MDO list.
bool	forceFlatList	Force the list to be flat
string	additionalInfo	Additional info to the MDO provider
int[]	historyItems	An array of ids, used to get the history list
bool	onlyHistory	If true, return only history items
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<SelectableMDOListItem[]>	Array of SelectableMDOListItem

GetSelectableListWithRestrictionAsync(string, string, string, CancellationToken)

Method to get a Selectable MDO list with restrictions.

Declaration

public Task<SelectableMDOListItem[]> GetSelectableListWithRestrictionAsync(string name, string additionalInfo, string searchValue, CancellationToken cancellationToken = default)

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
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<SelectableMDOListItem[]>	Array of SelectableMDOListItem

GetSelectableSimpleListAsync(string, CancellationToken)

Method returns a flat Selectable MDO List.

Declaration

public Task<SelectableMDOListItem[]> GetSelectableSimpleListAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Conceptual name of the MDO list
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<SelectableMDOListItem[]>	Array of SelectableMDOListItem

GetSimpleListAsync(string, CancellationToken)

Method returns a simple flat MDO List.

Declaration

public Task<MDOListItem[]> GetSimpleListAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Conceptual name of the MDO list.
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<MDOListItem[]>	Array of MDOListItem

SetSelectedAsync(string, string, SelectableMDOListItem[], CancellationToken)

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

Declaration

public Task<SelectableMDOListItem[]> SetSelectedAsync(string name, string additionalInfo, SelectableMDOListItem[] selectableMDOList, CancellationToken cancellationToken = default)

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
CancellationToken	cancellationToken	This operation can be cancelled

Returns

Type	Description
Task<SelectableMDOListItem[]>	Array of updated SelectableMDOListItems

Implements

IMDOAgent

IAgent