程序包 ohos.aafwk.ability

类 DataAbilityOperation.Builder

java.lang.Object

ohos.aafwk.ability.DataAbilityOperation.Builder

封闭类:

DataAbilityOperation

public static class DataAbilityOperation.Builder
extends Object

Creates a DataAbilityOperation.

从以下版本开始:

1

SystemCapability

SystemCapability.Aafwk#ABILITY

方法概要

限定符和类型	方法	说明
DataAbilityOperation	build()	Creates a DataAbilityOperation object.
DataAbilityOperation.Builder	withExpectedCount(int count)	Sets the expected number of rows to update ,delete or assert query.
DataAbilityOperation.Builder	withInterruptionAllowed(boolean interrupted)	Sets an interrupt flag bit for a batch operation, which can be insert, update, delete, or assert.
DataAbilityOperation.Builder	withPredicates(DataAbilityPredicates predicates)	Sets filter criteria used for deleting updating or assert query data.
DataAbilityOperation.Builder	withPredicatesBackReference(int requestArgIndex, int previousResult)	Adds a back reference to be used as a filter criterion in withPredicates(ohos.data.dataability.DataAbilityPredicates).
DataAbilityOperation.Builder	withValueBackReferences(ValuesBucket backReferences)	Adds a back reference to be used in withValuesBucket(ohos.data.rdb.ValuesBucket).
DataAbilityOperation.Builder	withValuesBucket(ValuesBucket values)	Sets the data records to be inserted or updated.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

build

public DataAbilityOperation build()

Creates a DataAbilityOperation object.

返回:

Returns the DataAbilityOperation object.

抛出:

IllegalArgumentException - Throws this exception if mType or mValuesBucket is invalid.

从以下版本开始:

1

withValuesBucket

public DataAbilityOperation.Builder withValuesBucket(ValuesBucket values)

Sets the data records to be inserted or updated.

This method can be called only by the insert or update operation.

参数:

values - Indicates the data values to be set.

返回:

Returns a DataAbilityOperation.Builder object containing the given values parameter.

抛出:

IllegalArgumentException - Throws this exception if mType is invalid.

从以下版本开始:

1

withPredicates

public DataAbilityOperation.Builder withPredicates(DataAbilityPredicates predicates)

Sets filter criteria used for deleting updating or assert query data.

This method can be called only by the update or delete operation.

参数:

predicates - Indicates the filter criteria to set. If this parameter is null, all data records will be operated by default.

返回:

Returns an object containing the given filter criteria.

抛出:

IllegalArgumentException - Throws this exception if mType is invalid.

从以下版本开始:

1

withExpectedCount

public DataAbilityOperation.Builder withExpectedCount(int count)

Sets the expected number of rows to update ,delete or assert query.

This method can be called only by the update or delete operation.

参数:

count - Indicates the expected number of rows to update or delete.

返回:

Returns a DataAbilityOperation.Builder object containing the given count parameter.

抛出:

IllegalArgumentException - Throws this exception if mType is invalid.

从以下版本开始:

1

withPredicatesBackReference

public DataAbilityOperation.Builder withPredicatesBackReference(int requestArgIndex,
                                                                int previousResult)

Adds a back reference to be used as a filter criterion in withPredicates(ohos.data.dataability.DataAbilityPredicates). This method can be used only for update, delete, and assert operations.

This method will replace specific data in the predicate parameter array specified in withPredicates(ohos.data.dataability.DataAbilityPredicates) based on the values of requestArgIndex and previousResult in this method. The data will be replaced by a DataAbilityResult obtained after an operation created by DataAbilityOperation.Builder is complete.

参数:

requestArgIndex - Indicates the index referencing the predicate parameter whose value is to be replaced.

previousResult - Indicates the index referencing the historical DataAbilityResult used to replace the value of the specified predicate parameter.

返回:

Returns a DataAbilityOperation.Builder object containing the given requestArgIndex and previousResult parameters.

抛出:

IllegalArgumentException - Throws this exception if mType is invalid.

从以下版本开始:

3

withValueBackReferences

public DataAbilityOperation.Builder withValueBackReferences(ValuesBucket backReferences)

Adds a back reference to be used in withValuesBucket(ohos.data.rdb.ValuesBucket). This method can be used only for insert, update, and assert operations.

This method will replace specific values specified in withValuesBucket(ohos.data.rdb.ValuesBucket) using the specified DataAbilityResult obtained after an operation created by DataAbilityOperation.Builder is complete.

参数:

backReferences - Indicates the ValuesBucket object containing a set of key-value pairs. In each pair, the key specifies the value to be updated and the value specifies the index referencing the DataAbilityResult used to replace the specified value. This parameter cannot be null.

返回:

Returns a DataAbilityOperation.Builder object containing the given backReferences parameter.

抛出:

IllegalArgumentException - Throws this exception if mType is invalid.

从以下版本开始:

3

withInterruptionAllowed

public DataAbilityOperation.Builder withInterruptionAllowed(boolean interrupted)

Sets an interrupt flag bit for a batch operation, which can be insert, update, delete, or assert.

You can override the Ability#executeBatch(ArrayList) method in your Data ability class to check whether the interrupted flag bit allows operation interruption. If operation interruption is allowed, you can then call the RdbStore.giveConnectionTemporarily(long) method to release the connection to the database, thereby allowing other operations to access the database.

参数:

interrupted - Specifies whether a batch operation can be interrupted. The value true indicates that the operation can be interrupted, and false indicates the opposite.

返回:

Returns a DataAbilityOperation.Builder object containing the given interrupted parameter.

抛出:

IllegalArgumentException - Throws this exception if mType is invalid.

从以下版本开始:

4