lumis.service.community

Enum CommunityPrivacy

java.lang.Object

java.lang.Enum<CommunityPrivacy>

lumis.service.community.CommunityPrivacy

All Implemented Interfaces:

Serializable, Comparable<CommunityPrivacy>

public enum CommunityPrivacy
extends Enum<CommunityPrivacy>

Types of privacy a community may be of.

Since:

8.0.0

Version:

$Revision: 17049 $ $Date: 2015-03-03 14:26:53 +0000 (Tue, 03 Mar 2015) $

Enum Constant Summary

Enum Constants

Enum Constant and Description
PRIVATE Private privacy indicates that the community cannot be found in global listings and a user can only become a member by being added by a community administrator.
PUBLIC Public privacy indicates that the community can be found in global listings and is available for anyone to become member of automatically.
RESTRICTED Restricted privacy indicates that the community can be found in global listings, but to become a member, the user must first request membership and await it to be approved by a community administrator.

Method Summary

Modifier and Type	Method and Description
static CommunityPrivacy	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommunityPrivacy[]	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

PUBLIC

public static final CommunityPrivacy PUBLIC

Public privacy indicates that the community can be found in global listings and is available for anyone to become member of automatically.

Since:

8.0.0

RESTRICTED

public static final CommunityPrivacy RESTRICTED

Restricted privacy indicates that the community can be found in global listings, but to become a member, the user must first request membership and await it to be approved by a community administrator.

Since:

8.0.0

PRIVATE

public static final CommunityPrivacy PRIVATE

Private privacy indicates that the community cannot be found in global listings and a user can only become a member by being added by a community administrator.

Since:

8.0.0

Method Detail

values

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

Returns:

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

valueOf

public static CommunityPrivacy 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