oracle.dss.bicontext
Class Privilege

java.lang.Object
  |
  +--oracle.dss.bicontext.Privilege

All Implemented Interfaces:

java.io.Serializable

public class Privilege

extends java.lang.Object

implements java.io.Serializable

Represents the rights that a user has to manipulate a context and the objects that a context contains. You set the privilege for a user in an ACLEntry.

There are five valid privileges:

• List -- The user can list the contents of the folder, but cannot do any other operations.
• Read -- The user can list and read the contents of a folder, but cannot perform any other operations.
• Add Folder -- The user can list and read the contents of a folder, and can create subfolders in the folder. The user cannot store (write) objects in the folder or change privileges.
• Write -- The user can list and read the contents of a folder, and can create subfolders in the folder. The user can also write to the folder, saving objects in it. The only thing that the user cannot do is change the privileges for the folder.
• Full Control -- The user can do everything to the folder and its contents. The user can list contents, read contents, write contents, create subfolders, and can change the privileges for the folder.

A Privilege must be one and only of these types. Each privilege level in the list implies all of the prior privileges. For example, if a user has Write privileges, then the user also has List, Read, and Add Folder privileges.

See Also:

AclEntry, Serialized Form

Field Summary

static Privilege	ADD_FOLDER Privilege: The user can add a subfolder to a folder.
static Privilege	FULL_CONTROL Privilege: The user has full control of the folder.
static Privilege	LIST Privilege: The user can list the contents of a folder.
static Privilege	READ Privilege: The user can read the contents of a folder.
static Privilege	WRITE Privilege: The user can write objects to a folder.

Method Summary

boolean	equals(java.lang.Object obj) Indicates whether the specified object is equivalent to this Privilege.
boolean	implies(Privilege privilege) Indicates whether this Privilege implies the specified Privilege.
java.lang.String	toString() Converts this Privilege to a String.

Methods inherited from class java.lang.Object

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

Field Detail

LIST

public static final Privilege LIST

Privilege: The user can list the contents of a folder. The user cannot perform any other operations on the folder.

READ

public static final Privilege READ

Privilege: The user can read the contents of a folder. The user can also list the contents of the folder. The user cannot write to a folder, create subfolders, or change the privilege for the folder.

ADD_FOLDER

public static final Privilege ADD_FOLDER

Privilege: The user can add a subfolder to a folder. The user can also list and read the contents of the folder. The user cannot write to a folder or change the privilege for the folder.

WRITE

public static final Privilege WRITE

Privilege: The user can write objects to a folder. This privilege also implies list, read, and add folder privileges. The only operation that the user cannot do is change the privilege for the folder.

FULL_CONTROL

public static final Privilege FULL_CONTROL

Privilege: The user has full control of the folder. This privilege all other privileges. In addition, the user can change the privilege for the folder.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Indicates whether the specified object is equivalent to this Privilege.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare with this Privilege.

Returns:

true if obj is equivalent to this Privilege, false if not. This method also returns false if obj is not a privilege.

implies

public boolean implies(Privilege privilege)

Indicates whether this Privilege implies the specified Privilege. If this method returns true, then a user who has this Privilege also has the specified Privilege. For example, if this Privilege is "Read", and the specified Privilege is "List," then this message returns true. A user who has this Privilege can read objects in a context and, by implication, can list the objects in the context.

Parameters:

obj - The Privilege that might be implied by this Privilege.

Returns:

true if this Privilege implies privilege, false if it does not.

toString

public java.lang.String toString()

Converts this Privilege to a String. This method returns a String that identifies the access rights of this Privilege, such as "List" or "Write".

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this Privilege.