Soap (gooddata-cl 1.2.73 API)

All Superinterfaces:

Remote

All Known Implementing Classes:

SoapBindingStub
```
public interface Soap
extends Remote
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`LeadConvertResult[]`	`convertLead(LeadConvert[] leadConverts)` convert a set of leads
`SaveResult[]`	`create(SObject[] sObjects)` Create a set of new sObjects
`DeleteResult[]`	`delete(String[] ids)` Delete a set of sObjects
`DescribeDataCategoryGroupResult[]`	`describeDataCategoryGroups(String[] sObjectType)` Describe all the data category groups available for a given set of types
`DescribeDataCategoryGroupStructureResult[]`	`describeDataCategoryGroupStructures(DataCategoryGroupSobjectTypePair[] pairs, boolean topCategoriesOnly)` Describe the data category group structures for a given set of pair of types and data category group name
`DescribeGlobalResult`	`describeGlobal()` Describe the Global state
`DescribeLayoutResult`	`describeLayout(String sObjectType, String[] recordTypeIds)` Describe the layout of an sObject
`DescribeSObjectResult`	`describeSObject(String sObjectType)` Describe an sObject
`DescribeSObjectResult[]`	`describeSObjects(String[] sObjectType)` Describe a number sObjects
`DescribeSoftphoneLayoutResult`	`describeSoftphoneLayout()` Describe the layout of the SoftPhone
`DescribeTabSetResult[]`	`describeTabs()` Describe the tabs that appear on a users page
`EmptyRecycleBinResult[]`	`emptyRecycleBin(String[] ids)` Empty a set of sObjects from the recycle bin
`GetDeletedResult`	`getDeleted(String sObjectType, Calendar startDate, Calendar endDate)` Get the IDs for deleted sObjects
`GetServerTimestampResult`	`getServerTimestamp()` Gets server timestamp
`GetUpdatedResult`	`getUpdated(String sObjectType, Calendar startDate, Calendar endDate)` Get the IDs for updated sObjects
`GetUserInfoResult`	`getUserInfo()` Returns standard information relevant to the current user
`InvalidateSessionsResult[]`	`invalidateSessions(String[] sessionIds)` Logs out and invalidates session ids
`LoginResult`	`login(String username, String password)` Login to the Salesforce.com SOAP Api
`void`	`logout()` Logout the current user, invalidating the current session.
`MergeResult[]`	`merge(MergeRequest[] request)` Merge and update a set of sObjects based on object id
`ProcessResult[]`	`process(ProcessRequest[] actions)` Submit an entity to a workflow process or process a workitem
`QueryResult`	`query(String queryString)` Create a Query Cursor
`QueryResult`	`queryAll(String queryString)` Create a Query Cursor, including deleted sObjects
`QueryResult`	`queryMore(String queryLocator)` Gets the next batch of sObjects from a query
`ResetPasswordResult`	`resetPassword(String userId)` Reset a user's password
`SObject[]`	`retrieve(String fieldList, String sObjectType, String[] ids)` Get a set of sObjects
`SearchResult`	`search(String searchString)` Search for sObjects
`SendEmailResult[]`	`sendEmail(Email[] messages)` Send outbound email
`SetPasswordResult`	`setPassword(String userId, String password)` Set a user's password
`UndeleteResult[]`	`undelete(String[] ids)` Undelete a set of sObjects
`SaveResult[]`	`update(SObject[] sObjects)` Update a set of sObjects
`UpsertResult[]`	`upsert(String externalIDFieldName, SObject[] sObjects)` Update or insert a set of sObjects based on object id

Method Detail

login

LoginResult login(String username,
                  String password)
           throws RemoteException,
                  InvalidIdFault,
                  UnexpectedErrorFault,
                  LoginFault

Throws:: RemoteException; InvalidIdFault; UnexpectedErrorFault; LoginFault

describeSObject

DescribeSObjectResult describeSObject(String sObjectType)
                               throws RemoteException,
                                      InvalidSObjectFault,
                                      UnexpectedErrorFault

Describe an sObject

Throws:: RemoteException; InvalidSObjectFault; UnexpectedErrorFault

describeSObjects

DescribeSObjectResult[] describeSObjects(String[] sObjectType)
                                  throws RemoteException,
                                         InvalidSObjectFault,
                                         UnexpectedErrorFault

Describe a number sObjects

Throws:: RemoteException; InvalidSObjectFault; UnexpectedErrorFault

describeGlobal

DescribeGlobalResult describeGlobal()
                             throws RemoteException,
                                    UnexpectedErrorFault

Describe the Global state

Throws:: RemoteException; UnexpectedErrorFault

describeDataCategoryGroups

DescribeDataCategoryGroupResult[] describeDataCategoryGroups(String[] sObjectType)
                                                      throws RemoteException,
                                                             InvalidSObjectFault,
                                                             UnexpectedErrorFault

Describe all the data category groups available for a given set of types

Throws:: RemoteException; InvalidSObjectFault; UnexpectedErrorFault

describeDataCategoryGroupStructures

DescribeDataCategoryGroupStructureResult[] describeDataCategoryGroupStructures(DataCategoryGroupSobjectTypePair[] pairs,
                                                                               boolean topCategoriesOnly)
                                                                        throws RemoteException,
                                                                               InvalidSObjectFault,
                                                                               UnexpectedErrorFault

Describe the data category group structures for a given set of pair of types and data category group name

Throws:: RemoteException; InvalidSObjectFault; UnexpectedErrorFault

describeLayout

DescribeLayoutResult describeLayout(String sObjectType,
                                    String[] recordTypeIds)
                             throws RemoteException,
                                    InvalidSObjectFault,
                                    InvalidIdFault,
                                    UnexpectedErrorFault

Describe the layout of an sObject

Throws:: RemoteException; InvalidSObjectFault; InvalidIdFault; UnexpectedErrorFault

describeSoftphoneLayout

DescribeSoftphoneLayoutResult describeSoftphoneLayout()
                                               throws RemoteException,
                                                      UnexpectedErrorFault

Describe the layout of the SoftPhone

Throws:: RemoteException; UnexpectedErrorFault

describeTabs

DescribeTabSetResult[] describeTabs()
                             throws RemoteException,
                                    UnexpectedErrorFault

Describe the tabs that appear on a users page

Throws:: RemoteException; UnexpectedErrorFault

create

SaveResult[] create(SObject[] sObjects)
             throws RemoteException,
                    InvalidSObjectFault,
                    InvalidIdFault,
                    InvalidFieldFault,
                    UnexpectedErrorFault

Create a set of new sObjects

Throws:: RemoteException; InvalidSObjectFault; InvalidIdFault; InvalidFieldFault; UnexpectedErrorFault

update

SaveResult[] update(SObject[] sObjects)
             throws RemoteException,
                    InvalidSObjectFault,
                    InvalidIdFault,
                    InvalidFieldFault,
                    UnexpectedErrorFault

Update a set of sObjects

Throws:: RemoteException; InvalidSObjectFault; InvalidIdFault; InvalidFieldFault; UnexpectedErrorFault

upsert

UpsertResult[] upsert(String externalIDFieldName,
                      SObject[] sObjects)
               throws RemoteException,
                      InvalidSObjectFault,
                      InvalidIdFault,
                      InvalidFieldFault,
                      UnexpectedErrorFault

Update or insert a set of sObjects based on object id

Throws:: RemoteException; InvalidSObjectFault; InvalidIdFault; InvalidFieldFault; UnexpectedErrorFault

merge

MergeResult[] merge(MergeRequest[] request)
             throws RemoteException,
                    InvalidSObjectFault,
                    InvalidIdFault,
                    InvalidFieldFault,
                    UnexpectedErrorFault

Merge and update a set of sObjects based on object id

Throws:: RemoteException; InvalidSObjectFault; InvalidIdFault; InvalidFieldFault; UnexpectedErrorFault

delete

DeleteResult[] delete(String[] ids)
               throws RemoteException,
                      UnexpectedErrorFault

Delete a set of sObjects

Throws:: RemoteException; UnexpectedErrorFault

undelete

UndeleteResult[] undelete(String[] ids)
                   throws RemoteException,
                          UnexpectedErrorFault

Undelete a set of sObjects

Throws:: RemoteException; UnexpectedErrorFault

emptyRecycleBin

EmptyRecycleBinResult[] emptyRecycleBin(String[] ids)
                                 throws RemoteException,
                                        UnexpectedErrorFault

Empty a set of sObjects from the recycle bin

Throws:: RemoteException; UnexpectedErrorFault

retrieve

SObject[] retrieve(String fieldList,
                   String sObjectType,
                   String[] ids)
            throws RemoteException,
                   InvalidSObjectFault,
                   MalformedQueryFault,
                   InvalidIdFault,
                   InvalidFieldFault,
                   UnexpectedErrorFault

Get a set of sObjects

Throws:: RemoteException; InvalidSObjectFault; MalformedQueryFault; InvalidIdFault; InvalidFieldFault; UnexpectedErrorFault

process

ProcessResult[] process(ProcessRequest[] actions)
                 throws RemoteException,
                        InvalidIdFault,
                        UnexpectedErrorFault

Submit an entity to a workflow process or process a workitem

Throws:: RemoteException; InvalidIdFault; UnexpectedErrorFault

convertLead

LeadConvertResult[] convertLead(LeadConvert[] leadConverts)
                         throws RemoteException,
                                UnexpectedErrorFault

convert a set of leads

Throws:: RemoteException; UnexpectedErrorFault

logout
```
void logout()
     throws RemoteException,
            UnexpectedErrorFault
```
Logout the current user, invalidating the current session.

Throws:

RemoteException

UnexpectedErrorFault

invalidateSessions

InvalidateSessionsResult[] invalidateSessions(String[] sessionIds)
                                       throws RemoteException,
                                              UnexpectedErrorFault

Logs out and invalidates session ids

Throws:: RemoteException; UnexpectedErrorFault

getDeleted

GetDeletedResult getDeleted(String sObjectType,
                            Calendar startDate,
                            Calendar endDate)
                     throws RemoteException,
                            InvalidSObjectFault,
                            UnexpectedErrorFault

Get the IDs for deleted sObjects

Throws:: RemoteException; InvalidSObjectFault; UnexpectedErrorFault

getUpdated

GetUpdatedResult getUpdated(String sObjectType,
                            Calendar startDate,
                            Calendar endDate)
                     throws RemoteException,
                            InvalidSObjectFault,
                            UnexpectedErrorFault

Get the IDs for updated sObjects

Throws:: RemoteException; InvalidSObjectFault; UnexpectedErrorFault

query

QueryResult query(String queryString)
           throws RemoteException,
                  InvalidSObjectFault,
                  MalformedQueryFault,
                  InvalidIdFault,
                  InvalidFieldFault,
                  UnexpectedErrorFault,
                  InvalidQueryLocatorFault

Create a Query Cursor

Throws:: RemoteException; InvalidSObjectFault; MalformedQueryFault; InvalidIdFault; InvalidFieldFault; UnexpectedErrorFault; InvalidQueryLocatorFault

queryAll

QueryResult queryAll(String queryString)
              throws RemoteException,
                     InvalidSObjectFault,
                     MalformedQueryFault,
                     InvalidIdFault,
                     InvalidFieldFault,
                     UnexpectedErrorFault,
                     InvalidQueryLocatorFault

Create a Query Cursor, including deleted sObjects

Throws:: RemoteException; InvalidSObjectFault; MalformedQueryFault; InvalidIdFault; InvalidFieldFault; UnexpectedErrorFault; InvalidQueryLocatorFault

queryMore

QueryResult queryMore(String queryLocator)
               throws RemoteException,
                      InvalidFieldFault,
                      UnexpectedErrorFault,
                      InvalidQueryLocatorFault

Gets the next batch of sObjects from a query

Throws:: RemoteException; InvalidFieldFault; UnexpectedErrorFault; InvalidQueryLocatorFault

search

SearchResult search(String searchString)
             throws RemoteException,
                    InvalidSObjectFault,
                    MalformedSearchFault,
                    InvalidFieldFault,
                    UnexpectedErrorFault

Search for sObjects

Throws:: RemoteException; InvalidSObjectFault; MalformedSearchFault; InvalidFieldFault; UnexpectedErrorFault

getServerTimestamp

GetServerTimestampResult getServerTimestamp()
                                     throws RemoteException,
                                            UnexpectedErrorFault

Gets server timestamp

Throws:: RemoteException; UnexpectedErrorFault

setPassword

SetPasswordResult setPassword(String userId,
                              String password)
                       throws RemoteException,
                              InvalidIdFault,
                              UnexpectedErrorFault,
                              InvalidNewPasswordFault

Set a user's password

Throws:: RemoteException; InvalidIdFault; UnexpectedErrorFault; InvalidNewPasswordFault

resetPassword

ResetPasswordResult resetPassword(String userId)
                           throws RemoteException,
                                  InvalidIdFault,
                                  UnexpectedErrorFault

Reset a user's password

Throws:: RemoteException; InvalidIdFault; UnexpectedErrorFault

getUserInfo

GetUserInfoResult getUserInfo()
                       throws RemoteException,
                              UnexpectedErrorFault

Returns standard information relevant to the current user

Throws:: RemoteException; UnexpectedErrorFault

sendEmail

SendEmailResult[] sendEmail(Email[] messages)
                     throws RemoteException,
                            UnexpectedErrorFault

Send outbound email

Throws:: RemoteException; UnexpectedErrorFault

Interface Soap