|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
com.sforce.soap.enterprise.SaveResult[] |
create(com.sforce.soap.enterprise.sobject.SObject[] sObjects)
Create one or more sforce objects See the Online API reference for usage |
com.sforce.soap.enterprise.CreateResponseDocument |
createDoc(com.sforce.soap.enterprise.CreateDocument requestDoc)
A variant of the create method that uses document-type XMLBean objects for the input and return. |
com.sforce.soap.enterprise.SaveResult |
createOne(com.sforce.soap.enterprise.sobject.SObject sObject)
A simplified variant of the create method for a single object instead of an array of objects. |
com.sforce.soap.enterprise.DeleteResult[] |
delete(java.lang.String[] ids)
Deletes one or more sforce objects See the Online API reference for usage |
com.sforce.soap.enterprise.DeleteResponseDocument |
deleteDoc(com.sforce.soap.enterprise.DeleteDocument requestDoc)
A variant of the delete method that uses document-type XMLBean objects for the input and return. |
com.sforce.soap.enterprise.DeleteResult |
deleteOne(java.lang.String id)
A simplified variant of the delete method for a single object instead of an array of objects. |
com.sforce.soap.enterprise.DescribeGlobalResult |
describeGlobal()
Use describeGlobal to obtain the list of available objects for your organization. |
com.sforce.soap.enterprise.DescribeSObjectResult |
describeSObject(java.lang.String sObjectType)
Describes metadata (field list and object properties) for the specified object. |
com.sforce.soap.enterprise.GetDeletedResult |
getDeleted(java.lang.String sObjectType,
java.util.Calendar startDate,
java.util.Calendar endDate)
Retrieves the list of individual objects that have been deleted within the given timespan for the specified object |
java.util.Calendar |
getServerTimestamp()
Retrieves the current system timestamp (GMT) from the sforce Web service. |
com.sforce.soap.enterprise.GetUpdatedResult |
getUpdated(java.lang.String sObjectType,
java.util.Calendar startDate,
java.util.Calendar endDate)
Retrieves the list of individual objects that have been updated within the given timespan for the specified object |
com.sforce.soap.enterprise.GetUserInfoResult |
getUserInfo()
Retrieves personal information for the user associated with the current session. |
com.sforce.soap.enterprise.LoginResult |
login(java.lang.String username,
java.lang.String password)
Start a session with the sforce web service. |
com.sforce.soap.enterprise.QueryResult |
query(java.lang.String queryString)
Query for sforce objects based on a query string similar to a SQL SELECT statement. |
com.sforce.soap.enterprise.QueryResult |
queryMore(java.lang.String queryLocator)
Query for more results based on a previous call to query() that returned more than the current batch size (default 2000). |
java.lang.String |
resetPassword(java.lang.String userId)
Use resetPassword to request that the sforce Web service change a user's password and return the server-generated password string. |
void |
resetQueryOptionsToDefault()
Resets query options to the @jc:sforce-properties query-batch-size value, if one is specified, or reset to the system default (2000) if the query-batch-size is not specified. |
void |
resetSaveOptionsToDefault()
Resets save options to the @jc:sforce-properties save-auto-assign and save-assign-rule-id values if specified, or reset to the system defaults if values are not specified on the control. |
com.sforce.soap.enterprise.sobject.SObject |
retrieve(java.lang.String fieldList,
java.lang.String sObjectType,
java.lang.String id)
Use the retrieve call to retrieve individual sforce objects when you knowo their ID. |
com.sforce.soap.enterprise.RetrieveResponseDocument |
retrieveDoc(com.sforce.soap.enterprise.RetrieveDocument requestDoc)
A variant of the retrieve method that uses document-type XMLBean objects for the input and return. |
com.sforce.soap.enterprise.SearchResult |
search(java.lang.String searchString)
Search among sforce objects based on a search string, similar to internet search syntax. |
com.sforce.soap.enterprise.SetPasswordResult |
setPassword(java.lang.String userId,
java.lang.String password)
Use setPassword to change a user's password to a value that you specify. |
void |
setQueryOptions(int batchSize)
Set the query-batch-size value programmatically, overriding the value of the corresponding @jc:sforce-properties (if any) or the system defaults. |
void |
setSaveOptions(java.lang.String assignmentRuleId,
boolean autoAssign)
Set the save options programatically, overriding the value of the corresponding @jc:sforce-properties (if any) or the system defaults. |
com.sforce.soap.enterprise.SaveResult[] |
update(com.sforce.soap.enterprise.sobject.SObject[] sObjects)
Update one or more sforce objects See the Online API reference for usage |
com.sforce.soap.enterprise.UpdateResponseDocument |
updateDoc(com.sforce.soap.enterprise.UpdateDocument requestDoc)
A variant of the update method that takes a document-type object, used in Java Process Flows |
com.sforce.soap.enterprise.SaveResult |
updateOne(com.sforce.soap.enterprise.sobject.SObject sObject)
A simplified variant of the update method for a single object instead of an array of objects. |
Method Detail |
public com.sforce.soap.enterprise.LoginResult login(java.lang.String username, java.lang.String password)
username
- An sforce user name (email format)password
- The corresponding sforce password
public com.sforce.soap.enterprise.QueryResult query(java.lang.String queryString)
queryString
- A string specifying SELECT public com.sforce.soap.enterprise.QueryResult queryMore(java.lang.String queryLocator)
queryLocator
- The identifier returned by the query() method if number of objects that
qualify exceeds the batch size
public com.sforce.soap.enterprise.SearchResult search(java.lang.String searchString)
searchString
-
public com.sforce.soap.enterprise.sobject.SObject retrieve(java.lang.String fieldList, java.lang.String sObjectType, java.lang.String id)
fieldList
- Field to retrievesObjectType
- The sforce objectid
- The ID to retireve
public com.sforce.soap.enterprise.RetrieveResponseDocument retrieveDoc(com.sforce.soap.enterprise.RetrieveDocument requestDoc)
requestDoc
- A document-type XMLBean containing the parameters to the retrieve method.
public com.sforce.soap.enterprise.SaveResult[] create(com.sforce.soap.enterprise.sobject.SObject[] sObjects)
sObjects
- An array of any type of sforce objects (objects in package com.sforce.soap.sobject)
public com.sforce.soap.enterprise.CreateResponseDocument createDoc(com.sforce.soap.enterprise.CreateDocument requestDoc)
requestDoc
- A document-type XMLBean containing the array of sObjects to create.
public com.sforce.soap.enterprise.SaveResult createOne(com.sforce.soap.enterprise.sobject.SObject sObject)
sObject
- A single instance of an sforce object. Can be any subclass of sObject.
public com.sforce.soap.enterprise.DeleteResult[] delete(java.lang.String[] ids)
public com.sforce.soap.enterprise.DeleteResponseDocument deleteDoc(com.sforce.soap.enterprise.DeleteDocument requestDoc)
requestDoc
- A document-type XMLBean containing the array of sObjects to delete.
public com.sforce.soap.enterprise.DeleteResult deleteOne(java.lang.String id)
public com.sforce.soap.enterprise.GetDeletedResult getDeleted(java.lang.String sObjectType, java.util.Calendar startDate, java.util.Calendar endDate)
sObjectType
- sforce object typestartDate
- Date where to startendDate
- Date where to end
public com.sforce.soap.enterprise.SaveResult[] update(com.sforce.soap.enterprise.sobject.SObject[] sObjects)
sObjects
- An array of any type of sforce objects (objects in package com.sforce.soap.sobject)
public com.sforce.soap.enterprise.UpdateResponseDocument updateDoc(com.sforce.soap.enterprise.UpdateDocument requestDoc)
requestDoc
- The document-type XMLBean containing the array of sObjects to update
public com.sforce.soap.enterprise.SaveResult updateOne(com.sforce.soap.enterprise.sobject.SObject sObject)
sObject
- A single instance of an sforce object. Can be any subclass of sObject.
public com.sforce.soap.enterprise.GetUpdatedResult getUpdated(java.lang.String sObjectType, java.util.Calendar startDate, java.util.Calendar endDate)
sObjectType
- sforce object typestartDate
- Date where to startendDate
- Date where to end
public com.sforce.soap.enterprise.DescribeGlobalResult describeGlobal()
public com.sforce.soap.enterprise.DescribeSObjectResult describeSObject(java.lang.String sObjectType)
sObjectType
- Typwe of the sforce object
public java.util.Calendar getServerTimestamp()
public com.sforce.soap.enterprise.GetUserInfoResult getUserInfo()
public java.lang.String resetPassword(java.lang.String userId)
userId
- the id of the logged user
public com.sforce.soap.enterprise.SetPasswordResult setPassword(java.lang.String userId, java.lang.String password)
userId
- the id of the user
public void setQueryOptions(int batchSize)
batchSize
- The new batch size value, setting the maximum number of objects to return
in one call to query() or queryMore()public void setSaveOptions(java.lang.String assignmentRuleId, boolean autoAssign)
assignmentRuleId
- The new assignment rule IdautoAssign
- The new autoAssign parameter. By default is truepublic void resetQueryOptionsToDefault()
public void resetSaveOptionsToDefault()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |