Package com.opentext.livelink.service.docman

Enum RightOperation

java.lang.Object

java.lang.Enum<RightOperation>

com.opentext.livelink.service.docman.RightOperation

All Implemented Interfaces:

IServiceDataObject, java.io.Serializable, java.lang.Comparable<RightOperation>

public enum RightOperation
extends java.lang.Enum<RightOperation>
implements IServiceDataObject, java.io.Serializable

Specifies the type of operation to perform when updating node rights.

Version:

2013-08-26

Enum Constant Summary

Enum Constants

Enum Constant	Description
Add	Add the specified rights to all affected nodes.
AddReplace	Add or replace the specified rights to all affected nodes.
Delete	Delete the specified rights from all affected nodes.
Replace	Replace the specified rights for all affected nodes.

Method Summary

Modifier and Type	Method	Description
static RightOperation	fromString(java.lang.String s)	Returns the enum constant with the specified name.
void	load(com.opentext.api.LLValue value)	Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
com.opentext.api.LLValue	toLLValue()	Serialize an SDO object to an LLValue that can be sent to Livelink.
static RightOperation	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static RightOperation[]	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

Add

public static final RightOperation Add

Add the specified rights to all affected nodes.

AddReplace

public static final RightOperation AddReplace

Add or replace the specified rights to all affected nodes.

Delete

public static final RightOperation Delete

Delete the specified rights from all affected nodes.

Replace

public static final RightOperation Replace

Replace the specified rights for all affected nodes.

Method Detail

values

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

Returns:

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

valueOf

public static RightOperation valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

load

public void load(com.opentext.api.LLValue value)

Description copied from interface: IServiceDataObject

Deserialize an ServiceDataObject from an LLValue that is received from Livelink. The LLValue is an Assoc that contains all of the features of this SDO. These features may refer to other SDOs and contain arrays of primitive values or SDOs. Each referenced SDO, will have its load() method called as well. Note: this is an internal method not meant to be called by clients.

Specified by:

load in interface IServiceDataObject

Parameters:

value - the LLValue containing the data to be loaded

toLLValue

public com.opentext.api.LLValue toLLValue()

Description copied from interface: IServiceDataObject

Serialize an SDO object to an LLValue that can be sent to Livelink. Each feature of the SDO is stored in a key of the LLValue Assoc. Any references to other SDOs cause their toLLValue() method to be called. Note: this is an internal method not meant to be called by clients.

Specified by:

toLLValue in interface IServiceDataObject

Returns:

Returns the LLValue object that represents this SDO

fromString

public static RightOperation fromString(java.lang.String s)

Returns the enum constant with the specified name.