com.sap.aii.mapping.value.api

Interface IFResponse


public interface IFResponse

Value mapping result that can consist of several groups of source identifier, source value, target identifier and target value.

Since:
SAP NetWeaver '04

Method Summary
 int countGroups()
          Returns the number of groups that are found.
 int countTargetValues()
          Returns the number of all found target values.
 String[][] getGroupedTargetValues()
          Returns all target values groud by group.
 String getSingleTargetValue()
          Returns one target value of this response.
 IFIdentifier getSourceIdentifier()
          Returns the request identifier for this result.
 String getSourceValue()
          Returns the source value for this request.
 IFIdentifier getTargetIdentifier()
          Returns the target identifier of this result.
 String[] getTargetValues()
          Returns all target values of this result.
 boolean hasTargetValues()
          Return if this result has at least one target value.
 

Method Detail

getSingleTargetValue

String getSingleTargetValue()
Returns one target value of this response.

Returns:
the target value of this response object in case there is a unique one. If no valid target value was found, the method returns null. If there is more than one target value the first one is (randomly) returned. In order to be sure there is a unique target value, use countTargetValues(). In order to avoid a null value use countTargetValues() or hasTargetValues(). If the object contains different groups the value is take randomly from one random group

getTargetValues

String[] getTargetValues()
Returns all target values of this result.

Returns:
all possible target values of this result. without any separating of possible groups

countTargetValues

int countTargetValues()
Returns the number of all found target values.

Returns:
the number of target values that were found. Without any care of possible groups

hasTargetValues

boolean hasTargetValues()
Return if this result has at least one target value.

Returns:
true in case any target values were found, otherwise false.

getSourceIdentifier

IFIdentifier getSourceIdentifier()
Returns the request identifier for this result.

Returns:
request identifier for this result.

getTargetIdentifier

IFIdentifier getTargetIdentifier()
Returns the target identifier of this result.

Returns:
target identifier for this result.

getSourceValue

String getSourceValue()
Returns the source value for this request.

Returns:
source value to this result

getGroupedTargetValues

String[][] getGroupedTargetValues()
Returns all target values groud by group. The frist index is the group the second the value.

Returns:
all possible target values of this result grouped by groups. First index 'groupnr', second 'valuenr'

countGroups

int countGroups()
Returns the number of groups that are found.

Returns:
number of target groups


Copyright 2007 SAP AG Complete Copyright Notice