|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.sap.mdm.data.ResultDefinition
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 |
public static final int ALL_FIELDS
public static final int DISPLAY_FIELDS
public static final int NO_FIELDS
| Constructor Detail |
public ResultDefinition(TableId tableId)
ResultDefinition object with the specified table ID.
tableId - table IDpublic ResultDefinition(Id containerId)
ResultDefinition object with the specified container ID.
containerId - container ID, which can be either a TableId or a TupleDefinitionId| Method Detail |
public TableId getTable()
public Id getContainerId()
TableId or a TupleDefinitionId.
public void addSelectField(FieldId fieldId)
fieldId - field ID
public void addSelectField(FieldId fieldId,
boolean useFilter)
fieldId - field IDuseFilter - true to filter tuple values based on the search criteria, false not to filter. It only works when specifying Main table fields filteringpublic FieldId[] getFilteredFields()
public void removeSelectField(FieldId fieldId)
fieldId - field IDpublic FieldId[] getSelectFields()
public void setSelectFields(FieldId[] fieldIds)
fieldIds - array of IDs for all fields that should be selectedpublic void addSelectReverseLookup(ReverseLookupId reverseLookupId)
reverseLookupId - reverse Lookup IDpublic void removeSelectReverseLookup(ReverseLookupId reverseLookupId)
reverseLookupId - reverse Lookup IDpublic ReverseLookupId[] getSelectedReverseLookups()
public void setSelectedReverseLookups(ReverseLookupId[] reverseLookups)
reverseLookups - An array of reverse lookupspublic int getFieldSelectionType()
public void setFieldSelectionType(int selectionType)
selectionType - field selection typepublic void clearAllSelectFields()
public boolean isLoadAttributes()
public void setLoadAttributes(boolean isLoadAttributes)
isLoadAttributes - public int getCutoffPiority()
public void setCutoffPriority(int cutoffPriority)
cutoffPriority - priority cutoffpublic SortDefinition getFieldSortingOrder()
public void setFieldSortingOrder(SortDefinition sortOrder)
Note: If the specified result definition is for a tuple definition, sorting is not supported. The specified sort order is ignored.
sortOrder - the field sort orderpublic boolean isFilterQualifiedLinks()
public void setFilterQualifiedLinks(boolean isFilterQualifiedLinks)
isFilterQualifiedLinks - define if the qualified links should be filteredpublic boolean isLoadTupleValues()
true to retrieve tuple values, otherwise false.
true to retrieve tuple values, otherwise falsepublic void setIsLoadTupleValues(boolean isLoadTupleValues)
true.
isLoadTupleValues - true to retrieve tuple values, otherwise falsepublic void setHierarchyDisplayMode(HierarchyDisplayMode hierDisplayMode)
hierDisplayMode - the hierarchy display modepublic HierarchyDisplayMode getHierarchyDisplayMode()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
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.