MVPbkBatchOperationObserver Class Reference

#include <app/MVPbkBatchOperationObserver.h>

class MVPbkBatchOperationObserver
Public Member Functions
virtual TAny *BatchOperationObserverExtension(TUid)
pure virtual voidOperationComplete(MVPbkContactOperationBase &)
pure virtual voidStepComplete(MVPbkContactOperationBase &, TInt)
pure virtual TBool StepFailed(MVPbkContactOperationBase &, TInt, TInt)
Protected Member Functions
virtual ~MVPbkBatchOperationObserver()

Detailed Description

Virtual Phonebook asynchronous multi contact operation observer interface. This observer interface is used to signal the client during a batch operation, which involves operations to e.g. multiple contacts. The client is signaled during the operations steps and then signaled of the completion of the whole operation.

Constructor & Destructor Documentation

~MVPbkBatchOperationObserver ( )

~MVPbkBatchOperationObserver()[protected, inline, virtual]

Destructor.

Member Function Documentation

BatchOperationObserverExtension ( TUid )

TAny *BatchOperationObserverExtension(TUid)[inline, virtual]

Returns an extension point for this interface or NULL.

Returns: Extension point or NULL

OperationComplete ( MVPbkContactOperationBase & )

voidOperationComplete(MVPbkContactOperationBase &aOperation)[pure virtual]

Called when operation is completed. This is called when all steps are executed. If EFalse is returned in StepFailed() call this function is NOT called.

ParameterDescription
aOperationthe completed operation

StepComplete ( MVPbkContactOperationBase &, TInt )

voidStepComplete(MVPbkContactOperationBase &aOperation,
TIntaStepSize
)[pure virtual]

Called when one step of the operation is completed.

ParameterDescription
aOperationOperation whose step has completed
aStepSizeSize of the performed step

StepFailed ( MVPbkContactOperationBase &, TInt, TInt )

TBool StepFailed(MVPbkContactOperationBase &aOperation,
TIntaStepSize,
TIntaError
)[pure virtual]

Called when one step of the operation fails.

ParameterDescription
aOperationOperation whose step has failed
aStepSizeSize of the performed step
aErrorError that occured

Returns: ETrue if the batch operation should continue, EFalse otherwise NOTE! If returning ETrue the operation can NOT be deleted. Operation should be deleted in OperationCompleted() function. If returning EFalse the operation can be deleted safely.