com.sap.ip.me.api.sync
Class OutboundContainerFactory

java.lang.Object
  extended bycom.sap.ip.me.api.sync.OutboundContainerFactory

public abstract class OutboundContainerFactory
extends java.lang.Object


Constructor Summary
OutboundContainerFactory()
           
 
Method Summary
abstract  OutboundContainer createAttachmentOutboundContainer(VisibilityType visibility, java.lang.String method, java.lang.String type, java.lang.String attachmentName, java.lang.String attachment)
          Factory method for AttachmentOutboundContainer object.
abstract  OutboundContainer createAttachmentOutboundContainer(VisibilityType visibility, java.lang.String method, java.lang.String type, java.lang.String attachmentName, java.lang.String attachment, java.lang.String msgType)
          Factory method for AttachmentOutboundContainer object.
abstract  OutboundContainer createAttachmentOutboundContainer(VisibilityType visibility, java.lang.String method, java.lang.String type, java.lang.String attachmentName, java.lang.String attachment, java.lang.String msgIndex, java.lang.String msgType)
          Deprecated. setting message index manualy is supported only in the old protocol version. Since backend 6.20 SP 12 new protocol is supported. In the new synchronization protocol message index will be set by the framework for each container from type outbound and each smart sync container.
 OutboundContainer createOutboundContainer(VisibilityType visibility, java.lang.String method)
          Factory method for OutboundContainer object with type OUTBOUND
abstract  OutboundContainer createOutboundContainer(VisibilityType visibility, java.lang.String method, java.lang.String type)
          Factory method for OutboundContainer object from given type
static OutboundContainerFactory getInstance()
          Gets the one and only instance of the OutboundContainerFactory class
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutboundContainerFactory

public OutboundContainerFactory()
Method Detail

getInstance

public static OutboundContainerFactory getInstance()
Gets the one and only instance of the OutboundContainerFactory class

Returns:
The InboundProcessorRegistry singleton

createOutboundContainer

public OutboundContainer createOutboundContainer(VisibilityType visibility,
                                                 java.lang.String method)
                                          throws SyncException,
                                                 java.lang.IllegalArgumentException
Factory method for OutboundContainer object with type OUTBOUND

Parameters:
method - Method that will be called in the backend
visibility - Description of the Parameter
Throws:
SyncException - Will be throw if given method is not registered
java.lang.IllegalArgumentException - Will be throw if given container type is unknown

createOutboundContainer

public abstract OutboundContainer createOutboundContainer(VisibilityType visibility,
                                                          java.lang.String method,
                                                          java.lang.String type)
                                                   throws SyncException,
                                                          java.lang.IllegalArgumentException
Factory method for OutboundContainer object from given type

Parameters:
method - Method that will be called in the backend
type - Outbound Container type. Possible values are defined in SyncConstants
visibility - Description of the Parameter
Throws:
SyncException - Will be throw if given method is not registered
java.lang.IllegalArgumentException - Will be throw if given container type is unknown
See Also:
com.sap.ip.me.api.sync.SyncConstants

createAttachmentOutboundContainer

public abstract OutboundContainer createAttachmentOutboundContainer(VisibilityType visibility,
                                                                    java.lang.String method,
                                                                    java.lang.String type,
                                                                    java.lang.String attachmentName,
                                                                    java.lang.String attachment)
                                                             throws SyncException,
                                                                    java.lang.IllegalArgumentException
Factory method for AttachmentOutboundContainer object.
After creation each attachment outbound containr will be automaticaly saved to the outbound queue. Changes on this container are not allowed.
The main difference between OutboundContainer and AttachmentOutboundContainer is is the body AttachmentOutboundContainer has no restrictions regarding to to the attachment. Each item in the OutboundContainer is restricted to maximum 252 characters.

Parameters:
method - Method that will be called in the backend
type - Outbound Container type. Possible values are defined in SyncConstants
attachmentName - Name of attachment. Enables identification of different Attachments on the backend
attachment - Container body
Throws:
SyncException - Will be throw if given method is not registered
java.lang.IllegalArgumentException - Will be throw if given container type is unknown
See Also:
com.sap.ip.me.api.sync.SyncConstants

createAttachmentOutboundContainer

public abstract OutboundContainer createAttachmentOutboundContainer(VisibilityType visibility,
                                                                    java.lang.String method,
                                                                    java.lang.String type,
                                                                    java.lang.String attachmentName,
                                                                    java.lang.String attachment,
                                                                    java.lang.String msgIndex,
                                                                    java.lang.String msgType)
                                                             throws SyncException,
                                                                    java.lang.IllegalArgumentException
Deprecated. setting message index manualy is supported only in the old protocol version. Since backend 6.20 SP 12 new protocol is supported. In the new synchronization protocol message index will be set by the framework for each container from type outbound and each smart sync container.

Factory method for AttachmentOutboundContainer object.
After creation each attachment outbound containr will be automaticaly saved to the outbound queue. Changes on this container are not allowed.
The main difference between OutboundContainer and AttachmentOutboundContainer is is the body AttachmentOutboundContainer has no restrictions regarding to to the attachment. Each item in the OutboundContainer is restricted to maximum 252 characters.

Parameters:
method - Method that will be called in the backend
type - Outbound Container type. Possible values are defined in SyncConstants
attachmentName - Name of attachment. Enables identification of different Attachments on the backend
attachment - Container body
msgIndex - Index of this message (Relevant only for SmartSync and in this case for internal use)
msgType - Type of this message (Relevant only for SmartSync and in this case for internal use)
Throws:
SyncException - Will be throw if given method is not registered
java.lang.IllegalArgumentException - Will be throw if given container type is unknown
See Also:
com.sap.ip.me.api.sync.SyncConstants

createAttachmentOutboundContainer

public abstract OutboundContainer createAttachmentOutboundContainer(VisibilityType visibility,
                                                                    java.lang.String method,
                                                                    java.lang.String type,
                                                                    java.lang.String attachmentName,
                                                                    java.lang.String attachment,
                                                                    java.lang.String msgType)
                                                             throws SyncException,
                                                                    java.lang.IllegalArgumentException
Factory method for AttachmentOutboundContainer object.
After creation each attachment outbound containr will be automaticaly saved to the outbound queue. Changes on this container are not allowed.
The main difference between OutboundContainer and AttachmentOutboundContainer is is the body AttachmentOutboundContainer has no restrictions regarding to to the attachment. Each item in the OutboundContainer is restricted to maximum 252 characters.

Parameters:
method - Method that will be called in the backend
type - Outbound Container type. Possible values are defined in SyncConstants
attachmentName - Name of attachment. Enables identification of different Attachments on the backend
attachment - Container body
msgType - Type of this message (Relevant only for SmartSync and in this case for internal use)
Throws:
SyncException - Will be throw if given method is not registered
java.lang.IllegalArgumentException - Will be throw if given container type is unknown
See Also:
com.sap.ip.me.api.sync.SyncConstants


Copyright © 2005 SAP AG. All Rights Reserved.