class CMsvSearchSortOperation : public CActive |
Class: CMsvSearchSortOperation
CMsvSearchSortOperation is used for extended search-sort in message store
Public Member Functions | |
---|---|
~CMsvSearchSortOperation () | |
IMPORT_C TInt | GetNextResultL ( TMsvId &) |
IMPORT_C TInt | GetNextResultL ( TMsvEntry &) |
IMPORT_C TInt | GetQueryIdL () |
IMPORT_C TInt | GetResultCountL () |
IMPORT_C TInt | GetResultsL ( RArray < TMsvId > &) |
IMPORT_C TInt | GetResultsL ( RArray < TMsvEntry > &) |
IMPORT_C CMsvSearchSortOperation * | NewL ( CMsvSession &) |
IMPORT_C TInt | ProgressL () |
IMPORT_C void | RequestL ( CMsvSearchSortQuery *, TBool , TRequestStatus &, TInt ) |
IMPORT_C void | RequestL ( TInt , TRequestStatus &, TInt ) |
IMPORT_C TInt | UnmarkQuery (const TInt ) |
Private Member Enumerations | |
---|---|
enum | TRequestQueryType { EMsvReqWithIterator , EMsvReqWithoutIterator } |
enum | TRequestType { EMsvSearchSortQuery , EMsvQueryId , EMsvSearchSortOnHeaderBody , EMsvGetEntryForIds } |
enum | TSendResultToServer { ESendTMsvId , ESendTMsvIdWithSortFileld , ESendInvalidTMsvId } |
Inherited Enumerations | |
---|---|
CActive:TPriority |
Protected Attributes | |
---|---|
CMsvSession & | iMsvSession |
Inherited Attributes | |
---|---|
CActive::iStatus |
CMsvSearchSortOperation | ( | CMsvSession & | iMsvSession | ) | [private] |
CMsvSearchSortOperation Constructor
CMsvSession & iMsvSession |
void | CheckIsArrayEmptyL | ( | RArray < TMsvId > & | aArray | ) | [private] |
void | CheckWhetherSubFolderOptionIsEnabledForSortQueryL | ( | CMsvSearchSortQuery * | aQuery | ) | [private] |
CMsvSearchSortQuery * aQuery |
void | ConstructL | ( | CMsvSession & | aMsvSession | ) | [private] |
Second phase construction
CMsvSession & aMsvSession |
void | ConstructSearchSortOperation | ( | CMsvSearchSortQuery * | aQuery, |
TBool | aMarkQuery, | |||
TRequestStatus & | aQueryStatus, | |||
TInt | aIterator | |||
) | [private] |
CMsvSearchSortQuery * aQuery | |
TBool aMarkQuery | |
TRequestStatus & aQueryStatus | |
TInt aIterator |
void | ConstructSearchSortOperation | ( | TInt | aQueryId, |
TRequestStatus & | aQueryStatus, | |||
TInt | aIterator | |||
) | [private] |
TInt aQueryId | |
TRequestStatus & aQueryStatus | |
TInt aIterator |
void | DoCancel | ( | ) | [private, virtual] |
Implements cancellation of an outstanding request.
This function is called as part of the active object's Cancel() .
It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.
DoCancel() must not wait for event completion; this is handled by Cancel() .
IMPORT_C TInt | GetNextResultL | ( | TMsvId & | aTMsvId | ) |
Gets the TMsvId of a single index entry object at a time. This function is used when getting the results using iterative mechanism.
TMsvId & aTMsvId |
IMPORT_C TInt | GetNextResultL | ( | TMsvEntry & | aTMsvEntry | ) |
Gets one index entry object at a time. This function is used when getting the results using iterative mechanism.
TMsvEntry & aTMsvEntry |
IMPORT_C TInt | GetQueryIdL | ( | ) |
After the completion of asynchronous function RequestL() , this function provides the query Id corresponding to a particular search-sort query.
IMPORT_C TInt | GetResultCountL | ( | ) |
Returns the count of search-sort results, without returning the actual search-sort results.
IMPORT_C TInt | GetResultsL | ( | RArray < TMsvId > & | aMsvIdList | ) |
After the completion of asynchronous function RequestL() , this function provides a list of index entry Id objects (TMsvId).
IMPORT_C TInt | GetResultsL | ( | RArray < TMsvEntry > & | aMsvEntryList | ) |
After the completion of asynchronous function RequestL() , this function provides a list of index entry objects ( TMsvEntry ).
TBool | IsInTMsvEntryField | ( | TMsvMessagePart | aMessagePart | ) | [private] |
TMsvMessagePart aMessagePart |
TBool | IsMessagePartInHeaderBody | ( | TMsvMessagePart | aMessagePart | ) | [private] |
TMsvMessagePart aMessagePart |
IMPORT_C CMsvSearchSortOperation * | NewL | ( | CMsvSession & | iMsvSession | ) | [static] |
Allocates and constructs a CMsvSearchSortOperation object.
CMsvSession & iMsvSession |
IMPORT_C TInt | ProgressL | ( | ) |
IMPORT_C void | RequestL | ( | CMsvSearchSortQuery * | aQuery, |
TBool | aMarkQuery, | |||
TRequestStatus & | aQueryStatus, | |||
TInt | aIterator = 0 | |||
) |
Search-sort operation is performed on a specified folder (e.g, on INBOX, SENT-ITEMS, DRAFT, OUTBOX or any user created folder).
CMsvSearchSortQuery * aQuery | |
TBool aMarkQuery | |
TRequestStatus & aQueryStatus | |
TInt aIterator = 0 |
IMPORT_C void | RequestL | ( | TInt | aQueryId, |
TRequestStatus & | aQueryStatus, | |||
TInt | aIterator = 0 | |||
) |
Getting Search-sort results for specified QueryId.
TInt aQueryId | |
TRequestStatus & aQueryStatus | |
TInt aIterator = 0 |
void | RunL | ( | ) | [private, virtual] |
Handles an active object's request completion event.
A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.
The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.
Before calling this active object's RunL() function, the active scheduler has:
1. decided that this is the highest priority active object with a completed request
2. marked this active object's request as complete (i.e. the request is no longer outstanding)
RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.
Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.
CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD
void | SendTMsvIdWithSortFieldResultsToserverL | ( | ) | [private] |
void | SetRequestType | ( | TRequestType | aReqType, |
TRequestQueryType | aQueryType | |||
) | [private] |
TRequestType aReqType | |
TRequestQueryType aQueryType |
IMPORT_C TInt | UnmarkQuery | ( | const TInt | aQueryId | ) |
Unmarks the query listed in search-sort cache. The unmarked queries are preferred over marked queries for being disposed from the search-sort cache when the search-sort cache reaches a maximum limit
const TInt aQueryId |
TInt | ValidateQueryString | ( | CMsvSearchSortQuery * | aQuery | ) | [private] |
CMsvSearchSortQuery * aQuery |
EMsvSearchSortQuery | |
EMsvQueryId | |
EMsvSearchSortOnHeaderBody | |
EMsvGetEntryForIds |
CMsvSearchsortOpOnHeaderBody * | iHeaderBodySearch | [private] |
RArray < TMsvIdWithSortField > | iTMsvIdWithSortField | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.