com.sap.portal.favorites

Enum IFavorite.Position

java.lang.Object
  extended by java.lang.Enum<IFavorite.Position>
      extended by com.sap.portal.favorites.IFavorite.Position
All Implemented Interfaces:
Serializable, Comparable<IFavorite.Position>
Enclosing interface:
IFavorite

public static enum IFavorite.Position
extends Enum<IFavorite.Position>

Defines the constants indicating where to move a favorite Relevant for favorites whose provider supports ordering (isOrdered() = true)

See Also:
IFavoritesProvider.moveFavorite(com.sap.security.api.IUser, java.lang.String, com.sap.portal.favorites.IFavorite.Position)

Enum Constant Summary
DOWN
          Move the favorite below its current position in the folder
FIRST
          Move the favorite to the first position in the folder
LAST
          Move the favorite to the last position in the folder
UP
          Move the favorite above its current position in the folder
 
Method Summary
static IFavorite.Position valueOf(String name)
          Returns the enum constant of this type with the specified name.
static IFavorite.Position[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

UP

public static final IFavorite.Position UP
Move the favorite above its current position in the folder


DOWN

public static final IFavorite.Position DOWN
Move the favorite below its current position in the folder


FIRST

public static final IFavorite.Position FIRST
Move the favorite to the first position in the folder


LAST

public static final IFavorite.Position LAST
Move the favorite to the last position in the folder

Method Detail

values

public static IFavorite.Position[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (IFavorite.Position c : IFavorite.Position.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static IFavorite.Position valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/navigation/api api EP-PIN


Copyright 2015 SAP AG Complete Copyright Notice