namespace Tizen.Applications.DataControl
{
/// <summary>
- /// Represents BulkData class for DataControl bulk request.
+ /// Represents the BulkData class for the DataControl bulk request.
/// </summary>
public class BulkData : IDisposable
{
private Interop.DataControl.SafeBulkDataHandle _handle;
/// <summary>
- /// Initializes BulkData class.
+ /// Initializes the BulkData class.
/// </summary>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public BulkData()
}
/// <summary>
- /// Adds bulk data.
+ /// Adds the bulk data.
/// </summary>
/// <param name="data">Bulk data</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public void Add(Bundle data)
{
ResultType ret;
}
/// <summary>
- /// Gets current data count.
+ /// Gets the current data count.
/// </summary>
public int GetCount()
{
/// <summary>
/// Returns the data at the given zero-based data index.
/// </summary>
- /// <param name="index">Target data index</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="index">The target data index.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public Bundle GetData(int index)
{
IntPtr bundlePtr;
}
/// <summary>
- /// Releases all resources used by the BulkData class.
+ /// Releases all the resources used by the BulkData class.
/// </summary>
public void Dispose()
{
}
/// <summary>
- /// Represents BulkResultData class for DataControl bulk request.
+ /// Represents the BulkResultData class for the DataControl bulk request.
/// </summary>
public class BulkResultData : IDisposable
{
private bool _disposed = false;
private Interop.DataControl.SafeBulkResultDataHandle _handle;
/// <summary>
- /// Initializes BulkResultData class.
+ /// Initializes the BulkResultData class.
/// </summary>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public BulkResultData()
}
/// <summary>
- /// Adds bulk operation result data.
+ /// Adds the bulk operation result data.
/// </summary>
- /// <param name="data">Result data</param>
- /// <param name="result">Result</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="data">The result data.</param>
+ /// <param name="result">Result.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public void Add(Bundle data, int result)
{
ResultType ret;
}
/// <summary>
- /// Gets current result data count.
+ /// Gets the current result data count.
/// </summary>
public int GetCount()
{
/// <summary>
/// Returns the result data at the given zero-based data index.
/// </summary>
- /// <param name="index">Target result data index</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="index">The target result data index.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public Bundle GetData(int index)
{
IntPtr bundlePtr;
/// <summary>
/// Returns the result at the given zero-based data index.
/// </summary>
- /// <param name="index">Target result index</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="index">The target result index.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public int GetResult(int index)
{
IntPtr bundlePtr;
}
/// <summary>
- /// Releases all resources used by the BulkResultData class.
+ /// Releases all the resources used by the BulkResultData class.
/// </summary>
public void Dispose()
{
namespace Tizen.Applications.DataControl
{
/// <summary>
- /// Represents Consumer class for DataControl consumer application.
+ /// Represents the Consumer class for the DataControl consumer application.
/// </summary>
public abstract class Consumer : IDisposable
{
}
/// <summary>
- /// Sends insert request to provider application.
+ /// Sends the insert request to the provider application.
/// </summary>
- /// <remarks>OnInsertResult will recieve result of this API</remarks>
- /// <param name="insertData">Insert data</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(1MB)</exception>
+ /// <remarks>The OnInsertResult will recieve the result of this API.</remarks>
+ /// <param name="insertData">The insert data.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the message has exceeded the maximum limit (1MB).</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends select request to provider application.
+ /// Sends the select request to the provider application.
/// </summary>
- /// <remarks>OnSelectResult will recieve result of this API</remarks>
- /// <param name="columnList">Select target column list</param>
- /// <param name="where">Where statement for select query</param>
- /// <param name="order">Order statement for select query</param>
- /// <param name="pageNumber">Select target page number</param>
- /// <param name="countPerPage">Select row count per page</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <remarks>The OnSelectResult will recieve the result of this API.</remarks>
+ /// <param name="columnList">Select the target column list.</param>
+ /// <param name="where">The Where statement for the select query.</param>
+ /// <param name="order">The Order statement for the select query.</param>
+ /// <param name="pageNumber">Select the target page number.</param>
+ /// <param name="countPerPage">Select the row count per page.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied..</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends delete request to provider application.
+ /// Sends the delete request to the provider application.
/// </summary>
- /// <remarks>OnDeleteResult will recieve result of this API</remarks>
- /// <param name="where">Where statement for delete query</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <remarks>The OnDeleteResult will recieve the result of this API</remarks>
+ /// <param name="where">The Where statement for the delete query.</param>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends update request to provider application.
+ /// Sends the update request to the provider application.
/// </summary>
- /// <remarks>OnUpdateResult will recieve result of this API</remarks>
- /// <param name="updateData">Update data</param>
- /// <param name="where">Where statement for query</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(1MB)</exception>
+ /// <remarks>The OnUpdateResult will recieve result of this API.</remarks>
+ /// <param name="updateData">The update data.</param>
+ /// <param name="where">The Where statement for the query.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the message has exceeded the maximum limit (1MB).</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends bulk insert request to provider application.
+ /// Sends the bulk insert request to the provider application.
/// </summary>
- /// <remarks>OnBulkInsertResult will recieve result of this API</remarks>
- /// <param name="insertData">Bulk insert data</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(1MB)</exception>
+ /// <remarks>The OnBulkInsertResult will recieve the result of this API.</remarks>
+ /// <param name="insertData">The bulk insert data.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case oif a permission is denied.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the message has exceeded the maximum limit (1MB).</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends map add request to provider application.
+ /// Sends the map add request to the provider application.
/// </summary>
- /// <remarks>OnMapAddResult will recieve result of this API</remarks>
- /// <param name="key">The key of the value to add</param>
- /// <param name="value">The value to add</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(1MB)</exception>
+ /// <remarks>The OnMapAddResult will recieve the result of this API.</remarks>
+ /// <param name="key">The key of the value to add.</param>
+ /// <param name="value">The value to add.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of if a permission is denied.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the message has exceeded the maximum limit (1MB).</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends map get request to provider application.
+ /// Sends the map get request to the provider application.
/// </summary>
- /// <remarks>OnMapGetResult will recieve result of this API</remarks>
- /// <param name="key">The key of the value list to obtain</param>
- /// <param name="pageNumber">The page number of the value set</param>
- /// <param name="countPerPage">The desired maximum count of the data items per page</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <remarks>The OnMapGetResult will recieve the result of this API.</remarks>
+ /// <param name="key">The key of the value list to obtain.</param>
+ /// <param name="pageNumber">The page number of the value set.</param>
+ /// <param name="countPerPage">The desired maximum count of the data items per page.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends map remove request to provider application.
+ /// Sends the map remove request to the provider application.
/// </summary>
- /// <remarks>OnMapRemoveResult will recieve result of this API</remarks>
- /// <param name="key">The key of the value to remove</param>
- /// <param name="value">The value to remove</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <remarks>The OnMapRemoveResult will recieve the result of this API.</remarks>
+ /// <param name="key">The key of the value to remove.</param>
+ /// <param name="value">The value to remove.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends map set request to provider application.
+ /// Sends the map set request to the provider application.
/// </summary>
- /// <remarks>OnMapSetResult will recieve result of this API</remarks>
- /// <param name="key">The key of the value to replace</param>
- /// <param name="oldValue">The value to be replaced</param>
- /// <param name="newValue"> The new value that replaces the existing value</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(1MB)</exception>
+ /// <remarks>The OnMapSetResult will recieve the result of this API.</remarks>
+ /// <param name="key">The key of the value to replace.</param>
+ /// <param name="oldValue">The value to be replaced.</param>
+ /// <param name="newValue"> The new value that replaces the existing value.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit (1MB).</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Sends map bulk add request to provider application.
+ /// Sends the map bulk add request to the provider application.
/// </summary>
- /// <remarks>OnMapBulkAddResult will recieve result of this API</remarks>
- /// <param name="addData">Map bulk add data</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(1MB)</exception>
+ /// <remarks>The OnMapBulkAddResult will recieve the result of this API.</remarks>
+ /// <param name="addData">The map bulk add data.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the message has exceeded the maximum limit (1MB).</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Listen DataChange event
+ /// Listens the DataChange event.
/// </summary>
- /// <remarks>OnDataChangeListenResult will recieve result of this API</remarks>
- /// <remarks>If success, OnDataChange will recieve DataChange event</remarks>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <remarks>The OnDataChangeListenResult will recieve the result of this API.</remarks>
+ /// <remarks>If success, the OnDataChange will recieve the DataChange event.</remarks>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case if a permission is denied.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
}
/// <summary>
- /// Initializes Consumer class with providerId and dataId.
+ /// Initializes the Consumer class with the providerId and the ataId.
/// </summary>
- /// <param name="providerId">DataControl Provider ID</param>
- /// <param name="dataId">DataControl Data ID</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="providerId">The DataControl Provider ID.</param>
+ /// <param name="dataId">The DataControl Data ID.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public Consumer(string providerId, string dataId)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the DataChangeListen result is received.
+ /// Overrides this method if you want to handle the behavior when the DataChangeListen result is received.
/// </summary>
protected virtual void OnDataChangeListenResult(DataChangeListenResult result)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the data change event is received.
+ /// Overrides this method if you want to handle the behavior when the data change event is received.
/// </summary>
protected virtual void OnDataChange(ChangeType type, Bundle data)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the select response is received.
+ /// Overrides this method if you want to handle the behavior when the select response is received.
/// </summary>
protected abstract void OnSelectResult(SelectResult result);
/// <summary>
- /// Overrides this method if want to handle behavior when the insert response is received.
+ /// Overrides this method if you want to handle the behavior when the insert response is received.
/// </summary>
protected abstract void OnInsertResult(InsertResult result);
/// <summary>
- /// Overrides this method if want to handle behavior when the update response is received.
+ /// Overrides this method if you want to handle the behavior when the update response is received.
/// </summary>
protected abstract void OnUpdateResult(UpdateResult result);
/// <summary>
- /// Overrides this method if want to handle behavior when the delete response is received.
+ /// Overrides this method if want to handle the behavior when the delete response is received.
/// </summary>
protected abstract void OnDeleteResult(DeleteResult result);
/// <summary>
- /// Overrides this method if want to handle behavior when the BulkInsert response is received.
+ /// Overrides this method if you want to handle the behavior when the BulkInsert response is received.
/// </summary>
protected virtual void OnBulkInsertResult(BulkInsertResult result)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the map get response is received.
+ /// Overrides this method if you want to handle the behavior when the map get response is received.
/// </summary>
protected virtual void OnMapGetResult(MapGetResult result)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the map add response is received.
+ /// Overrides this method if you want to handle the behavior when the map add response is received.
/// </summary>
protected virtual void OnMapAddResult(MapAddResult result)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the map set response is received.
+ /// Overrides this method if you want to handle the behavior when the map set response is received.
/// </summary>
protected virtual void OnMapSetResult(MapSetResult result)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the map remove response is received.
+ /// Overrides this method if you want to handle the behavior when the map remove response is received.
/// </summary>
protected virtual void OnMapRemoveResult(MapRemoveResult result)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the BulkAdd response is received.
+ /// Overrides this method if you want to handle the behavior when the BulkAdd response is received.
/// </summary>
protected virtual void OnMapBulkAddResult(MapBulkAddResult result)
{
}
/// <summary>
- /// Releases the unmanaged resourced used by the Consumer class specifying whether to perform a normal dispose operation.
+ /// Releases the unmanaged resources used by the Consumer class specifying whether to perform a normal dispose operation.
/// </summary>
/// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
protected virtual void Dispose(bool disposing)
namespace Tizen.Applications.DataControl
{
/// <summary>
- /// This interface is for DataControl cursor.
+ /// This interface is for the DataControl cursor.
/// </summary>
public interface ICursor
{
/// </summary>
bool Reset();
/// <summary>
- /// / Gets an int value.
+ /// Gets an integer value.
/// </summary>
/// <param name="index">The index of row.</param>
int GetIntValue(int index);
/// <summary>
- /// / Gets an int64 value.
+ /// Gets an int64 value.
/// </summary>
/// <param name="index">The index of row.</param>
Int64 GetInt64Value(int index);
/// <summary>
- /// Gets an double value.
+ /// Gets a double value.
/// </summary>
/// <param name="index">The index of row.</param>
double GetDoubleValue(int index);
/// <summary>
- /// Gets an string value.
+ /// Gets a string value.
/// </summary>
/// <param name="index">The index of row.</param>
string GetStringValue(int index);
/// <summary>
- /// Gets a blob value.
+ /// Gets a BLOB value.
/// </summary>
/// <param name="index">The index of row.</param>
byte[] GetBlobValue(int index);
namespace Tizen.Applications.DataControl
{
/// <summary>
- /// Represents MatrixCursor class for DataControl provider's matrix cursor.
+ /// Represents the MatrixCursor class for the DataControl provider's matrix cursor.
/// </summary>
public class MatrixCursor : IDisposable, ICursor
{
}
/// <summary>
- /// Gets column count of MatrixCursor.
+ /// Gets the column count of the MatrixCursor.
/// </summary>
public int GetColumnCount()
{
/// Returns the column type at the given zero-based column index.
/// </summary>
/// <param name="index">Target column index</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public ColumnType GetColumnType(int index)
{
if (index < 0 || index >= _columnTypes.Length)
/// <summary>
/// Returns the column name at the given zero-based column index.
/// </summary>
- /// <param name="index">Target column index</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="index">The target column index.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public string GetColumnName(int index)
{
if (index < 0 || index >= _columnTypes.Length)
}
/// <summary>
- /// Gets MatrixCursor's row count.
+ /// Gets the MatrixCursor's row count.
/// </summary>
public long GetRowCount()
{
}
/// <summary>
- /// Returns the value of the requested column as a int.
+ /// Returns the value of the requested column as an integer.
/// </summary>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public int GetIntValue(int index)
{
int ret;
}
/// <summary>
- /// Returns the value of the requested column as a int64.
+ /// Returns the value of the requested column as int64.
/// </summary>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public Int64 GetInt64Value(int index)
{
Int64 ret;
/// <summary>
/// Returns the value of the requested column as a double.
/// </summary>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public double GetDoubleValue(int index)
{
double ret;
/// <summary>
/// Returns the value of the requested column as a string.
/// </summary>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public string GetStringValue(int index)
{
string ret;
}
/// <summary>
- /// Returns the value of the requested column as a blob.
+ /// Returns the value of the requested column as a BLOB.
/// </summary>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public byte[] GetBlobValue(int index)
{
byte[] byte_array;
}
/// <summary>
- /// Initializes MatrixCursor class with columnNames and columnTypes.
+ /// Initializes the MatrixCursor class with columnNames and columnTypes.
/// </summary>
- /// <param name="columnNames">MatrixCursor's column name list</param>
- /// <param name="columnTypes">MatrixCursor's column type list</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="columnNames">The MatrixCursor's column name list.</param>
+ /// <param name="columnTypes">The MatrixCursor's column type list.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public MatrixCursor(string[] columnNames, ColumnType[] columnTypes)
{
/// Adds a new row to the end with the given column values.
/// </summary>
/// <param name="columnValues">New column values</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public void AddRow(object[] columnValues)
{
int i, size = 0;
}
/// <summary>
- /// Releases all resources used by the MatrixCursor class.
+ /// Releases all the resources used by the MatrixCursor class.
/// </summary>
public void Dispose()
{
namespace Tizen.Applications.DataControl
{
/// <summary>
- /// Represents Provider class for DataControl provider application.
+ /// Represents the Provider class for the DataControl provider application.
/// </summary>
public abstract class Provider : IDisposable
{
private bool _isRunning = false;
/// <summary>
- /// Gets the data ID
+ /// Gets the data ID.
/// </summary>
public string DataID
{
/// <summary>
/// Sends a data change notification to consumer applications which have successfully added a data change listen.
/// </summary>
- /// <param name="type">Changed data type</param>
- /// <param name="changedData">Customized information about changed data</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <param name="type">The changed data type.</param>
+ /// <param name="changedData">Customized information about the changed data.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case a permission is denied.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
public void SendDataChange(ChangeType type, Bundle changedData)
}
/// <summary>
- /// Initializes Provider class with dataID.
+ /// Initializes the Provider class with the dataID.
/// </summary>
- /// <param name="dataID">DataControl Data ID</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="dataID">The DataControl Data ID.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public Provider(string dataID)
{
if (string.IsNullOrEmpty(dataID))
}
/// <summary>
- /// Starts Provider service.
+ /// Starts the Provider service.
/// </summary>
- /// <remarks>Only one Provider service can be ran for each process</remarks>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <remarks>Only one Provider service can be run for each process.</remarks>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case a permission is denied.</exception>
/// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
public void Run()
}
/// <summary>
- /// Stop Provider service.
+ /// Stops the Provider service.
/// </summary>
public void Stop()
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the select request is received.
+ /// Overrides this method if you want to handle the behavior when the select request is received.
/// </summary>
protected abstract SelectResult OnSelect(string query, string where, string[] columList, int columnCount, string order, int pageNum, int countPerPage);
/// <summary>
- /// Overrides this method if want to handle behavior when the insert request is received.
+ /// Overrides this method if you want to handle the behavior when the insert request is received.
/// </summary>
protected abstract InsertResult OnInsert(string query, Bundle insertData);
/// <summary>
- /// Overrides this method if want to handle behavior when the update request is received.
+ /// Overrides this method if you want to handle the behavior when the update request is received.
/// </summary>
protected abstract UpdateResult OnUpdate(string query, string where, Bundle updateData);
/// <summary>
- /// Overrides this method if want to handle behavior when the delete request is received.
+ /// Overrides this method if you want to handle the behavior when the delete request is received.
/// </summary>
protected abstract DeleteResult OnDelete(string query, string where);
/// <summary>
- /// Overrides this method if want to handle behavior when the bulk insert request is received.
+ /// Overrides this method if you want to handle the behavior when the bulk insert request is received.
/// </summary>
protected virtual BulkInsertResult OnBulkInsert(IEnumerable<string> query, BulkData bulkInsertData)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the map get request is received.
+ /// Overrides this method if you want to handle the behavior when the map get request is received.
/// </summary>
protected virtual MapGetResult OnMapGet(string key)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the map add request is received.
+ /// Overrides this method if you want to handle the behavior when the map add request is received.
/// </summary>
protected virtual MapAddResult OnMapAdd(string key, string value)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the update request is received.
+ /// Overrides this method if you want to handle the behavior when the update request is received.
/// </summary>
protected virtual MapSetResult OnMapSet(string key, string oldValue, string newValue)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the delete request is received.
+ /// Overrides this method if you want to handle the behavior when the delete request is received.
/// </summary>
protected virtual MapRemoveResult OnMapRemove(string key, string value)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the bulk add request is received.
+ /// Overrides this method if you want to handle the behavior when the bulk add request is received.
/// </summary>
protected virtual MapBulkAddResult OnMapBulkAdd(BulkData bulkAddData)
{
}
/// <summary>
- /// Overrides this method if want to handle behavior when the data change listen request is received.
+ /// Overrides this method if you want to handle the behavior when the data change listen request is received.
/// </summary>
protected virtual DataChangeListenResult OnDataChangeListenRequest(string requestAppID)
{
}
/// <summary>
- /// Releases the unmanaged resourced used by the Provider class specifying whether to perform a normal dispose operation.
+ /// Releases unmanaged resources used by the Provider class specifying whether to perform a normal dispose operation.
/// </summary>
/// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Releases all resources used by the Provider class.
+ /// Releases all the resources used by the Provider class.
/// </summary>
public void Dispose()
{
namespace Tizen.Applications.DataControl
{
/// <summary>
- /// This class is for containing insert operation result.
+ /// This class contains the insert operation result.
/// </summary>
public class InsertResult
{
/// <summary>
- /// Gets the insert data's row id.
+ /// Gets the insert data's row ID.
/// </summary>
public long RowID
{
}
/// <summary>
- /// Initializes InsertResult class with columnNames and columnTypes.
+ /// Initializes the InsertResult class with columnNames and columnTypes.
/// </summary>
- /// <param name="rowID">Inserted row ID</param>
- /// <param name="result">Insert request result</param>
+ /// <param name="rowID">The inserted row ID.</param>
+ /// <param name="result">The insert request result.</param>
public InsertResult(long rowID, bool result)
{
RowID = rowID;
}
/// <summary>
- /// This class is for containing bulk insert operation result.
+ /// This class contains the bulk insert operation result.
/// </summary>
public class BulkInsertResult
{
}
/// <summary>
- /// Initializes InsertResult class with bulkResultData and result.
+ /// Initializes the InsertResult class with the bulkResultData and the result.
/// </summary>
- /// <param name="bulkResultData">Bulk insert request result data</param>
- /// <param name="result">Bulk insert request result</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="bulkResultData">The bulk insert request result data.</param>
+ /// <param name="result">The bulk insert request result.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public BulkInsertResult(BulkResultData bulkResultData, bool result)
{
if (result == true && (bulkResultData == null || bulkResultData.SafeBulkDataHandle.IsInvalid))
}
/// <summary>
- /// This class is for containing update operation result.
+ /// This class contains the update operation result.
/// </summary>
public class UpdateResult
{
}
/// <summary>
- /// Initializes UpdateResult class with result.
+ /// Initializes the UpdateResult class with the result.
/// </summary>
- /// <param name="result">Update request result</param>
+ /// <param name="result">The update request result.</param>
public UpdateResult(bool result)
{
Result = result;
}
/// <summary>
- /// This class is for containing delete operation result.
+ /// This class contains the delete operation result.
/// </summary>
public class DeleteResult
{
}
/// <summary>
- /// Initializes DeleteResult class with result.
+ /// Initializes the DeleteResult class with the result.
/// </summary>
- /// <param name="result">Delete request result</param>
+ /// <param name="result">The delete request result.</param>
public DeleteResult(bool result)
{
Result = result;
}
/// <summary>
- /// This class is for containing select operation result.
+ /// This class contains the select operation result.
/// </summary>
public class SelectResult
{
}
/// <summary>
- /// Initializes SelectResult class with cursor and result.
+ /// Initializes the SelectResult class with the cursor and the result.
/// </summary>
- /// <param name="cursor">Cursor with selected data</param>
- /// <param name="result">Select request result</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="cursor">The cursor with the selected data.</param>
+ /// <param name="result">The select request result.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public SelectResult(ICursor cursor, bool result)
{
int i;
}
/// <summary>
- /// This class is for containing MapAdd operation result.
+ /// This class contains the MapAdd operation result.
/// </summary>
public class MapAddResult
{
}
/// <summary>
- /// Initializes MapAddResult class with result.
+ /// Initializes the MapAddResult class with the result.
/// </summary>
- /// <param name="result">MapAdd request result</param>
+ /// <param name="result">The MapAdd request result.</param>
public MapAddResult(bool result)
{
Result = result;
}
/// <summary>
- /// This class is for containing MapBulkAdd operation result.
+ /// This class contains the MapBulkAdd operation result.
/// </summary>
public class MapBulkAddResult
{
}
/// <summary>
- /// Initializes MapBulkAddResult class with bulkResultData and result.
+ /// Initializes the MapBulkAddResult class with the bulkResultData and the result.
/// </summary>
- /// <param name="bulkResultData">MapBulkAdd request result data</param>
- /// <param name="result">MapBulkAdd request result</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="bulkResultData">The MapBulkAdd request result data.</param>
+ /// <param name="result">The MapBulkAdd request result.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public MapBulkAddResult(BulkResultData bulkResultData, bool result)
{
if (result == true && (bulkResultData == null || bulkResultData.SafeBulkDataHandle.IsInvalid))
}
/// <summary>
- /// This class is for containing MapSet operation result.
+ /// This class contains the MapSet operation result.
/// </summary>
public class MapSetResult
{
}
/// <summary>
- /// Initializes MapSetResult class with result.
+ /// Initializes the MapSetResult class with the result.
/// </summary>
/// <param name="result">MapSet request result</param>
public MapSetResult(bool result)
}
/// <summary>
- /// This class is for containing MapRemove operation result.
+ /// This class contains the MapRemove operation result.
/// </summary>
public class MapRemoveResult
{
}
/// <summary>
- /// Initializes MapRemoveResult class with result.
+ /// Initializes the MapRemoveResult class with the result.
/// </summary>
- /// <param name="result">MapRemove request result</param>
+ /// <param name="result">The MapRemove request result.</param>
public MapRemoveResult(bool result)
{
Result = result;
}
/// <summary>
- /// This class is for containing MapGet operation result.
+ /// This class contains the MapGet operation result.
/// </summary>
public class MapGetResult
{
}
/// <summary>
- /// Initializes MapGetResult class with data and result.
+ /// Initializes the MapGetResult class with the data and the result.
/// </summary>
- /// <param name="valueLIst">MapGet request result data</param>
- /// <param name="result">MapGet request result</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception>
+ /// <param name="valueLIst">The MapGet request result data.</param>
+ /// <param name="result">The MapGet request result.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
public MapGetResult(string[] valueLIst, bool result)
{
if (result == true && valueLIst == null)
}
/// <summary>
- /// This class is for containing DataChangeListen operation result.
+ /// This class contains the DataChangeListen operation result.
/// </summary>
public class DataChangeListenResult
{
}
/// <summary>
- /// Initializes DataChangeListenResult class with result.
+ /// Initializes the DataChangeListenResult class with the result.
/// </summary>
- /// <param name="result">DataChangeListen request result</param>
+ /// <param name="result">The DataChangeListen request result.</param>
public DataChangeListenResult(ResultType result)
{
Result = result;
{
/// <summary>
- /// Enumeration for DataControl column type
+ /// Enumeration for the DataControl column types.
/// </summary>
public enum ColumnType : short
{
/// <summary>
- /// Value representing DataControl operation Success
+ /// Value representing DataControl operation success.
/// </summary>
ColumnTypeInt = 1,
/// <summary>
- /// Value representing DataControl operation Success
+ /// Value representing DataControl operation success.
/// </summary>
ColumnTypeDouble = 2,
/// <summary>
- /// Value representing DataControl operation Success
+ /// Value representing DataControl operation success.
/// </summary>
ColumnTypeString = 3,
/// <summary>
- /// Value representing DataControl operation Success
+ /// Value representing DataControl operation success.
/// </summary>
ColumnTypeBlob = 4
}
/// <summary>
- /// Enumeration for DataControl column type
+ /// Enumeration for the DataControl column types.
/// </summary>
public enum ChangeType : short
{
/// <summary>
- /// Value representing DataControl provider data changed by update
+ /// Value representing DataControl provider data changed by update.
/// </summary>
Update,
/// <summary>
- /// Value representing DataControl provider data changed by insert
+ /// Value representing DataControl provider data changed by insert.
/// </summary>
Insert,
/// <summary>
- /// Value representing DataControl provider data changed by delete
+ /// Value representing DataControl provider data changed by delete.
/// </summary>
Delete,
/// <summary>
- /// Value representing DataControl provider data changed by map add
+ /// Value representing DataControl provider data changed by map add.
/// </summary>
MapAdd,
/// <summary>
- /// Value representing DataControl provider data changed by map remove
+ /// Value representing DataControl provider data changed by map remove.
/// </summary>
MapRemove,
/// <summary>
- /// Value representing DataControl provider data changed by map set
+ /// Value representing DataControl provider data changed by map set.
/// </summary>
MapSet,
}
/// <summary>
- /// Enumeration for DataControl result type
+ /// Enumeration for the DataControl result types.
/// </summary>
public enum ResultType : int
{
/// <summary>
- /// Value representing DataControl operation success
+ /// Value representing DataControl operation success.
/// </summary>
Success = Interop.DataControl.NativeResultType.Success,
/// <summary>
- /// Value representing DataControl operation cause out of memory error
+ /// Value representing DataControl operation causing out of memory error.
/// </summary>
OutOfMemory = Interop.DataControl.NativeResultType.OutOfMemory,
/// <summary>
- /// Value representing DataControl operation cause IO error
+ /// Value representing DataControl operation causing I/O error.
/// </summary>
IoError = Interop.DataControl.NativeResultType.IoError,
/// <summary>
- /// Value representing DataControl operation cause Invalid parameter error
+ /// Value representing DataControl operation causing invalid parameter error.
/// </summary>
InvalidParameter = Interop.DataControl.NativeResultType.InvalidParameter,
/// <summary>
- /// Value representing DataControl operation cause permission denied error
+ /// Value representing DataControl operation causing permission denied error.
/// </summary>
PermissionDenied = Interop.DataControl.NativeResultType.PermissionDenied,
/// <summary>
- /// Value representing DataControl operation cause max exceed error
+ /// Value representing DataControl operation causing max exceed error.
/// </summary>
MaxExceed = Interop.DataControl.NativeResultType.MaxExceed,
}
projects / platform / core / csapi / tizenfx.git / commitdiff