Class CalendarDatabase

Definition

Namespace:

Tizen.Pims.Calendar

Assembly:

Tizen.Pims.Calendar.dll

The CalendarDatabase provides methods to manage calendar information from/to the database.

public class CalendarDatabase

Inheritance

object

CalendarDatabase

Remarks

This class allows user to access/create/update/delete database operations for the calendar information. The CalendarDatabase is created by the CalendarManager.

Properties

LastChangeVersion

Gets the last successful changed calendar database version on the current connection.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int LastChangeVersion { get; }

Property Value

Type	Description
int	The last successful changed calendar database version on the current connection.

Exceptions

Type	Condition
InvalidOperationException	Thrown when the method failed due to an invalid operation.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Version

The calendar database version.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Version { get; }

Property Value

Type	Description
int	The current calendar database version.

Methods

AddDBChangedDelegate(string, EventHandler<DBChangedEventArgs>)

Registers a callback function to be invoked when a record changes.

Declaration

[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void AddDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)

Parameters

Type	Name	Description
string	viewUri	The view URI of the record to subscribe for change notifications.
EventHandler<DBChangedEventArgs>	DBChanged	The EventHandler to register.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Delete(string, int)

Deletes a record from the calendar database with related child records.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int recordId)

Parameters

Type	Name	Description
string	viewUri	The view URI of a record.
int	recordId	The record ID to be deleted.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Delete(string, int[])

Deletes multiple records with the related child records from the calendar database as a batch operation.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int[] idArray)

Parameters

Type	Name	Description
string	viewUri	The view URI of the records to delete.
int[]	idArray	The record IDs to delete.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Delete(CalendarList)

Deletes multiple records with the related child records from the calendar database as a batch operation.

Declaration

public void Delete(CalendarList list)

Parameters

Type	Name	Description
CalendarList	list	The record list.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Get(string, int)

Gets a record from the calendar database.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarRecord Get(string viewUri, int recordId)

Parameters

Type	Name	Description
string	viewUri	The view URI of a record.
int	recordId	The record ID.

Returns

Type	Description
CalendarRecord	The record associated with the record ID.

Exceptions

Type	Condition
NotSupportedException	Thrown when feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

GetAll(string, int, int)

Retrieves all the records as a list.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarList GetAll(string viewUri, int offset, int limit)

Parameters

Type	Name	Description
string	viewUri	The view URI to get records from.
int	offset	The index from which results are received.
int	limit	The maximum number of results (value 0 is used for all the records).

Returns

Type	Description
CalendarList	The record list.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

GetChangesByVersion(string, int, int, out int)

Retrieves the records with the given calendar database version.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarList GetChangesByVersion(string viewUri, int BookId, int calendarDBVersion, out int currentDBVersion)

Parameters

Type	Name	Description
string	viewUri	The view URI to get records from.
int	BookId	The calendar book ID to filter.
int	calendarDBVersion	The calendar database version.
int	currentDBVersion	The current calendar database version.

Returns

Type	Description
CalendarList	The record list.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

GetCount(string)

Gets the record count of a specific view.

Declaration

[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public int GetCount(string viewUri)

Parameters

Type	Name	Description
string	viewUri	The view URI to get records from.

Returns

Type	Description
int	The count of records.

GetCount(CalendarQuery)

Gets the record count with a query.

Declaration

[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
public int GetCount(CalendarQuery query)

Parameters

Type	Name	Description
CalendarQuery	query	The query used for filtering the results.

Returns

Type	Description
int	The count of records.

GetRecordsWithQuery(CalendarQuery, int, int)

Retrieves the records using a query.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public CalendarList GetRecordsWithQuery(CalendarQuery query, int offset, int limit)

Parameters

Type	Name	Description
CalendarQuery	query	The query used to filter results.
int	offset	The index from which results are received.
int	limit	The maximum number of results (value 0 is used for all the records).

Returns

Type	Description
CalendarList	CalendarList.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Insert(CalendarList)

Inserts multiple records into the calendar database as a batch operation.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int[] Insert(CalendarList list)

Parameters

Type	Name	Description
CalendarList	list	The record list.

Returns

Type	Description
int[]	The inserted record ID array.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Insert(CalendarRecord)

Inserts a record into the calendar database.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Insert(CalendarRecord record)

Parameters

Type	Name	Description
CalendarRecord	record	The record to be inserted.

Returns

Type	Description
int	The ID of inserted record.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

LinkRecord(int, int)

Links a record to another record.

Declaration

[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
public void LinkRecord(int baseId, int recordId)

Parameters

Type	Name	Description
int	baseId	The base record ID.
int	recordId	The record ID to link to.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

RemoveDBChangedDelegate(string, EventHandler<DBChangedEventArgs>)

Deregisters a callback function.

Declaration

[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void RemoveDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)

Parameters

Type	Name	Description
string	viewUri	The view URI of the record to subscribe for change notifications.
EventHandler<DBChangedEventArgs>	DBChanged	The EventHandler to deregister.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Replace(CalendarList, int[])

Replaces multiple records in the calendar database as a batch operation.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(CalendarList list, int[] idArray)

Parameters

Type	Name	Description
CalendarList	list	The record list.
int[]	idArray	The record IDs.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Replace(CalendarRecord, int)

Replaces a record in the calendar database.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(CalendarRecord record, int id)

Parameters

Type	Name	Description
CalendarRecord	record	The record to be replaced.
int	id	The record ID.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

UnlinkRecord(int)

Unlinks a record from the base record.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void UnlinkRecord(int recordId)

Parameters

Type	Name	Description
int	recordId	The record ID to unlink.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Update(CalendarList)

Updates multiple records into the calendar database as a batch operation.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(CalendarList list)

Parameters

Type	Name	Description
CalendarList	list	The record list.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.

Update(CalendarRecord)

Updates a record in the calendar database.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(CalendarRecord record)

Parameters

Type	Name	Description
CalendarRecord	record	The record to be updated.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
InvalidOperationException	Thrown when the method failed due to an invalid operation.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.
OutOfMemoryException	Thrown when failed due to out of memory.
UnauthorizedAccessException	Thrown when the application does not have proper privileges.