com.sforce.soap.partner
Interface Soap

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

SoapBindingStub

public interface Soap
extends java.rmi.Remote

Method Summary

LeadConvertResult[]	convertLead(LeadConvert[] leadConverts) convert a set of leads
SaveResult[]	create(SObject[] sObjects) Create a set of new sObjects
DeleteResult[]	delete(java.lang.String[] ids) Delete a set of sObjects
DescribeGlobalResult	describeGlobal() Describe the Global state
DescribeLayoutResult	describeLayout(java.lang.String sObjectType, java.lang.String[] recordTypeIds) Describe the layout of an sObject
DescribeSObjectResult	describeSObject(java.lang.String sObjectType) Describe an sObject
DescribeSObjectResult[]	describeSObjects(java.lang.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(java.lang.String[] ids) Empty a set of sObjects from the recycle bin
GetDeletedResult	getDeleted(java.lang.String sObjectType, java.util.Calendar startDate, java.util.Calendar endDate) Get the IDs for deleted sObjects
GetServerTimestampResult	getServerTimestamp() Gets server timestamp
GetUpdatedResult	getUpdated(java.lang.String sObjectType, java.util.Calendar startDate, java.util.Calendar endDate) Get the IDs for updated sObjects
GetUserInfoResult	getUserInfo() Returns standard information relevant to the current user
InvalidateSessionsResult[]	invalidateSessions(java.lang.String[] sessionIds) Logs out and invalidates session ids
LoginResult	login(java.lang.String username, java.lang.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(java.lang.String queryString) Create a Query Cursor
QueryResult	queryAll(java.lang.String queryString) Create a Query Cursor, including deleted sObjects
QueryResult	queryMore(java.lang.String queryLocator) Gets the next batch of sObjects from a query
ResetPasswordResult	resetPassword(java.lang.String userId) Reset a user's password
SObject[]	retrieve(java.lang.String fieldList, java.lang.String sObjectType, java.lang.String[] ids) Get a set of sObjects
SearchResult	search(java.lang.String searchString) Search for sObjects
SendEmailResult[]	sendEmail(Email[] messages) Send outbound email
SetPasswordResult	setPassword(java.lang.String userId, java.lang.String password) Set a user's password
UndeleteResult[]	undelete(java.lang.String[] ids) Undelete a set of sObjects
SaveResult[]	update(SObject[] sObjects) Update a set of sObjects
UpsertResult[]	upsert(java.lang.String externalIDFieldName, SObject[] sObjects) Update or insert a set of sObjects based on object id

Method Detail

login

LoginResult login(java.lang.String username,
                  java.lang.String password)
                  throws java.rmi.RemoteException,
                         UnexpectedErrorFault,
                         InvalidIdFault,
                         LoginFault

Login to the Salesforce.com SOAP Api

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidIdFault

LoginFault

describeSObject

DescribeSObjectResult describeSObject(java.lang.String sObjectType)
                                      throws java.rmi.RemoteException,
                                             UnexpectedErrorFault,
                                             InvalidSObjectFault

Describe an sObject

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

describeSObjects

DescribeSObjectResult[] describeSObjects(java.lang.String[] sObjectType)
                                         throws java.rmi.RemoteException,
                                                UnexpectedErrorFault,
                                                InvalidSObjectFault

Describe a number sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

describeGlobal

DescribeGlobalResult describeGlobal()
                                    throws java.rmi.RemoteException,
                                           UnexpectedErrorFault

Describe the Global state

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

describeLayout

DescribeLayoutResult describeLayout(java.lang.String sObjectType,
                                    java.lang.String[] recordTypeIds)
                                    throws java.rmi.RemoteException,
                                           UnexpectedErrorFault,
                                           InvalidSObjectFault,
                                           InvalidIdFault

Describe the layout of an sObject

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

describeSoftphoneLayout

DescribeSoftphoneLayoutResult describeSoftphoneLayout()
                                                      throws java.rmi.RemoteException,
                                                             UnexpectedErrorFault

Describe the layout of the SoftPhone

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

describeTabs

DescribeTabSetResult[] describeTabs()
                                    throws java.rmi.RemoteException,
                                           UnexpectedErrorFault

Describe the tabs that appear on a users page

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

create

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

Create a set of new sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

InvalidFieldFault

update

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

Update a set of sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

InvalidFieldFault

upsert

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

Update or insert a set of sObjects based on object id

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

InvalidFieldFault

merge

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

Merge and update a set of sObjects based on object id

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

InvalidFieldFault

delete

DeleteResult[] delete(java.lang.String[] ids)
                      throws java.rmi.RemoteException,
                             UnexpectedErrorFault

Delete a set of sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

undelete

UndeleteResult[] undelete(java.lang.String[] ids)
                          throws java.rmi.RemoteException,
                                 UnexpectedErrorFault

Undelete a set of sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

emptyRecycleBin

EmptyRecycleBinResult[] emptyRecycleBin(java.lang.String[] ids)
                                        throws java.rmi.RemoteException,
                                               UnexpectedErrorFault

Empty a set of sObjects from the recycle bin

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

retrieve

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

Get a set of sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

MalformedQueryFault

InvalidFieldFault

process

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

Submit an entity to a workflow process or process a workitem

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidIdFault

convertLead

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

convert a set of leads

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

logout

void logout()
            throws java.rmi.RemoteException,
                   UnexpectedErrorFault

Logout the current user, invalidating the current session.

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

invalidateSessions

InvalidateSessionsResult[] invalidateSessions(java.lang.String[] sessionIds)
                                              throws java.rmi.RemoteException,
                                                     UnexpectedErrorFault

Logs out and invalidates session ids

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

getDeleted

GetDeletedResult getDeleted(java.lang.String sObjectType,
                            java.util.Calendar startDate,
                            java.util.Calendar endDate)
                            throws java.rmi.RemoteException,
                                   UnexpectedErrorFault,
                                   InvalidSObjectFault

Get the IDs for deleted sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

getUpdated

GetUpdatedResult getUpdated(java.lang.String sObjectType,
                            java.util.Calendar startDate,
                            java.util.Calendar endDate)
                            throws java.rmi.RemoteException,
                                   UnexpectedErrorFault,
                                   InvalidSObjectFault

Get the IDs for updated sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

query

QueryResult query(java.lang.String queryString)
                  throws java.rmi.RemoteException,
                         UnexpectedErrorFault,
                         InvalidSObjectFault,
                         InvalidIdFault,
                         InvalidQueryLocatorFault,
                         MalformedQueryFault,
                         InvalidFieldFault

Create a Query Cursor

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

InvalidQueryLocatorFault

MalformedQueryFault

InvalidFieldFault

queryAll

QueryResult queryAll(java.lang.String queryString)
                     throws java.rmi.RemoteException,
                            UnexpectedErrorFault,
                            InvalidSObjectFault,
                            InvalidIdFault,
                            InvalidQueryLocatorFault,
                            MalformedQueryFault,
                            InvalidFieldFault

Create a Query Cursor, including deleted sObjects

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidSObjectFault

InvalidIdFault

InvalidQueryLocatorFault

MalformedQueryFault

InvalidFieldFault

queryMore

QueryResult queryMore(java.lang.String queryLocator)
                      throws java.rmi.RemoteException,
                             UnexpectedErrorFault,
                             InvalidQueryLocatorFault,
                             InvalidFieldFault

Gets the next batch of sObjects from a query

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidQueryLocatorFault

InvalidFieldFault

search

SearchResult search(java.lang.String searchString)
                    throws java.rmi.RemoteException,
                           MalformedSearchFault,
                           UnexpectedErrorFault,
                           InvalidSObjectFault,
                           InvalidFieldFault

Search for sObjects

Throws:

java.rmi.RemoteException

MalformedSearchFault

UnexpectedErrorFault

InvalidSObjectFault

InvalidFieldFault

getServerTimestamp

GetServerTimestampResult getServerTimestamp()
                                            throws java.rmi.RemoteException,
                                                   UnexpectedErrorFault

Gets server timestamp

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

setPassword

SetPasswordResult setPassword(java.lang.String userId,
                              java.lang.String password)
                              throws java.rmi.RemoteException,
                                     UnexpectedErrorFault,
                                     InvalidIdFault,
                                     InvalidNewPasswordFault

Set a user's password

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidIdFault

InvalidNewPasswordFault

resetPassword

ResetPasswordResult resetPassword(java.lang.String userId)
                                  throws java.rmi.RemoteException,
                                         UnexpectedErrorFault,
                                         InvalidIdFault

Reset a user's password

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

InvalidIdFault

getUserInfo

GetUserInfoResult getUserInfo()
                              throws java.rmi.RemoteException,
                                     UnexpectedErrorFault

Returns standard information relevant to the current user

Throws:

java.rmi.RemoteException

UnexpectedErrorFault

sendEmail

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

Send outbound email

Throws:

java.rmi.RemoteException

UnexpectedErrorFault