Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

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

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar] 
java.lang.Object
  |
  +--com.sap.netweaver.bc.rf.common.namespace.OrderPosition
public class OrderPosition
extends java.lang.Object

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

Field Summary
protected  java.lang.String referencePointName
           
protected  java.lang.String resourceHandleName
           
protected  OrderPositionType type
           
 
Constructor Summary
protected OrderPosition(OrderPositionType type, java.lang.String resourceHandleName, java.lang.String referencePointName)
          Private general constructor of an order position.
 
Method Summary
static OrderPosition createAfterPosition(java.lang.String resourceHandleName, java.lang.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(java.lang.String resourceHandleName, java.lang.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(java.lang.String resourceHandleName)
          Create order position to make the given resource the first resource of the resource collection.
static OrderPosition createLastPosition(java.lang.String resourceHandleName)
          Create order position to make the given resource the last resource of the resource collection.
 java.lang.String getReferencePointName()
          Get reference point to which the resource should be aligned according to the order position.
 java.lang.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 java.lang.String resourceHandleName

referencePointName

protected java.lang.String referencePointName
Constructor Detail

OrderPosition

protected OrderPosition(OrderPositionType type,
                        java.lang.String resourceHandleName,
                        java.lang.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(java.lang.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(java.lang.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(java.lang.String resourceHandleName,
                                                 java.lang.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(java.lang.String resourceHandleName,
                                                java.lang.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 java.lang.String getResourceHandleName()
Get resource handle of the resource to be reordered.
Returns:
resource handle of the resource to be reordered

getReferencePointName

public java.lang.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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.