程序包 ohos.sysappcomponents.calendar

类 CalendarDataHelper

java.lang.Object

ohos.sysappcomponents.calendar.CalendarDataHelper

public class CalendarDataHelper
extends Object

Provides utilities for creating, adding, querying, modifying, and deleting calendar data.

从以下版本开始:

3

嵌套类概要

嵌套类

限定符和类型	类	说明
class	CalendarDataHelper.InstancesDataHelper	Provides utilities for operating calendar instance data in a certain period of time.

方法概要

限定符和类型	方法	说明
static CalendarDataHelper	creator(Context context, Class<? extends CalendarEntity> entityClass)	A constructor used to create a CalendarDataHelper object.
boolean	delete(int id)	Deletes the calendar record of a specified ID.
int	delete(DataAbilityPredicates predicates)	Deletes calendar data based on predicates.
boolean	delete(CalendarEntity entity)	Deletes specified calendar data.
CalendarDataHelper.InstancesDataHelper	getInstanceDataHelper()	Creates an InstancesDataHelper object.
boolean	insert(ValuesBucket valuesBucket)	Inserts a calendar record into the database.
CalendarCollection	query(int id, String[] columns)	Queries calendar data in the database based on ID and columns.
CalendarCollection	query(DataAbilityPredicates predicates, String[] columns)	Queries calendar data in the database based on predicates and columns.
boolean	release()	Releases data client resources when the database operation is complete.
boolean	update(ValuesBucket valuesBucket, DataAbilityPredicates predicates)	Updates a calendar record in the database.

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

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

方法详细资料

creator

public static CalendarDataHelper creator(Context context,
                                         Class<? extends CalendarEntity> entityClass)
                                  throws InvalidParameterException

A constructor used to create a CalendarDataHelper object.

参数:

context - Indicates the context.

entityClass - Indicates the CalendarEntity object or its child object.

返回:

Returns the CalendarDataHelper object.

抛出:

InvalidParameterException - Throws this exception if the input parameter entityClass is invalid.

从以下版本开始:

3

query

public CalendarCollection query(DataAbilityPredicates predicates,
                                String[] columns)
                         throws DataAbilityRemoteException

Queries calendar data in the database based on predicates and columns.

参数:

predicates - Indicates the conditions for querying the database.

columns - Indicates the fields to obtain.

返回:

Returns the calendar data.

抛出:

DataAbilityRemoteException - Throws this exception if a remote process exception occurs.

从以下版本开始:

3

query

public CalendarCollection query(int id,
                                String[] columns)
                         throws DataAbilityRemoteException

Queries calendar data in the database based on ID and columns.

id has different representations in different tables.

• In CalendarEntity, id represents the calendar ID.
• In Events, id represents the account ID.
• In Instances, id represents the event ID.

参数:

id - Indicates the ID to be used for query.

columns - Indicates the fields to obtain.

返回:

Returns the calendar data.

抛出:

DataAbilityRemoteException - Throws this exception if a remote process exception occurs.

从以下版本开始:

3

insert

public boolean insert(ValuesBucket valuesBucket)
               throws DataAbilityRemoteException

Inserts a calendar record into the database.

参数:

valuesBucket - Indicates the record to insert.

返回:

Returns true if the record is inserted; returns false otherwise.

抛出:

DataAbilityRemoteException - Throws this exception if a remote process exception occurs.

从以下版本开始:

3

update

public boolean update(ValuesBucket valuesBucket,
                      DataAbilityPredicates predicates)
               throws DataAbilityRemoteException

Updates a calendar record in the database.

参数:

valuesBucket - Indicates the record to update.

predicates - Indicates the filter conditions. Applications can query data using exact match, fuzzy match, or aggregation.

返回:

Returns true if the record is updated; returns false otherwise.

抛出:

DataAbilityRemoteException - Throws this exception if a remote process exception occurs.

从以下版本开始:

3

delete

public int delete(DataAbilityPredicates predicates)
           throws DataAbilityRemoteException

Deletes calendar data based on predicates.

参数:

predicates - Indicates the conditions used to delete calendar data. If this parameter is null, no record is deleted.

返回:

Returns the number of records deleted.

抛出:

DataAbilityRemoteException - Throws this exception if a remote process exception occurs.

从以下版本开始:

3

delete

public boolean delete(CalendarEntity entity)
               throws DataAbilityRemoteException

Deletes specified calendar data.

参数:

entity - Indicates the calendar entity object to delete.

返回:

Returns the number of records deleted.

抛出:

DataAbilityRemoteException - Throws this exception if a remote process exception occurs.

从以下版本开始:

3

delete

public boolean delete(int id)
               throws DataAbilityRemoteException

Deletes the calendar record of a specified ID.

参数:

id - Indicates the ID of the calendar record to delete.

返回:

Returns true if the calendar record is deleted; returns false otherwise.

抛出:

DataAbilityRemoteException - Throws this exception if a remote process exception occurs.

从以下版本开始:

3

release

public boolean release()

Releases data client resources when the database operation is complete.

返回:

Returns true if the client resources are released; returns false otherwise.

从以下版本开始:

3

getInstanceDataHelper

public CalendarDataHelper.InstancesDataHelper getInstanceDataHelper()

Creates an InstancesDataHelper object.

返回:

Returns the InstancesDataHelper object.

从以下版本开始:

3