com.sap.ip.me.api.smartsync
Interface ErrorConflictInbox


public interface ErrorConflictInbox

This serves as the access point of all SmartSync applications in retrieving error or conflict response from the server.the application could retrieve an object that holds the information regarding the error or conflict as well as the access to the resolver object to which it could use in resolving the issue.

The ErrorConflictInbox will only hold the latest response for the same syncKey. Whenever a new error or conflict message is returned from the server and there is an unresolved quarantined object of the same syncKey in the inbox, the inbox will update/overwrite the old response instance with the new one and will add a history log of the former into the response instance.

To retrieve the ErrorConflictInbox instance
Example:
ErrorConflictInbox errorConflictInbox= SmartSyncRuntime.getInstance().getInboxNotifier().getErrorConflictInbox();

The SyncBo Responses can be retrieve for a given SyncBo descriptor,type of response ERROR or CONFLICT and a combination of both.
Example:
//Fetches all the responses (error or conflict). MeIterator iterator = errorConflictInbox.getAllSyncBoResponses(); //Fetches all the response for a given sync bo. MeIterator iterator = errorConflictInbox.getSyncBoResponses(syncBoDescriptor); //Fetches all the response for a given sync bo and the response type(Error or Conflict). MeIterator iterator = errorConflictInbox.getSyncBoResponses(syncBoDescriptor,responseType); //Fetches all the response for a given response type(Error or Conflict). MeIterator iterator = errorConflictInbox.getSyncBoResponses(responseType);

Copyright: Copyright (c) 2003

Company: SAP AG

Since:
2.5
Version:
2.5
Author:
Jo Gel
See Also:
SyncBoResolver, SyncBoResponse

Method Summary
 MeIterator getAllSyncBoResponses()
          Fetches all the responses (error or conflict).
 SyncBoResponse getSyncBoResponse(SyncBoDescriptor syncBoDescriptor, java.math.BigInteger syncKey)
          Fetches the response for a given sync bo descriptor and the key
 SyncBoResponse getSyncBoResponse(SyncBoDescriptor syncBoDescriptor, java.lang.String syncKey)
          Deprecated. This method will be removed in next MI releases. Use instead getSyncBoResponse(SyncBoDescriptor, BigInteger) instead.
 MeIterator getSyncBoResponses(SyncBoDescriptor syncBoDescriptor)
          Fetches all the response for a given sync bo descriptor
 MeIterator getSyncBoResponses(SyncBoDescriptor syncBoDescriptor, SyncBoResponseType responseType)
          Fetches all the response for a given sync bo descriptor and the response type(Error or Conflict)
 MeIterator getSyncBoResponses(SyncBoResponseType responseType)
          Fetches all the response for a given response type(Error or Conflict)
 

Method Detail

getAllSyncBoResponses

public MeIterator getAllSyncBoResponses()
                                 throws PersistenceException,
                                        SmartSyncException
Fetches all the responses (error or conflict).

Returns:
MeIterator containing instances of SyncBoResponse
Throws:
PersistenceException - thrown if any persistent layer exception occurred during the retrieval
SmartSyncException - thrown if any smartsync layer exception occurred during the retrieval
See Also:
SyncBoResponse

getSyncBoResponses

public MeIterator getSyncBoResponses(SyncBoDescriptor syncBoDescriptor)
                              throws PersistenceException,
                                     SmartSyncException
Fetches all the response for a given sync bo descriptor

Returns:
MeIterator containing instances of SyncBoResponse
Throws:
PersistenceException - thrown if any persistent layer exception occurred during the retrieval
SmartSyncException - thrown if any smartsync layer exception occurred during the retrieval
See Also:
SyncBoResponse

getSyncBoResponses

public MeIterator getSyncBoResponses(SyncBoDescriptor syncBoDescriptor,
                                     SyncBoResponseType responseType)
                              throws PersistenceException,
                                     SmartSyncException
Fetches all the response for a given sync bo descriptor and the response type(Error or Conflict)

Returns:
MeIterator containing instances of SyncBoResponse
Throws:
PersistenceException - thrown if any persistent layer exception occurred during the retrieval
SmartSyncException - thrown if any smartsync layer exception occurred during the retrieval
See Also:
SyncBoResponse

getSyncBoResponses

public MeIterator getSyncBoResponses(SyncBoResponseType responseType)
                              throws PersistenceException,
                                     SmartSyncException
Fetches all the response for a given response type(Error or Conflict)

Returns:
MeIterator containing instances of SyncBoResponse
Throws:
PersistenceException - thrown if any persistent layer exception occurred during the retrieval
SmartSyncException - thrown if any smartsync layer exception occurred during the retrieval
See Also:
SyncBoResponse

getSyncBoResponse

public SyncBoResponse getSyncBoResponse(SyncBoDescriptor syncBoDescriptor,
                                        java.lang.String syncKey)
                                 throws PersistenceException,
                                        SmartSyncException
Deprecated. This method will be removed in next MI releases. Use instead getSyncBoResponse(SyncBoDescriptor, BigInteger) instead.

Fetches the response for a given sync bo descriptor and the key

Parameters:
syncBoDescriptor - sync bo descriptor
syncKey - key
Returns:
sync bo response
Throws:
PersistenceException - thrown if any persistent layer exception occurred during the retrieval
SmartSyncException - thrown if any smartsync layer exception occurred during the retrieval
See Also:
SyncBoResponse

getSyncBoResponse

public SyncBoResponse getSyncBoResponse(SyncBoDescriptor syncBoDescriptor,
                                        java.math.BigInteger syncKey)
                                 throws PersistenceException,
                                        SmartSyncException
Fetches the response for a given sync bo descriptor and the key

Parameters:
syncBoDescriptor - sync bo descriptor
syncKey - key
Returns:
sync bo response
Throws:
PersistenceException - thrown if any persistent layer exception occurred during the retrieval
SmartSyncException - thrown if any smartsync layer exception occurred during the retrieval
See Also:
SyncBoResponse


Copyright © 2005 SAP AG. All Rights Reserved.