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

public interface InboundContainer

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

Author:

SAP

Method Summary

InboundContainerElement[]	getAllElements() Gets all body elements of this inbound conatainer
java.lang.String	getAncestorContainerId() Returns the identifier of the container which is ancestor for this one.
java.lang.String	getContainerId() Returns the unique identifier of this container
InboundContainerElement	getElement(java.lang.String fieldName, java.lang.String lineNumber) Gets the element with the given field name and line number
InboundContainerElement[]	getElementsWithFieldName(java.lang.String fieldName) Gets the elements with the given field name
java.lang.String	getExecutionDate() Gets the execution date of this inbound container
java.lang.String	getExecutionTime() Gets the execution time of this inbound container
java.lang.String	getGenericBody() If this container represents an answer to outbound container with generic body
java.lang.String	getMethod() Gets the method name which is realted to this inbound container
java.lang.String	getOwner() Gets the owner of this inbound container.
java.lang.String	getSendDate() Gets the date when this container was send
java.lang.String	getSendTime() Gets the time time when the container was send
java.lang.String	getStatus() Gets the status of this inbound container

Method Detail

getMethod

public java.lang.String getMethod()

Gets the method name which is realted to this inbound container

Returns:

The method name

getSendDate

public java.lang.String getSendDate()

Gets the date when this container was send

Returns:

The send date

getSendTime

public java.lang.String getSendTime()

Gets the time time when the container was send

Returns:

The send time

getOwner

public java.lang.String getOwner()

Gets the owner of this inbound container.

Returns:

The owners login name or empty string if container is shared

getStatus

public java.lang.String getStatus()

Gets the status of this inbound container

Returns:

The status

getExecutionDate

public java.lang.String getExecutionDate()

Gets the execution date of this inbound container

Returns:

The execution date

getExecutionTime

public java.lang.String getExecutionTime()

Gets the execution time of this inbound container

Returns:

The execution time

getGenericBody

public java.lang.String getGenericBody()

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

Returns:

The genericBody value

getContainerId

public java.lang.String getContainerId()

Returns the unique identifier of this container

Returns:

The containerId value

getAncestorContainerId

public java.lang.String getAncestorContainerId()

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

Returns:

The containerId value

getAllElements

public InboundContainerElement[] getAllElements()

Gets all body elements of this inbound conatainer

Returns:

Array of inbound container elements

getElementsWithFieldName

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

Gets the elements with the given field name

Parameters:

fieldName - Name of this element

Returns:

Array of inbound container elements

getElement

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

Gets the element with the given field name and line number

Parameters:

fieldName - Name of this element

lineNumber - Line number

Returns:

Inbound container element