Package com.sap.ip.me.api.smartsync

Interface Summary
CharacterField CharacterField represents the static type of field with java.lang.String as the underlying data type.
DateField DateField represents the static type of field with java.sql.Date as the underlying data type.
DecimalField DecimalField represents the static type of field with java.math.BigDecimal as the underlying data type.
DescriptorIterator This is a generic interface based on the Iterator pattern.
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.
Field A Field represents a specific field with its meta info - FieldDescriptor.
FieldDescriptor The FieldDescriptor provides read access to field's metadata description.
FieldDescriptorIterator An iterator over a collection of FieldDescriptor objects.
FieldGroupDescriptor The FieldGroupDescriptor is a metadata interface that holds the description of a certain FieldGroup instance.
FieldGroupDescriptorIterator An iterator over a collection of FieldGroupDescriptor objects.
InboxNotifier SmartSync uses Notifier/ Observer design pattern for applications to access in-/ out- box.
MessageReply MessageReply is used to describe communication status.
MessageReplyObserver SmartSync uses Notifier/ Observer design pattern for applications to access in-/ out- box.
NumericField NumericField represents the static type of field with java.math.BigInteger as the underlying data type.
RelationDescriptor RelationDescriptor provides read access to: Relating FieldDescriptor.
RelationDescriptorIterator An iterator over a collection RelationDescriptor entities.
Row A Row is a data repository object having a set of fields represented by array or Field objects.
RowChange RowChange represents changed row - RowDelta.
RowCollection A RowCollection is a collection of Row entities.
RowDescriptor A RowDescriptor instance describes the metadata definition for a Row object.
RowDescriptorIterator An iterator over a collection of RowDescriptor objects.
RowList A RowList is a collection of Row entities.
RowOutDelta Deprecated.  
SmartSyncQueryFactory QueryFactory provides functionality to create Query, Condition and SortOrder instances.
SmartSyncTransaction Represents a transaction on SyncBos.
SmartSyncTransactionManager The TransactionManager is the entry point for application driven transaction management based on SyncBos.
SyncBo A SyncBo is a data repository object representing a business object.
SyncBoChange This interface is the base interface to describe SyncBo delta change.
SyncBoCollection A SyncBoCollection is a static collection of SyncBo entities.It uses the SyncBo's key field value as the key to that SyncBo entitiy.Its also possible to a get a iterator of the SyncBo entities in this SyncBoCollection.
SyncBoDataFacade The SyncBoDataFacade provides access functions to all data objects (SyncBo or Row structures) in the repository, and a creator method for the SyncBo object.
SyncBoDeltaRequest A SyncBoRequest is a request message going to backend, which includes download request and reset request.
SyncBoDeltaRequestFacade SyncBoDeltaRequestFacade provides read- / modification-access to SyncBoDeltaRequest, and provides the "global reset" function.
SyncBoDescriptor A SyncBoDescriptor represents a metadata of a SyncBO.
SyncBoDescriptorFacade This class provides access to the the SyncBoDescriptor objects in the SmartSync client.
SyncBoDescriptorIterator An iterator over a collection SyncBoDescriptor objects.
SyncBoInDelta SyncBoInDelta is used to apply SyncBo delta data from backend to client.
SyncBoInDeltaObserver This interface has to be implemented for any class observing SyncBO inbound delta.
SyncBoList A SyncBoList is a static list of SyncBo entities.
SyncBoOutDelta SyncBoOutDelta is used to update the SyncBo delta data of client to backend server.
SyncBoOutDeltaFacade SyncBoDeltaFacade offers methods to applications in accessing the outbound delta data.
SyncBoOutDeltaNotifier
SyncBoOutDeltaNotifier notifies the registered SyncBoOutDeltaObservers when a SyncBoOutDelta is set to be sent to the server during synchronization i.e. .
SyncBoOutDeltaObserver This interface has to be implemented for any class observing SyncBO outbound delta.
SyncBoResolver SyncBoResolver resolves either the conflict or error to the server or client state.
SyncBoResponse SyncBoRepsonse represents the error/conflict response information, which corresponds to a specific quarantined SyncBo.
SyncBoResponseLog A log holder of the former response that was updated with a new one; holds the SyncBoResponse type, the semantic key and a message string. * The SyncBoResponseLog can be retrieve from the SyncBoResponse
Example: To get the current log

ErrorConflictInbox errorConflictInbox= SmartSyncRuntime.getInstance().getErrorConflictInbox();

//For the all synbo.
SyncReply SyncReply is constructed inside a SyncBoInDeltaData instance, and contains the backend handling status information towards the previous uploaded SyncBoOutDelta.
TimeField TimeField represents the static type of field with java.sql.Time as the underlying data type.
 

Class Summary
BasisFieldType An enumeration of possible basis field types for SmartSync.
DependencyType An enumeration of possible dependencies between SyncBOs with foreign key relationships.
FieldGroupType The FieldGroupType interface represents the type of fields’ grouping and currently has the following types.
FieldInputQualifyType An enumeration of qualification (permission) types for possible field input.
FixedDecimal Deprecated. since 2.5
GlobalResetProcessing Enumeration of options for application data reset.
MessageReplyType An enumeration of possible SmartSync message reply types.
PositionStatusType An enumeration of possible position status types of SyncBo objects.
ProcessingStatusType An enumeration of possible processing status types of SyncBo objects.
RowChangeActionType This represents the action performed on the row.
SmartSyncJQueryFactory Query factory class for join enabled queries.
SmartSyncRuntime The SmartSyncRuntime class provides the accessor methods to the following SmartSync facade, factory and notifier classes.
StatusType An enumeration of possible status types of the repository objects (SyncBo or Row).
SyncBoChangeActionType Enumeration of action type of SyncBoChange.This describes the action performed on the SyncBo.
SyncBoDeltaRequestType An enumeration of possible delta request types for SyncBoDeltaRequest.This request type is set in the SyncBoDeltaRequestType which is accessed using the SyncBoDeltaRequestFacade.
SyncBoOutDeltaSendType An enumeration of possible SyncBoOutDelta sending type.
SyncBoResetType Deprecated.  
SyncBoResponseType A static enumeration type indicating the quarantine state of the SyncBo instance: either ERROR or CONFLICT Copyright: Copyright (c) 2003 Company: SAP AG
SyncProcessingType An enumeration of the SyncBo's possible processing type.
SyncReplyType An enumeration of possible sync message's reply type.
 

Exception Summary
InvalidDescriptorException Thrown when an application attempts to pass an invalid descriptor, or the descriptor is not available.
ModificationNotAllowedException This exception is thrown when any invalid of illegal update operation is performed on the repository object.
SmartSyncException Smart Sync basic exception, other Smart Sync relating exceptions should be inherited from the exception Copyright: Copyright (c) 2002 Company: SAP AG
 



Copyright © 2003 SAP AG. All Rights Reserved.