com.sap.netweaver.bc.rf.common.namespace

Class OrderPosition

java.lang.Object
  com.sap.netweaver.bc.rf.common.namespace.OrderPosition

public class OrderPosition

extends Object

Class describing an order position, that is used to position a child resource below a resource collection.

Field Summary

protected String	referencePointName
protected String	resourceHandleName
protected OrderPositionType	type

Constructor Summary

protected

OrderPosition(OrderPositionType type, String resourceHandleName, String referencePointName) Private general constructor of an order position.

Method Summary

static OrderPosition	createAfterPosition(String resourceHandleName, String referencePointName) Create order position to place the given resource after another resource in the set of children of the resource collection.
static OrderPosition	createBeforePosition(String resourceHandleName, String referencePointName) Create order position to place the given resource before another resource in the set of children of the resource collection.
static OrderPosition	createFirstPosition(String resourceHandleName) Create order position to make the given resource the first resource of the resource collection.
static OrderPosition	createLastPosition(String resourceHandleName) Create order position to make the given resource the last resource of the resource collection.
String	getReferencePointName() Get reference point to which the resource should be aligned according to the order position.
String	getResourceHandleName() Get resource handle of the resource to be reordered.
OrderPositionType	getType() Get order position type of the resource to be reordered.

Methods inherited from class java.lang.Object

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

Field Detail

type

protected OrderPositionType type

resourceHandleName

protected String resourceHandleName

referencePointName

protected String referencePointName

Constructor Detail

OrderPosition

protected OrderPosition(OrderPositionType type,
                        String resourceHandleName,
                        String referencePointName)

Private general constructor of an order position.

Parameters:

type - order position type of the resource to be reordered

resourceHandleName - resource handle of the resource to be reordered

referencePointName - reference point to which the resource should be aligned according to the order position

Method Detail

createFirstPosition

public static OrderPosition createFirstPosition(String resourceHandleName)

Create order position to make the given resource the first resource of the resource collection.

Parameters:

resourceHandleName - resource handle of the resource to be reordered

Returns:

order position for use in a reorder call

createLastPosition

public static OrderPosition createLastPosition(String resourceHandleName)

Create order position to make the given resource the last resource of the resource collection.

Parameters:

resourceHandleName - resource handle of the resource to be reordered

Returns:

order position for use in a reorder call

createBeforePosition

public static OrderPosition createBeforePosition(String resourceHandleName,
                                                 String referencePointName)

Create order position to place the given resource before another resource in the set of children of the resource collection.

Parameters:

resourceHandleName - resource handle of the resource to be reordered

referencePointName - reference point to which the resource should be aligned according to the order position

Returns:

order position for use in a reorder call

createAfterPosition

public static OrderPosition createAfterPosition(String resourceHandleName,
                                                String referencePointName)

Create order position to place the given resource after another resource in the set of children of the resource collection.

Parameters:

resourceHandleName - resource handle of the resource to be reordered

referencePointName - reference point to which the resource should be aligned according to the order position

Returns:

order position for use in a reorder call

getType

public OrderPositionType getType()

Get order position type of the resource to be reordered.

Returns:

order position type of the resource to be reordered

getResourceHandleName

public String getResourceHandleName()

Get resource handle of the resource to be reordered.

Returns:

resource handle of the resource to be reordered

getReferencePointName

public String getReferencePointName()

Get reference point to which the resource should be aligned according to the order position.

Returns:

reference point to which the resource should be aligned according to the order position