com.ibm.workplace.wcm.api
Class PlacementLocation

java.lang.Object
  com.ibm.workplace.wcm.api.PlacementLocation

All Implemented Interfaces:

Location

public class PlacementLocation
extends java.lang.Object
implements Location

Represents a document location used to specify the destination for copy and move operations. The items will be copied or moved according to the specified placement.

Constructor Summary

PlacementLocation(DocumentId targetDocId, Placement placement)
Represents a location for a Placeable document.

Method Summary

Placement	getPlacement()
DocumentId	getTargetDocId()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlacementLocation

public PlacementLocation(DocumentId targetDocId,
                         Placement placement)

Represents a location for a Placeable document. Used to specify the destination for copy and move operations.

If the placement is BEFORE or AFTER, this location will represent a sibling to the targetDocId parameter. If the placement is START or END, this location will represent a child of the targetDocId parameter.

Parameters:

targetDocId - the DocumentId of the parent or sibling, according to the rules stated.

placement - the placement in relation to the targetDocId.

Method Detail

getTargetDocId

public DocumentId getTargetDocId()

Returns:

the target document id

getPlacement

public Placement getPlacement()

Returns:

the placement in relation to the target document