com.sapportals.wcm.service.relation

Interface IOrderedRelationPosition

All Known Implementing Classes:

OrderedRelationPosition

public interface IOrderedRelationPosition

An ordering position for relations.
Let's assume the relations R1 and R2 belong to the same relation type T and they both have the same source operand S . Furthermore R1 has T1 as target operand while R2 has T2 as target operand. To express that relation R2 should be before R2 (with respect to their common type and source operand), the OrderedRelationPosition for R2 would look like getPosition()=OrderPosition.BEFORE and getRelativeRelationID()="R1" , while the OrderedRelationPosition for R1 would look like getPosition()=OrderPosition.AFTER and getRelativeRelationID()="R2" .

Method Summary

String	getRelativeID() Get the id of the relation to which this position relates to.
OrderPosition	getType() Get the ordering position type.

Method Detail

getType

OrderPosition getType()

Get the ordering position type.

Returns:

the OrderPosition for this position.

getRelativeID

String getRelativeID()

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

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