com.ibm.workplace.wcm.api
Enum Placement

java.lang.Object
  java.lang.Enum<Placement>
      com.ibm.workplace.wcm.api.Placement

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Placement>

public enum Placement
extends java.lang.Enum<Placement>

The directive specifying where the destination should be with respect to the selected item. Used in copy and move operations.

Enum Constant Summary

AFTER
Destination is immediately after the selected item

BEFORE
Destination is immediately before the selected item

END
Destination is the last child of the selected parent

START
Destination is the first child of the selected parent

Method Summary

boolean	isRelative() Whether this Placement is relative to another item
static Placement	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Placement[]	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

START

public static final Placement START

Destination is the first child of the selected parent

END

public static final Placement END

Destination is the last child of the selected parent

BEFORE

public static final Placement BEFORE

Destination is immediately before the selected item

AFTER

public static final Placement AFTER

Destination is immediately after the selected item

Method Detail

values

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

Returns:

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

valueOf

public static Placement 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

isRelative

public boolean isRelative()

Whether this Placement is relative to another item

Returns:

True if this Placement is relative to another item, false otherwise