com.businessobjects.rebean.wi
Class Podium

java.lang.Object
  com.businessobjects.rebean.wi.Podium

All Implemented Interfaces:

EnumItem, java.io.Serializable

public final class Podium
extends java.lang.Object
implements java.io.Serializable, EnumItem

Warning: This class is no longer functional from the SAP BusinessObjects 4.0 release onwards.

The Podium class is used to specify whether a RankCondition returns the top or bottom or percentage ranked values.

For example, when you want to find 5 best customers, you must use Podium.TOP to create your RankCondition. When you want to find first 5 percentage best customers, you must use Podium.TOP_PERCENTAGE to create your RankCondition.

Since:

11.5

See Also:

RankCondition, Query, ObjectQualification, DataSource.isRankConditionSupported(), ConditionContainer.createRankCondition(com.businessobjects.rebean.wi.Podium, int, com.businessobjects.rebean.wi.DataSourceObject, com.businessobjects.rebean.wi.DataSourceObject), Serialized Form

Field Summary

static int	_BOTTOM The int value of BOTTOM.value().
static int	_BOTTOM_PERCENTAGE The int value of BOTTOM_PERCENTAGE.value().
static int	_TOP The int value of TOP.value().
static int	_TOP_PERCENTAGE The int value of TOP_PERCENTAGE.value().
static Podium	BOTTOM Bottom is used to set a RankCondition to return the bottom ranked values.
static Podium	BOTTOM_PERCENTAGE BOTTOM_PERCENTAGE is used to set a RankCondition to return the percentage ranked values from bottom.
static Podium	TOP TOP is used to set a RankCondition to return the top ranked values.
static Podium	TOP_PERCENTAGE TOP_PERCENTAGE is used to set a RankCondition to return the percentage ranked values from top.

Method Summary

static Podium	fromInt(int value) Returns a Podium instance corresponding to the value passed as a parameter.
java.lang.String	toString() Return a String representation of this Podium.
int	value() Return the int value of this Podium.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_TOP

public static final int _TOP

The int value of TOP.value().

See Also:

Constant Field Values

_BOTTOM

public static final int _BOTTOM

The int value of BOTTOM.value().

See Also:

Constant Field Values

_TOP_PERCENTAGE

public static final int _TOP_PERCENTAGE

The int value of TOP_PERCENTAGE.value().

See Also:

Constant Field Values

_BOTTOM_PERCENTAGE

public static final int _BOTTOM_PERCENTAGE

The int value of BOTTOM_PERCENTAGE.value().

See Also:

Constant Field Values

TOP

public static final Podium TOP

TOP is used to set a RankCondition to return the top ranked values.

See Also:

RankCondition.setPodium(com.businessobjects.rebean.wi.Podium), RankCondition.getPodium(), ConditionContainer.createRankCondition(com.businessobjects.rebean.wi.Podium, int, com.businessobjects.rebean.wi.DataSourceObject, com.businessobjects.rebean.wi.DataSourceObject)

BOTTOM

public static final Podium BOTTOM

Bottom is used to set a RankCondition to return the bottom ranked values.

See Also:

RankCondition.setPodium(com.businessobjects.rebean.wi.Podium), RankCondition.getPodium(), ConditionContainer.createRankCondition(com.businessobjects.rebean.wi.Podium, int, com.businessobjects.rebean.wi.DataSourceObject, com.businessobjects.rebean.wi.DataSourceObject)

TOP_PERCENTAGE

public static final Podium TOP_PERCENTAGE

TOP_PERCENTAGE is used to set a RankCondition to return the percentage ranked values from top.

Since:

12.0

See Also:

RankCondition.setPodium(com.businessobjects.rebean.wi.Podium), RankCondition.getPodium(), ConditionContainer.createRankCondition(com.businessobjects.rebean.wi.Podium, int, com.businessobjects.rebean.wi.DataSourceObject, com.businessobjects.rebean.wi.DataSourceObject)

BOTTOM_PERCENTAGE

public static final Podium BOTTOM_PERCENTAGE

BOTTOM_PERCENTAGE is used to set a RankCondition to return the percentage ranked values from bottom.

Since:

12.0

See Also:

RankCondition.setPodium(com.businessobjects.rebean.wi.Podium), RankCondition.getPodium(), ConditionContainer.createRankCondition(com.businessobjects.rebean.wi.Podium, int, com.businessobjects.rebean.wi.DataSourceObject, com.businessobjects.rebean.wi.DataSourceObject)

Method Detail

toString

public java.lang.String toString()

Return a String representation of this Podium.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Podium.

value

public int value()

Return the int value of this Podium.

Specified by:

value in interface EnumItem

Returns:

the int value of this Podium.

fromInt

public static Podium fromInt(int value)

Returns a Podium instance corresponding to the value passed as a parameter.

Parameters:

value - The value to be convert to Podium.

Returns:

A Podium instance corresponding to the value parameter. Returns null when value does not correspond to an existing Podium type.