eu.europeana.uim.sugarcrmclient.ws

Interface SugarWsClient

All Known Implementing Classes:

SugarWsClientImpl

public interface SugarWsClient

Interface describing the available SOAP based sugarCRM operations

Author:

Georgios Markakis

Method Summary

Methods

Modifier and Type	Method and Description
GetAvailableModulesResponse	getAvailableModules(GetAvailableModules request) Shows all the available module names in SugarCRM
GetEntriesResponse	getEntries(GetEntries request) Gets the entries for a request
GetEntryResponse	getEntry(GetEntry request) Gets a specific entry
GetEntryListResponse	getEntryList(GetEntryList request) Performs a query on the records contained in sugarCRM
GetModuleFieldsResponse	getModuleFields(GetModuleFields request) Get the fields for a specific module
GetNoteAttachmentResponse	getNoteAttachment(GetNoteAttachment request) Gets a note attachment from a record
String	getPassword()
GetRelationshipsResponse	getRelationships(GetRelationships request) Gets the Relationships for a specific module
String	getSessionID() Get the current session id
GetUserIdResponse	getUserId(GetUserId request) This method gives the user name of the user who "owns" the specific session
String	getUsername()
IsUserAdminResponse	isUserAdmin(IsUserAdmin request) This method returns an object indicating that the current user has admin privileges or not.
String	login(Login login) Public method for performing Login operations (see Junit test for usage example)
LoginResponse	login2(Login login) Public method for performing Login operations (see JUnit test for usage example)
LogoutResponse	logout(Logout request) Public method for performing Logout operations (see Junit test for usage example)
SetEntryResponse	setEntry(SetEntry request) Creates/Updates an entry in SugarCRM
SetNoteAttachmentResponse	setNoteAttachment(SetNoteAttachment request) Sets a note attachment to a record
void	setPassword(String password)
void	setSessionID(String sessionID) Set session id
void	setUsername(String username)

Method Detail

login

String login(Login login)
             throws JIXBLoginFailureException

Public method for performing Login operations (see Junit test for usage example)

Parameters:

login - the Login object

Returns:

a String containing the current Session id

Throws:

JIXBLoginFailureException - when login credentials are incorrect

GenericSugarCrmException

login2

LoginResponse login2(Login login)
                     throws JIXBLoginFailureException

Public method for performing Login operations (see JUnit test for usage example)

Parameters:

login -

Returns:

a LoginResponse object

Throws:

JIXBLoginFailureException - when login credentials are incorrect

GenericSugarCrmException

logout

LogoutResponse logout(Logout request)
                      throws JIXBLogoutFailureException

Public method for performing Logout operations (see Junit test for usage example)

Parameters:

a - logout request object

Returns:

a LogoutResponse object

Throws:

JIXBLogoutFailureException - when logout fails

GenericSugarCrmException

isUserAdmin

IsUserAdminResponse isUserAdmin(IsUserAdmin request)
                                throws Exception

This method returns an object indicating that the current user has admin privileges or not.

Parameters:

request -

Returns:

Throws:

GenericSugarCrmException

Exception

getUserId

GetUserIdResponse getUserId(GetUserId request)
                            throws Exception

This method gives the user name of the user who "owns" the specific session

Parameters:

request -

Returns:

Throws:

GenericSugarCrmException

Exception

getAvailableModules

GetAvailableModulesResponse getAvailableModules(GetAvailableModules request)
                                                throws JIXBQueryResultException

Shows all the available module names in SugarCRM

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

GenericSugarCrmException

getModuleFields

GetModuleFieldsResponse getModuleFields(GetModuleFields request)
                                        throws JIXBQueryResultException

Get the fields for a specific module

Parameters:

request -

Returns:

a GetModuleFieldsResponse containing a list of module fields

Throws:

JIXBQueryResultException

getEntryList

GetEntryListResponse getEntryList(GetEntryList request)
                                  throws JIXBQueryResultException

Performs a query on the records contained in sugarCRM

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

getEntry

GetEntryResponse getEntry(GetEntry request)
                          throws JIXBQueryResultException

Gets a specific entry

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

setEntry

SetEntryResponse setEntry(SetEntry request)
                          throws JIXBQueryResultException

Creates/Updates an entry in SugarCRM

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

getEntries

GetEntriesResponse getEntries(GetEntries request)
                              throws JIXBQueryResultException

Gets the entries for a request

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

setNoteAttachment

SetNoteAttachmentResponse setNoteAttachment(SetNoteAttachment request)
                                            throws JIXBFileAttachmentException

Sets a note attachment to a record

Parameters:

request -

Returns:

Throws:

JIXBFileAttachmentException

getNoteAttachment

GetNoteAttachmentResponse getNoteAttachment(GetNoteAttachment request)
                                            throws JIXBFileAttachmentException

Gets a note attachment from a record

Parameters:

request -

Returns:

Throws:

JIXBFileAttachmentException

getRelationships

GetRelationshipsResponse getRelationships(GetRelationships request)
                                          throws JIXBQueryResultException

Gets the Relationships for a specific module

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

setSessionID

void setSessionID(String sessionID)

Set session id

getSessionID

String getSessionID()

Get the current session id

Returns:

getUsername

String getUsername()

Returns:

setUsername

void setUsername(String username)

Parameters:

username -

getPassword

String getPassword()

Returns:

setPassword

void setPassword(String password)

Parameters:

password -