|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Object
java.lang.Enum<XConversationRole>
waggle.common.modules.conversation.enums.XConversationRole
public 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 |
---|
public static final XConversationRole NONE
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.
public static final XConversationRole 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.
public static final XConversationRole VIEWER
Viewers have read-only access to a Conversation.
public static final XConversationRole 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.
public static final XConversationRole 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.
public static final XConversationRole MANAGER
Managers can do whatever Hosts can do. They can also view removed content.
Method Detail |
---|
public static XConversationRole[] values()
for (XConversationRole c : XConversationRole.values()) System.out.println(c);
public static XConversationRole valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic final int getRing()
public final boolean isLessThan(XConversationRole role)
role
- The role to check against.public final boolean isLessThanOrEqualTo(XConversationRole role)
role
- The role to check against.public final boolean isGreaterThan(XConversationRole role)
role
- The role to check against.public final boolean isGreaterThanOrEqualTo(XConversationRole role)
role
- The role to check against.public final boolean isNone()
public final boolean isDiscoverer()
public final boolean isViewer()
public final boolean isContributor()
public final boolean isHost()
public final boolean isManager()
|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |