com.sap.mdm.extension.data
Class ResultDefinitionEx

java.lang.Object
  extended bycom.sap.mdm.data.ResultDefinition
      extended bycom.sap.mdm.extension.data.ResultDefinitionEx

public class ResultDefinitionEx
extends ResultDefinition


Field Summary
static int ALL_FIELDS
          Constants for field selection type
static int DISPLAY_FIELDS
           
static int NO_FIELDS
           
 
Constructor Summary
ResultDefinitionEx(String containerCode, UserSessionContext userCtx)
          Constructor of a ResultDefinitionEx object with the specified parameters.
 
Method Summary
 void addSelectField(String fieldCode)
          Add field code to the list of selected fields - fields that should be populated during request evaluation
 void addSelectField(String fieldCode, boolean useFilter)
          Enables specifying whether to use a filter when adding a field code to the list of selected fields � fields that should be populated during request evaluation
 String getContainerCode()
          Returns the code of a table or tuple definition to which the result definition applies, either a table code or a tuple definition code.
 int getFieldSelectionType()
          Get type of field selection that is used if any select fields were specified (1-ALL_FIELDS; 2-DISPLAY_FIELDS; 3-NO_FIELDS)
 String[] getSelectFieldCodes()
          Get array of selected fields - fields that should be populated during request evaluation
 FieldId[] getSelectFields()
          Get array of selected fields - fields that should be populated during request evaluation
 String getTableCode()
          Get code of table that defines a result set
 void removeSelectField(String fieldCode)
          Remove field code from the list of selected fields - fields that should be populated during request evaluation
 void setFieldSelectionType(int selectionType)
          Set type of field selection that is used if any select fields were specified (1-ALL_FIELDS; 2-DISPLAY_FIELDS; 3-NO_FIELDS)
 void setSelectFieldCodes(String[] fieldCodes)
          Set array of selected fields - fields that should be populated during request evaluation
 
Methods inherited from class com.sap.mdm.data.ResultDefinition
addSelectField, addSelectField, addSelectReverseLookup, clearAllSelectFields, getContainerId, getCutoffPiority, getFieldSortingOrder, getFilteredFields, getHierarchyDisplayMode, getSelectedReverseLookups, getTable, isFilterQualifiedLinks, isLoadAttributes, isLoadTupleValues, removeSelectField, removeSelectReverseLookup, setCutoffPriority, setFieldSortingOrder, setFilterQualifiedLinks, setHierarchyDisplayMode, setIsLoadTupleValues, setLoadAttributes, setSelectedReverseLookups, setSelectFields
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL_FIELDS

public static final int ALL_FIELDS
Constants for field selection type

See Also:
Constant Field Values

DISPLAY_FIELDS

public static final int DISPLAY_FIELDS
See Also:
Constant Field Values

NO_FIELDS

public static final int NO_FIELDS
See Also:
Constant Field Values
Constructor Detail

ResultDefinitionEx

public ResultDefinitionEx(String containerCode,
                          UserSessionContext userCtx)
Constructor of a ResultDefinitionEx object with the specified parameters.

Parameters:
containerCode - the container code
userCtx - the user context
Method Detail

getTableCode

public String getTableCode()
Get code of table that defines a result set

Returns:
table code

getContainerCode

public String getContainerCode()
Returns the code of a table or tuple definition to which the result definition applies, either a table code or a tuple definition code.

Returns:
The container code
Since:
7.1 SP08

addSelectField

public void addSelectField(String fieldCode)
Add field code to the list of selected fields - fields that should be populated during request evaluation

Parameters:
fieldCode - field code

addSelectField

public void addSelectField(String fieldCode,
                           boolean useFilter)
Enables specifying whether to use a filter when adding a field code to the list of selected fields � fields that should be populated during request evaluation

Parameters:
fieldCode - field code
useFilter - true to filter tuple values based on the search criteria, false not to filter. It only works when specifying Main table fields filtering
Since:
7.1 SP8

removeSelectField

public void removeSelectField(String fieldCode)
Remove field code from the list of selected fields - fields that should be populated during request evaluation

Parameters:
fieldCode - field code

getSelectFieldCodes

public String[] getSelectFieldCodes()
Get array of selected fields - fields that should be populated during request evaluation

Returns:
array of field IDs that should be populated.

setSelectFieldCodes

public void setSelectFieldCodes(String[] fieldCodes)
Set array of selected fields - fields that should be populated during request evaluation

Parameters:
fieldCodes - array of IDs for all fields that should be selected

getSelectFields

public FieldId[] getSelectFields()
Description copied from class: ResultDefinition
Get array of selected fields - fields that should be populated during request evaluation

Overrides:
getSelectFields in class ResultDefinition
Returns:
array of field IDs that should be populated.

getFieldSelectionType

public int getFieldSelectionType()
Get type of field selection that is used if any select fields were specified (1-ALL_FIELDS; 2-DISPLAY_FIELDS; 3-NO_FIELDS)

Overrides:
getFieldSelectionType in class ResultDefinition
Returns:
type of field selection

setFieldSelectionType

public void setFieldSelectionType(int selectionType)
Set type of field selection that is used if any select fields were specified (1-ALL_FIELDS; 2-DISPLAY_FIELDS; 3-NO_FIELDS)

Overrides:
setFieldSelectionType in class ResultDefinition
Parameters:
selectionType - field selection type


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.