com.sap.mdm.data
Class ResultDefinition

java.lang.Object
  com.sap.mdm.data.ResultDefinition

Direct Known Subclasses:

ResultDefinitionEx

public class ResultDefinition

extends java.lang.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(TableId tableId)

Method Summary

void	addSelectField(FieldId fieldId) Add field ID to the list of selected fields - fields that should be populated during request evaluation
void	clearAllSelectFields() Clear list of selected fields
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[]	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
void	removeSelectField(FieldId fieldId) Remove field ID from the list of selected fields - fields 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 fieldSorting) Sets the field sorting order (optional).
void	setFilterQualifiedLinks(boolean isFilterQualifiedLinks) Define if the qualified links should be filtered.
void	setLoadAttributes(boolean isLoadAttributes) Specify if the taxonomy attributes should be loaded together with the fields.
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)

Method Detail

getTable

public TableId getTable()

Get ID of table that defines a result set

Returns:

table ID

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

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

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 fieldSorting)

Sets the field sorting order (optional). The default is no sorting.

Parameters:

fieldSorting - the field sorting 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