com.ibm.portal.cp
Enum Scope

java.lang.Object
  java.lang.Enum<Scope>
      com.ibm.portal.cp.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Scope>

public enum Scope
extends java.lang.Enum<Scope>

The Scope enumeration describes the visibility and type of collaboration of tag spaces or rating spaces. Examples:

• The personal private scope of a tag space addresses only tags that the current user has assigned privately.
• The personal public scope of a tag space addresses only tags that the current user has assigned publicly.
• The community scope of a tag space addresses all publicly assigned tags of all users except the current user. This means that the current user never is part of the community in this point of view.

Since:

7.0.0

See Also:

for constants of query parameter keys and values of the scope enumeration.

Enum Constant Summary

COMMUNITY
The community scope.

PERSONAL_PRIVATE
The personal private scope.

PERSONAL_PUBLIC
The personal public scope.

Method Summary

static Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Scope[]	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

COMMUNITY

public static final Scope COMMUNITY

The community scope.

PERSONAL_PUBLIC

public static final Scope PERSONAL_PUBLIC

The personal public scope.

PERSONAL_PRIVATE

public static final Scope PERSONAL_PRIVATE

The personal private scope.

Method Detail

values

public static Scope[] 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 (Scope c : Scope.values())
    System.out.println(c);

Returns:

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

valueOf

public static Scope valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null