com.sap.ip.me.api.sync
Interface InboundContainer

Deprecated. Generic sync has been replaced by MBO synchronization. This interface is only there for compatibility issues and will be removed in further releases of SAP NetWeaver Mobile Client

public interface InboundContainer

Respresents data received from backend and related to a particular method.

Author:

SAP

Method Summary

InboundContainerElement[]	getAllElements() Deprecated. Gets all body elements of this inbound conatainer.
java.lang.String	getAncestorContainerId() Deprecated. Returns the identifier of the container which is ancestor for this one.
java.lang.String	getContainerId() Deprecated. Returns the unique identifier of this container.
InboundContainerElement	getElement(java.lang.String fieldName, java.lang.String lineNumber) Deprecated. Gets the element for given field name and line number. This method requires that the whole inbound container has been read into memory. If application does not need all elements at the same time readNextItem should be used.
InboundContainerElement[]	getElementsWithFieldName(java.lang.String fieldName) Deprecated. Gets the elements for the given field name.
java.lang.String	getExecutionDate() Deprecated. Gets the execution date of this inbound container.
java.lang.String	getExecutionTime() Deprecated. Gets the execution time of this inbound container.
java.lang.String	getGenericBody() Deprecated. If this container represents an answer to outbound container with generic body.
java.lang.String	getMethod() Deprecated. Gets the method name which is realted to this inbound container.
java.lang.String	getOwner() Deprecated. Gets the owner of this inbound container.
java.lang.String	getSendDate() Deprecated. Gets the date when this container was send.
java.lang.String	getSendTime() Deprecated. Gets the time time when the container was send.
java.lang.String	getStatus() Deprecated. Gets the status of the corresponding outbound container. Following states can occur: "" - Only acknowledge received container have this state "S" - Container has been executed successfully on middleware / backend "O" - Container will be processed asynchronously on middleware / backend "E" - Processing of container failed.
InboundContainerElement	readNextElement() Deprecated. This method has been introduced to reduce the memory consumption on client while synchronization.

Method Detail

getMethod

java.lang.String getMethod()

Deprecated.

Gets the method name which is realted to this inbound container.

Returns:

The method name

getSendDate

java.lang.String getSendDate()

Deprecated.

Gets the date when this container was send.

Returns:

The send date

getSendTime

java.lang.String getSendTime()

Deprecated.

Gets the time time when the container was send.

Returns:

The send time

getOwner

java.lang.String getOwner()

Deprecated.

Gets the owner of this inbound container.

Returns:

The owners login name or empty string if container is shared.

getStatus

java.lang.String getStatus()

Deprecated.

Gets the status of the corresponding outbound container.
Following states can occur:

• "" - Only acknowledge received container have this state
• "S" - Container has been executed successfully on middleware / backend
• "O" - Container will be processed asynchronously on middleware / backend
• "E" - Processing of container failed. Application has to take care of this situation (notify user, resend container content again). The whole outbound container is contained in this inbound container. Additionally a field RETURN is contained with a description what went wrong and a field SYNCUSER that contains the user who triggered the synchronization.

Returns:

The status of the corresponding outbound container.

getExecutionDate

java.lang.String getExecutionDate()

Deprecated.

Gets the execution date of this inbound container.

Returns:

The execution date.

getExecutionTime

java.lang.String getExecutionTime()

Deprecated.

Gets the execution time of this inbound container.

Returns:

The execution time.

getGenericBody

java.lang.String getGenericBody()

Deprecated.

If this container represents an answer to outbound container with generic body.

Returns:

The generic body value.

getContainerId

java.lang.String getContainerId()

Deprecated.

Returns the unique identifier of this container.

Returns:

The container id.

getAncestorContainerId

java.lang.String getAncestorContainerId()

Deprecated.

Returns the identifier of the container which is ancestor for this one. This attribute will be set by the application on the backend. Returns empty string if the attribute is not set.

Returns:

The container id of the ancestor container.

getAllElements

InboundContainerElement[] getAllElements()

Deprecated.

Gets all body elements of this inbound conatainer. If this method is used the whole data container will be read into memory.
If application does not need all elements at the same time readNextItem should be used.

Returns:

Array of inbound container elements. Method does not return null. If there are no elements an empty array will be returned.

getElementsWithFieldName

InboundContainerElement[] getElementsWithFieldName(java.lang.String fieldName)

Deprecated.

Gets the elements for the given field name.
This method requires that the whole inbound container has been read into memory.
If application does not need all elements at the same time readNextItem should be used.

Parameters:

fieldName - Field name of the elements that should be returned.

Returns:

Array of inbound container elements with field name equal to given field name. The method does not return null. If there are no elements in the container for given field name an empty array will be returned.

getElement

InboundContainerElement getElement(java.lang.String fieldName,
                                   java.lang.String lineNumber)

Deprecated.

Gets the element for given field name and line number.
This method requires that the whole inbound container has been read into memory.
If application does not need all elements at the same time readNextItem should be used.

Parameters:

fieldName - Field name of the container element that should be returned.

lineNumber - Line number of the container element that should be returned.

Returns:

Inbound container element for given field name and line number. Returns null if container does not contain an element with given field name and line number.

readNextElement

InboundContainerElement readNextElement()
                                        throws java.io.IOException

Deprecated.

This method has been introduced to reduce the memory consumption on client while synchronization. The inbound file will not be read completely into memory any more. The inbound file will be read step by step. This method reads the next inbound container element from inbound stream. Application can use this method to iterate over all container elements. Sorting of inbound container elements is not guaranteed. If there are no more inbound container elements null will be returned.

Returns:

null if there are no more inbound container elements. Otherwise the next inbound container element will be returned.

Throws:

java.io.IOException - If inbound stream is corrupted an IOException may occur. Usually this method should not occur.