Skip navigation links

waggle.common.modules.conversation.enums
Enum XConversationRole

java.lang.Object
java.lang.Enum<XConversationRole>
waggle.common.modules.conversation.enums.XConversationRole

All Implemented Interfaces:

Serializable, Comparable<XConversationRole>

public enum XConversationRole

extends Enum<XConversationRole>

Conversation Roles.

Conversation Roles are used to define grantable and non-grantable access to Conversations.

Enum Constant Summary

CONTRIBUTOR
Contributor.

DISCOVERER
Discoverer.

HOST
Host.

MANAGER
Manager.

NONE
Remove.

VIEWER
Viewer.

Method Summary

int	getRing() Get the ring level associated with the Role.
boolean	isContributor() Check if this is a Contributor.
boolean	isDiscoverer() Check if this is a Discoverer.
boolean	isGreaterThan(XConversationRole role) Check if this Role is greater than the specified Role.
boolean	isGreaterThanOrEqualTo(XConversationRole role) Check if this Role is greater than or equal to the specified Role.
boolean	isHost() Check if this is a Host.
boolean	isLessThan(XConversationRole role) Check if this Role is less than the specified Role.
boolean	isLessThanOrEqualTo(XConversationRole role) Check if this Role is less than or equal to the specified Role.
boolean	isManager() Check if this is a Manager.
boolean	isNone() Check if this is a Private Viewer.
boolean	isViewer() Check if this is a Viewer.
static XConversationRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static XConversationRole[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final XConversationRole NONE

Remove.

This value is used only in change Conversation membership API to remove members from a Conversation. Members whose role is set to None will be removed from the Conversation.

DISCOVERER

public static final XConversationRole DISCOVERER

Discoverer.

Discoverer is not a grantable role. Conversations can be marked as Discoverable so that any User can access the Conversation as a Discoverer. Discoverers will be granted Viewer access to Conversation.

VIEWER

public static final XConversationRole VIEWER

Viewer.

Viewers have read-only access to a Conversation.

CONTRIBUTOR

public static final XConversationRole CONTRIBUTOR

Contributor.

Contributors can to whatever Viewers can do. They also have write access to the Conversation.

If no Contributor members are defined then all Viewers will be granted the Contributor role.

HOST

public static final XConversationRole HOST

Host.

Hosts can do whatever Contributors can do. They also can administer most Conversation functionality.

If no Host members are defined then all Contributors will be granted the Host role. If there are no Contributors then all Viewers will be granted The Host role.

MANAGER

public static final XConversationRole MANAGER

Manager.

Managers can do whatever Hosts can do. They can also view removed content.

Method Detail

values

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

Returns:

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

valueOf

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

getRing

public final int getRing()

Get the ring level associated with the Role.

Returns:

The ring level associated with the Role.

isLessThan

public final boolean isLessThan(XConversationRole role)

Check if this Role is less than the specified Role.

Parameters:

role - The role to check against.

Returns:

True if this Role is less than the specified Role

isLessThanOrEqualTo

public final boolean isLessThanOrEqualTo(XConversationRole role)

Check if this Role is less than or equal to the specified Role.

Parameters:

role - The role to check against.

Returns:

True if this Role is less than the specified Role

isGreaterThan

public final boolean isGreaterThan(XConversationRole role)

Check if this Role is greater than the specified Role.

Parameters:

role - The role to check against.

Returns:

True if this Role is less than the specified Role

isGreaterThanOrEqualTo

public final boolean isGreaterThanOrEqualTo(XConversationRole role)

Check if this Role is greater than or equal to the specified Role.

Parameters:

role - The role to check against.

Returns:

True if this Role is less than the specified Role

isNone

public final boolean isNone()

Check if this is a Private Viewer.

Returns:

Returns true if this is a private Viewer.

isDiscoverer

public final boolean isDiscoverer()

Check if this is a Discoverer.

Returns:

Returns true if this is a Discoverer.

isViewer

public final boolean isViewer()

Check if this is a Viewer.

Returns:

Returns true if this is a Viewer.

isContributor

public final boolean isContributor()

Check if this is a Contributor.

Returns:

Returns true if this is a Contributor.

isHost

public final boolean isHost()

Check if this is a Host.

Returns:

Returns true if this is a Host.

isManager

public final boolean isManager()

Check if this is a Manager.

Returns:

Returns true if this is a Manager Viewer.

Skip navigation links