com.hcl.domino.admin

Enum ServerAdmin.ClusterLookup

java.lang.Object

java.lang.Enum<ServerAdmin.ClusterLookup>

com.hcl.domino.admin.ServerAdmin.ClusterLookup

All Implemented Interfaces:

INumberEnum<Integer>, Serializable, Comparable<ServerAdmin.ClusterLookup>

Enclosing interface:

ServerAdmin

public static enum ServerAdmin.ClusterLookup
extends Enum<ServerAdmin.ClusterLookup>
implements INumberEnum<Integer>

These values are used as input to the ServerAdmin.getServerClusterMates(String, ClusterLookup) function.

When you specify the LOOKUP_NOCACHE value, the call retrieves the input server's cluster member list through a NameLookup on the input server.

The client cluster cache is not used for determining this information.

When you specify the LOOKUP_CACHEONLY value, the call is forced to retrieve the server's cluster member list from the local client cluster cache.

There is no NameLookup performed on the server in this case.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOOKUP_CACHEONLY Instructs the NSGetServerClusterMates function to only use the cluster name cache and restricts lookup to the workstation cache
LOOKUP_NOCACHE Instructs the NSGetServerClusterMates function to not use the cluster name cache and forces a lookup on the target server instead

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Integer	getValue()
static ServerAdmin.ClusterLookup	valueOf(String name) Returns the enum constant of this type with the specified name.
static ServerAdmin.ClusterLookup[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOOKUP_NOCACHE

public static final ServerAdmin.ClusterLookup LOOKUP_NOCACHE

Instructs the NSGetServerClusterMates function to not use the cluster name cache and forces a lookup on the target server instead

LOOKUP_CACHEONLY

public static final ServerAdmin.ClusterLookup LOOKUP_CACHEONLY

Instructs the NSGetServerClusterMates function to only use the cluster name cache and restricts lookup to the workstation cache

Method Detail

values

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

Returns:

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

valueOf

public static ServerAdmin.ClusterLookup 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

getValue

public Integer getValue()

Specified by:

getValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum as a long