com.sap.mdm.data
Class ResultDefinition

java.lang.Object
  extended bycom.sap.mdm.data.ResultDefinition
Direct Known Subclasses:
ResultDefinitionEx

public class ResultDefinition
extends Object

This class is set of result definitions defining structure of the records retrieved from the MDM repository.


Field Summary
static int ALL_FIELDS
          Deprecated. use the same constant in ResultDefinitionExt class
static int DISPLAY_FIELDS
          Deprecated. use the same constant in ResultDefinitionExt class
static int NO_FIELDS
          Deprecated. use the same constant in ResultDefinitionExt class
 
Constructor Summary
ResultDefinition(Id containerId)
          Constructor of a ResultDefinition object with the specified container ID.
ResultDefinition(TableId tableId)
          Constructor of a ResultDefinition object with the specified table ID.
 
Method Summary
 void addSelectField(FieldId fieldId)
          Add field ID to the list of selected fields - fields that should be populated during request evaluation
 void addSelectField(FieldId fieldId, boolean useFilter)
          Enables specifying whether to use a filter when adding a field ID to the list of selected fields - fields that should be populated during request evaluation.
 void addSelectReverseLookup(ReverseLookupId reverseLookupId)
          Add reverse Lookup to the list of selected reverse lookups - reverse lookups that should be populated during request evaluation
 void clearAllSelectFields()
          Clear list of selected fields
 Id getContainerId()
          Returns the ID of a table or tuple to which the result definition applies, either a TableId or a TupleDefinitionId.
 int getCutoffPiority()
          Get priority cutoff - lowest priority to return (1-100).
 int getFieldSelectionType()
          Deprecated. user ResultDefinitionExt.getFieldSelectionType
 SortDefinition getFieldSortingOrder()
          Returns the field sorting order.
 FieldId[] getFilteredFields()
          Returns list of fields that passed the filter.
 HierarchyDisplayMode getHierarchyDisplayMode()
          Returns the hierarchy display mode.
 ReverseLookupId[] getSelectedReverseLookups()
          Returns selected reverse lookups for the result definition.
 FieldId[] getSelectFields()
          Get array of selected fields - fields that should be populated during request evaluation
 TableId getTable()
          Get ID of table that defines a result set
 boolean isFilterQualifiedLinks()
          Specify if the qualified links should be filtered
 boolean isLoadAttributes()
          Specify if the taxonomy attributes should be loaded together with the fields
 boolean isLoadTupleValues()
          Returns true to retrieve tuple values, otherwise false.
 void removeSelectField(FieldId fieldId)
          Remove field ID from the list of selected fields - fields that should be populated during request evaluation
 void removeSelectReverseLookup(ReverseLookupId reverseLookupId)
          Remove reverse Lookup from the list of selected reverse Lookups - reverse lookups that should be populated during request evaluation
 void setCutoffPriority(int cutoffPriority)
          Set priority cutoff - lowest priority to return (1-100).
 void setFieldSelectionType(int selectionType)
          Deprecated. user ResultDefinitionExt.setFieldSelectionType
 void setFieldSortingOrder(SortDefinition sortOrder)
          Sets the field sort order (optional).
 void setFilterQualifiedLinks(boolean isFilterQualifiedLinks)
          Define if the qualified links should be filtered.
 void setHierarchyDisplayMode(HierarchyDisplayMode hierDisplayMode)
          Sets the hierarchy display mode (optional).
 void setIsLoadTupleValues(boolean isLoadTupleValues)
          Specifies if tuple values should be retrieved (optional).
 void setLoadAttributes(boolean isLoadAttributes)
          Specify if the taxonomy attributes should be loaded together with the fields.
 void setSelectedReverseLookups(ReverseLookupId[] reverseLookups)
          Selects reverse lookups for the result definition.
 void setSelectFields(FieldId[] fieldIds)
          Set array of selected fields - fields that should be populated during request evaluation
 
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
Deprecated. use the same constant in ResultDefinitionExt class

See Also:
Constant Field Values

DISPLAY_FIELDS

public static final int DISPLAY_FIELDS
Deprecated. use the same constant in ResultDefinitionExt class

See Also:
Constant Field Values

NO_FIELDS

public static final int NO_FIELDS
Deprecated. use the same constant in ResultDefinitionExt class

See Also:
Constant Field Values
Constructor Detail

ResultDefinition

public ResultDefinition(TableId tableId)
Constructor of a ResultDefinition object with the specified table ID.

Parameters:
tableId - table ID

ResultDefinition

public ResultDefinition(Id containerId)
Constructor of a ResultDefinition object with the specified container ID.

Parameters:
containerId - container ID, which can be either a TableId or a TupleDefinitionId
Since:
7.1 SP 08
Method Detail

getTable

public TableId getTable()
Get ID of table that defines a result set

Returns:
table ID

getContainerId

public Id getContainerId()
Returns the ID of a table or tuple to which the result definition applies, either a TableId or a TupleDefinitionId.

Returns:
the container ID
Since:
7.1 SP08

addSelectField

public void addSelectField(FieldId fieldId)
Add field ID to the list of selected fields - fields that should be populated during request evaluation

Parameters:
fieldId - field ID

addSelectField

public void addSelectField(FieldId fieldId,
                           boolean useFilter)
Enables specifying whether to use a filter when adding a field ID to the list of selected fields - fields that should be populated during request evaluation.

Parameters:
fieldId - field ID
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

getFilteredFields

public FieldId[] getFilteredFields()
Returns list of fields that passed the filter.

Returns:
list of field IDs
Since:
7.1 SP8

removeSelectField

public void removeSelectField(FieldId fieldId)
Remove field ID from the list of selected fields - fields that should be populated during request evaluation

Parameters:
fieldId - field ID

getSelectFields

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

Returns:
array of field IDs that should be populated.

setSelectFields

public void setSelectFields(FieldId[] fieldIds)
Set array of selected fields - fields that should be populated during request evaluation

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

addSelectReverseLookup

public void addSelectReverseLookup(ReverseLookupId reverseLookupId)
Add reverse Lookup to the list of selected reverse lookups - reverse lookups that should be populated during request evaluation

Parameters:
reverseLookupId - reverse Lookup ID

removeSelectReverseLookup

public void removeSelectReverseLookup(ReverseLookupId reverseLookupId)
Remove reverse Lookup from the list of selected reverse Lookups - reverse lookups that should be populated during request evaluation

Parameters:
reverseLookupId - reverse Lookup ID

getSelectedReverseLookups

public ReverseLookupId[] getSelectedReverseLookups()
Returns selected reverse lookups for the result definition.

Returns:
An array of selected reverse lookup IDs
Since:
7.1 SP 08

setSelectedReverseLookups

public void setSelectedReverseLookups(ReverseLookupId[] reverseLookups)
Selects reverse lookups for the result definition.

Parameters:
reverseLookups - An array of reverse lookups
Since:
7.1 SP 08

getFieldSelectionType

public int getFieldSelectionType()
Deprecated. user ResultDefinitionExt.getFieldSelectionType

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

Returns:
type of field selection

setFieldSelectionType

public void setFieldSelectionType(int selectionType)
Deprecated. user ResultDefinitionExt.setFieldSelectionType

Set type of field selection that is used if any select fields were specified (1-ALL_FIELDS; 2-DISPLAY_FIELDS)

Parameters:
selectionType - field selection type

clearAllSelectFields

public void clearAllSelectFields()
Clear list of selected fields


isLoadAttributes

public boolean isLoadAttributes()
Specify if the taxonomy attributes should be loaded together with the fields

Returns:
true if attribute should be loaded, else otherwise

setLoadAttributes

public void setLoadAttributes(boolean isLoadAttributes)
Specify if the taxonomy attributes should be loaded together with the fields.

Parameters:
isLoadAttributes -

getCutoffPiority

public int getCutoffPiority()
Get priority cutoff - lowest priority to return (1-100).

Returns:
priority cutoff

setCutoffPriority

public void setCutoffPriority(int cutoffPriority)
Set priority cutoff - lowest priority to return (1-100).

Parameters:
cutoffPriority - priority cutoff

getFieldSortingOrder

public SortDefinition getFieldSortingOrder()
Returns the field sorting order. The default is no sorting.

Returns:
the field sorting order

setFieldSortingOrder

public void setFieldSortingOrder(SortDefinition sortOrder)
Sets the field sort order (optional). By default, there is no sorting.

Note: If the specified result definition is for a tuple definition, sorting is not supported. The specified sort order is ignored.

Parameters:
sortOrder - the field sort order

isFilterQualifiedLinks

public boolean isFilterQualifiedLinks()
Specify if the qualified links should be filtered

Returns:
true if qualified links should be filtered, else otherwise

setFilterQualifiedLinks

public void setFilterQualifiedLinks(boolean isFilterQualifiedLinks)
Define if the qualified links should be filtered.

Parameters:
isFilterQualifiedLinks - define if the qualified links should be filtered

isLoadTupleValues

public boolean isLoadTupleValues()
Returns true to retrieve tuple values, otherwise false.

Returns:
true to retrieve tuple values, otherwise false
Since:
7.1

setIsLoadTupleValues

public void setIsLoadTupleValues(boolean isLoadTupleValues)
Specifies if tuple values should be retrieved (optional). The default is true.

Parameters:
isLoadTupleValues - true to retrieve tuple values, otherwise false
Since:
7.1

setHierarchyDisplayMode

public void setHierarchyDisplayMode(HierarchyDisplayMode hierDisplayMode)
Sets the hierarchy display mode (optional). By default, unique display value will be displayed.

Parameters:
hierDisplayMode - the hierarchy display mode

getHierarchyDisplayMode

public HierarchyDisplayMode getHierarchyDisplayMode()
Returns the hierarchy display mode. The default is unique display value.

Returns:
the hierarchy display mode


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.