oracle.discussions.sdk
Class TdRole

java.lang.Object
oracle.discussions.sdk.TdRole

public class TdRole

extends java.lang.Object

Enumeration class for the access control role defined in Oracle oracle discussions.

Oracle discussions elements names have been changed in the webui compared to that of sdk portion. The existing names to the new names mapping is as shown.

• Facility - Category
• Board - Forum
• Delete - Hide

Since:

OCS 10.1.1

Field Summary

static int	BOARD_CREATOR
static int	BOARD_MODERATOR
static int	BOARD_READER
static int	BOARD_WRITER
static int	FACILITY_ADMIN
static int	FACILITY_CREATOR
static int	FACILITY_READER
static int	FACILITY_WRITER
static int	GLOBAL_ADMIN
static TdRole	TD_BOARD_CREATOR Represents a forum creator role.
static TdRole	TD_BOARD_MODERATOR Represents a forum moderator role.
static TdRole	TD_BOARD_READER Represents a forum reader role.
static TdRole	TD_BOARD_WRITER Represents a forum writer role.
static TdRole	TD_FACILITY_ADMIN Represents a category admin role.
static TdRole	TD_FACILITY_CREATOR Represents a category creator role.
static TdRole	TD_FACILITY_READER Represents a category reader role.
static TdRole	TD_FACILITY_WRITER Represents a category writer role.
static TdRole	TD_GLOBAL_ADMIN Represents a global admin role.

Method Summary

boolean	equals(java.lang.Object obj) Returns true if and only if the supplied role is the same as the role of this one.
boolean	equalsRole(TdRole tdr) Returns true is the supplied role is equal or super-seeded by the role of this instance.
static TdRole	getTdRole(int iRoleId) Returns a TdRole object corresponding to the integer passed.
boolean	isBoardRole() Returns true if the role is applicable only to Boards and not to Facilities.
boolean	isFacilityRole() Returns true if the role is applicable only to Facilities and not to Boards.
java.lang.Integer	toInteger() Returns an Integer representation of the role.
java.lang.String	toString() Returns a String description of the role.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BOARD_READER

public static final int BOARD_READER

See Also:

Constant Field Values

BOARD_WRITER

public static final int BOARD_WRITER

See Also:

Constant Field Values

BOARD_MODERATOR

public static final int BOARD_MODERATOR

See Also:

Constant Field Values

FACILITY_READER

public static final int FACILITY_READER

See Also:

Constant Field Values

FACILITY_WRITER

public static final int FACILITY_WRITER

See Also:

Constant Field Values

BOARD_CREATOR

public static final int BOARD_CREATOR

See Also:

Constant Field Values

FACILITY_CREATOR

public static final int FACILITY_CREATOR

See Also:

Constant Field Values

FACILITY_ADMIN

public static final int FACILITY_ADMIN

See Also:

Constant Field Values

GLOBAL_ADMIN

public static final int GLOBAL_ADMIN

See Also:

Constant Field Values

TD_BOARD_READER

public static final TdRole TD_BOARD_READER

Represents a forum reader role.

A forum reader can only read messages in that forum.

TD_BOARD_WRITER

public static final TdRole TD_BOARD_WRITER

Represents a forum writer role.

A forum writer can post messages into a forum and can also read messages in that forum.

TD_BOARD_CREATOR

public static final TdRole TD_BOARD_CREATOR

Represents a forum creator role.

A forum can create,delete, change settings, read and write to a forum.

TD_BOARD_MODERATOR

public static final TdRole TD_BOARD_MODERATOR

Represents a forum moderator role.

A forum moderator can change settings, read and write to a forum.

TD_FACILITY_READER

public static final TdRole TD_FACILITY_READER

Represents a category reader role.

A category creator can only browse through that category.

TD_FACILITY_WRITER

public static final TdRole TD_FACILITY_WRITER

Represents a category writer role.

A category writer can create boards, delete boards, change settings of that category.

TD_FACILITY_CREATOR

public static final TdRole TD_FACILITY_CREATOR

Represents a category creator role.

A category creator can create categories, delete categories, create boards, delete boards, change settings of that category.

TD_FACILITY_ADMIN

public static final TdRole TD_FACILITY_ADMIN

Represents a category admin role.

A category admin can do what a category creator can do and additionaly, he can delete that category also.

TD_GLOBAL_ADMIN

public static final TdRole TD_GLOBAL_ADMIN

Represents a global admin role.

A global administrator can do any operation on the system.

Method Detail

getTdRole

public static TdRole getTdRole(int iRoleId)

Returns a TdRole object corresponding to the integer passed. A null value is returned if the integer doesnot match any of the existing roles.

Parameters:

iRoleId - integer value passed

Returns:

TdRole the role object being returned.

equals

public boolean equals(java.lang.Object obj)

Returns true if and only if the supplied role is the same as the role of this one.

Parameters:

obj - the role being compared to another role.

Returns:

boolean condition indicating if the roles are equal.

isFacilityRole

public boolean isFacilityRole()

Returns true if the role is applicable only to Facilities and not to Boards. Global Admin roles will return false.

Returns:

boolean indicating if the current is a role related to discussions facility element.

isBoardRole

public boolean isBoardRole()

Returns true if the role is applicable only to Boards and not to Facilities. Global Admin roles will return false.

Returns:

boolean indicating if the current is a role related to discussions board element.

equalsRole

public boolean equalsRole(TdRole tdr)

Returns true is the supplied role is equal or super-seeded by the role of this instance.

Parameters:

tdr - Tdrole which is being compared to another role.

Returns:

boolean value indicating if the comparison returned an equality or not.

toInteger

public java.lang.Integer toInteger()

Returns an Integer representation of the role. Integer representation should not be used to compare a role to another as roles are hirarchical: use the TdRole.equals method to do so.

Returns:

Integer

toString

public java.lang.String toString()

Returns a String description of the role. String representation should not be used to compare a role to another as roles are hirarchical: use the TdRole.equals method to do so.

Returns:

String