public class

SugarCrmClientSoap

extends Object
implements SugarCrmClient
java.lang.Object
   ↳ org.mule.modules.sugarcrm.api.SugarCrmClientSoap

Summary

Fields
private final String endpoint
private SugarsoapPortType service
Public Constructors
SugarCrmClientSoap(String endpoint)
Public Methods
GetAvailableModulesResponseType getAvailableModules(GetAvailableModulesRequestType request)
Retrieves the list of modules available to the current user logged into the system.
GetEntriesCountResponseType getCountEntries(GetEntriesCountRequestType request)
Retrieves the specified number of records in a module.
GetEntriesResponseType getEntries(GetEntriesRequestType request)
Retrieves multiple SugarBeans based on IDs.
GetEntryResponseType getEntry(GetEntryRequestType request)
Retrieves a single SugarBean based on ID
GetEntryListResponseType getEntryList(GetEntryListRequestType request)
Retrieves a list of SugarBeans
GetModuleFieldsResponseType getModuleFields(GetModuleFieldsRequestType request)
Retrieves the vardef information on fields of the specified bean.
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
LoginResponseType login(LoginRequestType request)
Logs the user into the Sugar application.
LogoutResponseType logout(LogoutRequestType request)
Logs out the user from the current session.
SearchByModuleResponseType searchByModule(SearchByModuleRequestType request)
Returns the ID, module_name, and fields for the specified modules as specified in the search string.
SetEntriesResponseType setEntries(SetEntriesRequestType request)
Creates or updates a list of SugarBeans.
SetEntryResponseType setEntry(SetEntryRequestType request)
Creates or updates a single SugarBean.
SetRelationshipResponseType setRelationship(SetRelationshipRequestType request)
Sets a single relationship between two beans where items are related by module name and ID.
SetRelationshipsResponseType setRelationships(SetRelationshipsRequestType request)
Sets multiple relationships between two beans where items are related by module name and ID.
Protected Methods
SugarsoapPortType getService()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.mule.modules.sugarcrm.api.SugarCrmClient

Fields

private final String endpoint

private SugarsoapPortType service

Public Constructors

public SugarCrmClientSoap (String endpoint)

Parameters
endpoint

Public Methods

public GetAvailableModulesResponseType getAvailableModules (GetAvailableModulesRequestType request)

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

Parameters
request

public GetEntriesCountResponseType getCountEntries (GetEntriesCountRequestType request)

Retrieves the specified number of records in a module.

Parameters
request

public GetEntriesResponseType getEntries (GetEntriesRequestType request)

Retrieves multiple SugarBeans based on IDs.

Parameters
request

public GetEntryResponseType getEntry (GetEntryRequestType request)

Retrieves a single SugarBean based on ID

Parameters
request

public GetEntryListResponseType getEntryList (GetEntryListRequestType request)

Retrieves a list of SugarBeans

Parameters
request

public GetModuleFieldsResponseType getModuleFields (GetModuleFieldsRequestType request)

Retrieves the vardef information on fields of the specified bean.

Parameters
request

public 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 LoginResponseType login (LoginRequestType request)

Logs the user into the Sugar application.

Parameters
request

public LogoutResponseType logout (LogoutRequestType request)

Logs out the user from the current session.

Parameters
request

public SearchByModuleResponseType searchByModule (SearchByModuleRequestType request)

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

Parameters
request

public SetEntriesResponseType setEntries (SetEntriesRequestType request)

Creates or updates a list of SugarBeans.

Parameters
request

public SetEntryResponseType setEntry (SetEntryRequestType request)

Creates or updates a single SugarBean.

Parameters
request

public SetRelationshipResponseType setRelationship (SetRelationshipRequestType request)

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

Parameters
request

public SetRelationshipsResponseType setRelationships (SetRelationshipsRequestType request)

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

Parameters
request

Protected Methods

protected SugarsoapPortType getService ()