public interface SugarWsClient
| 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) |
String login(Login login) throws JIXBLoginFailureException
login - the Login objectJIXBLoginFailureException - when login credentials are incorrectGenericSugarCrmExceptionLoginResponse login2(Login login) throws JIXBLoginFailureException
login - JIXBLoginFailureException - when login credentials are incorrectGenericSugarCrmExceptionLogoutResponse logout(Logout request) throws JIXBLogoutFailureException
a - logout request objectJIXBLogoutFailureException - when logout failsGenericSugarCrmExceptionIsUserAdminResponse isUserAdmin(IsUserAdmin request) throws Exception
request - GenericSugarCrmExceptionExceptionGetUserIdResponse getUserId(GetUserId request) throws Exception
request - GenericSugarCrmExceptionExceptionGetAvailableModulesResponse getAvailableModules(GetAvailableModules request) throws JIXBQueryResultException
request - JIXBQueryResultExceptionGenericSugarCrmExceptionGetModuleFieldsResponse getModuleFields(GetModuleFields request) throws JIXBQueryResultException
request - JIXBQueryResultExceptionGetEntryListResponse getEntryList(GetEntryList request) throws JIXBQueryResultException
request - JIXBQueryResultExceptionGetEntryResponse getEntry(GetEntry request) throws JIXBQueryResultException
request - JIXBQueryResultExceptionSetEntryResponse setEntry(SetEntry request) throws JIXBQueryResultException
request - JIXBQueryResultExceptionGetEntriesResponse getEntries(GetEntries request) throws JIXBQueryResultException
request - JIXBQueryResultExceptionSetNoteAttachmentResponse setNoteAttachment(SetNoteAttachment request) throws JIXBFileAttachmentException
request - JIXBFileAttachmentExceptionGetNoteAttachmentResponse getNoteAttachment(GetNoteAttachment request) throws JIXBFileAttachmentException
request - JIXBFileAttachmentExceptionGetRelationshipsResponse getRelationships(GetRelationships request) throws JIXBQueryResultException
request - JIXBQueryResultExceptionvoid setSessionID(String sessionID)
String getSessionID()
String getUsername()
void setUsername(String username)
username - String getPassword()
void setPassword(String password)
password - Copyright © 2015 Europeana Foundation. All rights reserved.