Java API Cheatsheet

Java API Cheatsheet

From LongJump Support Wiki

Java API Cheatsheet
Jump to: navigation, search

These APIs are defined in the Functions class.

Contents

Record Handling

Syntax Description Return Category
addRecord(String objectName, Params params)Adds a new record of type objectId with values from params Result object Record Handling
updateRecord(String objectName, String recordId, Params params)Updates record of type objectId with values params. The Record is identified by recordId Result object Record Handling
changeOwnerShipInfo(String object_id, String record_id, String owner_id)Changes the owner of the designated record None Record Handling
deleteRecord(String objectName, String recordId)Deletes Record of type objectId where id is recordId Result object Record Handling
getRecord(String objectName, String fields, String recordId)Gets the record of type objectId identified by recordId. fields is a comma separated list of fields that you want to fetch Result object Record Handling
getRecordCount(String objectName, String criteria) Returns the number of records in the object int Record Handling
searchRecords(String objectName, String fields, String criteria [, Parameters params])Search and retrieve the records for an object. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression Result object Record Handling
searchRecords(String objectName, String fields, String criteria, String sortBy, String sortOrder, String sortBy2, String sortOrder2, int offset, int numberOfRows [, Parameters params])Search and retrieve records for an object. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression Result object Record Handling
execSQL(String query)Execute a SQL query Result object Record Handling
getRecord(String compositeObject, String fields, String recordId)Get a [{Composite Object]] record, with specified fields. Result object Composite Objects
getRecordCount(String compositeObject, String criteria) Gets a count of records in a Composite Object that match specified filtering criteria. int Composite Objects
searchRecords(String compositeObject, String fields, String criteria [, Parameters params])Search and retrieve Composite Object records. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression Result object Composite Objects
searchRecords(String compositeObject, String fields, String criteria, String sortBy, String sortOrder, String sortBy2, String sortOrder2, int offset, int numberOfRows [, Parameters params])Search and retrieve Composite Object records. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression Result object Composite Objects
processWorkflowAction(String workflowName,String currentStateName,String recordId,String customObjectName,String workflowAction,String workflowComments)Process Work flow Action Result object Workflow Record Handling


Email and Document Management

Syntax Description Return Category
sendEmail(String objectName, String id, String to, String cc, String subject, String body, String attachmentTemplateId, String attachmentIdList)Sends an Email Result object Email and Document Management
sendEmailUsingTemplate(String objectName, String recordId, String to, String cc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList)Sends an Email evaluating Template identified by bodyTemplateId as email body Result object Email and Document Management
generateDocument(String objectName, String recordId, String templateId, String format)Generates document of templateId evaluated with params in format. If format is "PDF" it generates the document in PDF format, otherwise HTML format. It relates this generated document to object of type objectId and record with id recordId Result object Email and Document Management
getDocument(String documentID) Retrieve a document by specifying its ID. Returns a Result object containing a PlatformFileBean that has the document contents.
getDocumentByTitle(String title) Get document by name, or all documents if an empty string is passed. Returns Result object containing an array of Parameters, each of which has a PlatformFileBean with the file contents.


Email Handler APIs

API Description
EmailHandler interface Specifies the processEmail method you define to handle incoming email messages. That method gets the incoming email in the form of an Email object (After creating the handler class, you specify it as the email handler in the External Email Tracking settings.)
Email class This object contains the incoming email. It has methods to get the subject line, lists of recipients, and get attachments.
Attachment class Attachments that come with an email are wrapped in an Attachment object. Before it can be used, the content of the attachment must be decoded using the Base64Codec class.
Base64Codec class An instance of this class is created and used to decode an incoming Attachment.
Learn more: HowTo:Handle Incoming Emails Programmatically


Event and Task Management

Syntax Description Return Category
addTask(String subject, Date dueDate, String ownerId [, Parameters params])Adds a task with values from params Result object Event and Task Management
updateTask(String taskId, Parameters params)Updates a task with values in params Result object Event and Task Management
deleteTask(String recordId)Deletes a task for the taskId Result object Event and Task Management
addEvent(String subject, String ownerID, Date startDate, int hour, int min, int duration [, Parameters params])Adds an event with values from params Result object Event and Task Management
updateEvent(String eventId, Parameters params)Updates an event with values in params Result object Event and Task Management
deleteEvent(String eventId)Deletes the event for the eventId Result object Event and Task Management
logActivity(String subject, String objectName, String id, String activityByID, Parameters params)Logs an activity Result object Event and Task Management


Transaction Management

Syntax Description Return Category
addSavePoint(String name)Adds a Save Point with name None Utility
doesSavePointExist(String name)checks whether the named save point exists or not Boolean Utility
getAllSavePoints()</tt>Returns All Save Points Set Utility
rollback()Roll backs all the inserts and updates None Utility
rollbackToSavePoint(String name)Rollback to specific save point with name None Utility
removeSavePoint(String name)removes save point with name from save point list None Utility


Utility

Syntax Description Return Category
Deprecated Use Logger class.
   (See Debug Log)
debug(Object obj)
Puts a debug statement into the debug log for Object obj. (obj can be a String) None Utility
getEnv(String key)Gets the environment variable value for the key The value of the environment variable Utility
getParametersInstance()Gets an instance of Parameters class Parameters object Utility
setTargetPage(String url)Sets the target page None Utility
showMessage(long millisecs)Displays message None Utility
sleep(String message)Sleeps for the designated number of milliseconds. None Utility
throwError(String message)Throws error with the message None Utility


ServiceConfiguration class (static methods):

Syntax Return Type Description
getServiceName(); String Returns the Service Name (e.g. company name)
getServiceDomainURL(); String Returns the Service URL.


Metadata Management

Syntax Description Return Category
getObjectMetaData(String objectName) Retrieve metadata from a Custom Objects. CustomObjectMetaDataBean Customize
getObjectMetaDataMap() Return a map of all visible Custom Object object metadata records, indexed by object ID. Map: Object ID => CustomObjectMetaDataBean Customize
addObjectMetaData(CustomObjectMetaDataBean) Create a new object. String:Object ID Customize
updateObjectMetaData(CustomObjectMetaDataBean) Modify an object definition. String: Object ID Customize
deleteObjectMetaData(CustomObjectMetaDataBean) Deletes an object None Customize
getRecordLocator(String objectName) Get an object's Record Locator information. RecordLocatorBean Customize
updateRecordLocator(RecordLocatorBean) Modify an object's Record Locator Settings. String:Object ID Customize
Personal tools