An API object representing a single data operation.
This object is useful for both roles, ABCS Business User and ABCS Developer.
- ABCS Developer needs to produce Operation instances to make his custom custom Business Object Provider (BOP) useful.
- ABCS Business User consumes these Operation instances and performs the operation using Operation.perform(..) method.
- Version:
- 17.1.1
- Source:
- See:
-
- Operations to understand how to get certain registered operation and perform it.
- Operations.read(..)
- Operations.create(..)
- Operations.update(..)
- Operations.delete(..)
Returns:
- Type
- Operation
Members
Methods
perform() → {Promise.<operation/js/api/OperationResult>}
stable API
Performs this operation.
Each Operation.perform(..) method call returns an instance of OperationResult. It either:
-
Provides returned data in case Operation perform correctly.
It also can contain any other metadata which Business Object Provider decides to return. For example PaginationCursor can be available if the perfomed Operation has type Operation.Type.READ_MANY set and provider implemented capability to paginate through the resulted records. - Provides error code, message and possibly any other additional error information in case Operation performed incorrectly.
- OperationResult.isSuccess() to check if the call was performed correctly and resulted in a OperationResult.Success.
- OperationResult.isFailure() to check if the call was performed incorrectly and resulted in an OperationResult.Failure.
- Version:
- 15.4.5
- Source:
- See:
Returns:
- Promise of the OperationResult for this operation.
- Type
- Promise.<operation/js/api/OperationResult>