Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
LockResult Class
ProcessRequest Class
ProcessResult Class
ProcessSubmitRequest Class
ProcessWorkitemRequest Class
UnlockResult Class
UnlockResult Methods
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

UnlockResult Class

The result of a record unlock, returned by a System.Approval.unlock() method.

Namespace

Approval

Usage

The System.Approval.unlock() methods return Approval.UnlockResult objects. Each element in an UnlockResult array corresponds to an element in the ID or sObject array passed as a parameter to an unlock method. The first element in the UnlockResult array corresponds to the first element in the ID or sObject array, the second element corresponds to the second element, and so on. If only one ID or sObject is passed in, the UnlockResult array contains a single element.

Example

The following example shows how to obtain and iterate through the returned Approval.UnlockResult objects. It locks some queried accounts using Approval.unlock with a false second parameter to allow partial processing of records on failure. Next, it iterates through the results to determine whether the operation was successful for each record. It writes the ID of every record that was processed successfully to the debug log, or writes error messages and failed fields of the failed records.

UnlockResult Methods

The following are methods for UnlockResult.

getErrors()

If an error occurred, returns an array of one or more database error objects, providing the error code and description.

Signature

public List<Database.Error> getErrors()

Return Value

Type: List<Database.Error>

getId()

Returns the ID of the sObject you are trying to unlock.

Signature

public Id getId()

Return Value

Type: Id

Usage

If the field contains a value, the object was unlocked. If the field is empty, the operation was not successfult.

isSuccess()

A Boolean value that is set to true if the unlock operation is successful for this object, or false otherwise.

Signature

public Boolean isSuccess()

Return Value

Type: Boolean