com.sap.sl.sdk.authoring.businesslayer
Interface Filter

All Superinterfaces:
BlItem, Customizable, Identifiable, Inheritable, Nameable
All Known Subinterfaces:
BusinessFilter, NativeRelationalFilter

public interface Filter
extends BlItem

A representation of the model object 'Filter'.

This is the generic object for filters. The present release supports only native, pre-filters for relational business layers.

The following methods allow you to set the filter properties.

The following features are supported:


Method Summary
 boolean isAppliedOnLOV()
          Returns the value of the 'Applied On LOV' attribute.
 boolean isAppliedOnUniverse()
          Returns the value of the 'Applied On Universe' attribute.
 boolean isMandatory()
          Returns the value of the 'Mandatory' attribute.
 void setAppliedOnLOV(boolean value)
          Sets the value of the 'Applied On LOV' attribute.
 void setAppliedOnUniverse(boolean value)
          Sets the value of the 'Applied On Universe' attribute.
 void setMandatory(boolean value)
          Sets the value of the 'Mandatory' attribute.
 
Methods inherited from interface com.sap.sl.sdk.authoring.businesslayer.BlItem
getDescription, getInheritedData, getParent, getPath, getState, setDescription, setState
 
Methods inherited from interface com.sap.sl.sdk.authoring.commons.Identifiable
getIdentifier
 
Methods inherited from interface com.sap.sl.sdk.authoring.commons.Nameable
getName, setName
 
Methods inherited from interface com.sap.sl.sdk.authoring.commons.Customizable
getCustomProperties
 

Method Detail

isMandatory

boolean isMandatory()
Returns the value of the 'Mandatory' attribute.

Checks if the filter is mandatory in the query.

Returns:
the value of the 'Mandatory' attribute.
See Also:
setMandatory(boolean)

setMandatory

void setMandatory(boolean value)
Sets the value of the 'Mandatory' attribute.

Uses the filter as mandatory in the query.

Parameters:
value - the new value of the 'Mandatory' attribute.
See Also:
isMandatory()

isAppliedOnUniverse

boolean isAppliedOnUniverse()
Returns the value of the 'Applied On Universe' attribute.

Checks the filter scope.

Returns:
the value of the 'Applied On Universe' attribute.
See Also:
setAppliedOnUniverse(boolean)

setAppliedOnUniverse

void setAppliedOnUniverse(boolean value)
Sets the value of the 'Applied On Universe' attribute.

Sets the filter scope. The filter applies on the whole business layer if value is true. Otherwise, it only applies on folders.

Parameters:
value - the new value of the 'Applied On Universe' attribute.
See Also:
isAppliedOnUniverse()

isAppliedOnLOV

boolean isAppliedOnLOV()
Returns the value of the 'Applied On LOV' attribute.

Checks if the filter applies on lists of values.

Returns:
the value of the 'Applied On LOV' attribute.
See Also:
setAppliedOnLOV(boolean)

setAppliedOnLOV

void setAppliedOnLOV(boolean value)
Sets the value of the 'Applied On LOV' attribute.

Applies the filter on lists of values if value is true.

Parameters:
value - the new value of the 'Applied On LOV' attribute.
See Also:
isAppliedOnLOV()


© Copyright 2016 SAP SE or an SAP affiliate company. All rights reserved.