Summary: Methods | [Expand All]
public interface

SugarCrmClient

org.mule.modules.sugarcrm.api.SugarCrmClient
Known Indirect Subclasses

Class Overview

The SugarCRM Client

Summary

Public Methods
abstract GetAvailableModulesResponseType getAvailableModules(GetAvailableModulesRequestType request)
Retrieves the list of modules available to the current user logged into the system.
abstract GetEntriesCountResponseType getCountEntries(GetEntriesCountRequestType request)
Retrieves the specified number of records in a module.
abstract GetEntriesResponseType getEntries(GetEntriesRequestType request)
Retrieves multiple SugarBeans based on IDs.
abstract GetEntryResponseType getEntry(GetEntryRequestType request)
Retrieves a single SugarBean based on ID
abstract GetEntryListResponseType getEntryList(GetEntryListRequestType request)
Retrieves a list of SugarBeans
abstract GetModuleFieldsResponseType getModuleFields(GetModuleFieldsRequestType request)
Retrieves the vardef information on fields of the specified bean.
abstract GetRelationshipsResponseType getRelationships(GetRelationshipsRequestType request)
Retrieves a collection of beans that are related to the specified bean and, optionally, return relationship data for the related beans
abstract LoginResponseType login(LoginRequestType request)
Logs the user into the Sugar application.
abstract LogoutResponseType logout(LogoutRequestType request)
Logs out the user from the current session.
abstract SearchByModuleResponseType searchByModule(SearchByModuleRequestType request)
Returns the ID, module_name, and fields for the specified modules as specified in the search string.
abstract SetEntriesResponseType setEntries(SetEntriesRequestType request)
Creates or updates a list of SugarBeans.
abstract SetEntryResponseType setEntry(SetEntryRequestType request)
Creates or updates a single SugarBean.
abstract SetRelationshipResponseType setRelationship(SetRelationshipRequestType request)
Sets a single relationship between two beans where items are related by module name and ID.
abstract SetRelationshipsResponseType setRelationships(SetRelationshipsRequestType request)
Sets multiple relationships between two beans where items are related by module name and ID.

Public Methods

public abstract GetAvailableModulesResponseType getAvailableModules (GetAvailableModulesRequestType request)

Retrieves the list of modules available to the current user logged into the system.

Parameters
request

public abstract GetEntriesCountResponseType getCountEntries (GetEntriesCountRequestType request)

Retrieves the specified number of records in a module.

Parameters
request

public abstract GetEntriesResponseType getEntries (GetEntriesRequestType request)

Retrieves multiple SugarBeans based on IDs.

Parameters
request

public abstract GetEntryResponseType getEntry (GetEntryRequestType request)

Retrieves a single SugarBean based on ID

Parameters
request

public abstract GetEntryListResponseType getEntryList (GetEntryListRequestType request)

Retrieves a list of SugarBeans

Parameters
request

public abstract GetModuleFieldsResponseType getModuleFields (GetModuleFieldsRequestType request)

Retrieves the vardef information on fields of the specified bean.

Parameters
request

public abstract GetRelationshipsResponseType getRelationships (GetRelationshipsRequestType request)

Retrieves a collection of beans that are related to the specified bean and, optionally, return relationship data for the related beans

Parameters
request

public abstract LoginResponseType login (LoginRequestType request)

Logs the user into the Sugar application.

Parameters
request

public abstract LogoutResponseType logout (LogoutRequestType request)

Logs out the user from the current session.

Parameters
request

public abstract SearchByModuleResponseType searchByModule (SearchByModuleRequestType request)

Returns the ID, module_name, and fields for the specified modules as specified in the search string.

Parameters
request

public abstract SetEntriesResponseType setEntries (SetEntriesRequestType request)

Creates or updates a list of SugarBeans.

Parameters
request

public abstract SetEntryResponseType setEntry (SetEntryRequestType request)

Creates or updates a single SugarBean.

Parameters
request

public abstract SetRelationshipResponseType setRelationship (SetRelationshipRequestType request)

Sets a single relationship between two beans where items are related by module name and ID.

Parameters
request

public abstract SetRelationshipsResponseType setRelationships (SetRelationshipsRequestType request)

Sets multiple relationships between two beans where items are related by module name and ID.

Parameters
request