com.sapportals.wcm.service.relation

Class OrderedRelationPosition

java.lang.Object
  com.sapportals.wcm.service.relation.OrderedRelationPosition

All Implemented Interfaces:

IOrderedRelationPosition

public class OrderedRelationPosition
extends Object
implements IOrderedRelationPosition

An implementation for the ordering position for relations.
Not yet supported!

Field Summary

static OrderedRelationPosition	FIRST A position indicating the first entry.
static OrderedRelationPosition	LAST A position indicating the last entry.

Constructor Summary

OrderedRelationPosition()
Default Constructor, same as OrderedRelationPosition(null, OrderPosition.LAST)

OrderedRelationPosition(String relativeID, OrderPosition type)
Constructor.

Method Summary

boolean	equals(Object object)
String	getRelativeID() Get the id of the relation to which this position relates to.
OrderPosition	getType() Get the ordering position type.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

FIRST

public static final OrderedRelationPosition FIRST

A position indicating the first entry.

LAST

public static final OrderedRelationPosition LAST

A position indicating the last entry.

Constructor Detail

OrderedRelationPosition

public OrderedRelationPosition()

Default Constructor, same as OrderedRelationPosition(null, OrderPosition.LAST)

OrderedRelationPosition

public OrderedRelationPosition(String relativeID,
                               OrderPosition type)

Constructor.

Parameters:

relativeID - TBD: Description of the incoming method parameter

type - TBD: Description of the incoming method parameter

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getType

public OrderPosition getType()

Description copied from interface: IOrderedRelationPosition

Get the ordering position type.

Specified by:

getType in interface IOrderedRelationPosition

Returns:

the OrderPosition for this position.

getRelativeID

public String getRelativeID()

Description copied from interface: IOrderedRelationPosition

Get the id of the relation to which this position relates to.

Specified by:

getRelativeID in interface IOrderedRelationPosition

Returns:

the String with the id of the related relation. Can be null if getType() is OrderPosition.FIRST or OrderPosition.LAST .

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM