com.sapportals.wcm.control.base

Class Habitat

java.lang.Object
  com.sapportals.wcm.control.base.Habitat

Deprecated. As of NetWeaver 7.1

public final class Habitat
extends Object

Since:

EP5 SP6, EP6 SP1 combines two RID attributes to define the current position of a navigation.

Constructor Summary

Habitat(RID currentRID)
Deprecated. As of NetWeaver 7.1

Habitat(RID currentRID, RID startRID)
Deprecated. As of NetWeaver 7.1

Habitat(RID currentRID, RID startRID, boolean resolveClash)
Deprecated. As of NetWeaver 7.1

Method Summary

RID	ancestor() Deprecated. As of NetWeaver 7.1
RID	current() Deprecated. As of NetWeaver 7.1
static Habitat	fromString(String source) Deprecated. As of NetWeaver 7.1
static Habitat	getHabitat(RID currentRID, RID startRID) Deprecated. As of NetWeaver 7.1
String	toString() Deprecated. As of NetWeaver 7.1
static String	toString(Habitat habitat) Deprecated. As of NetWeaver 7.1

Methods inherited from class java.lang.Object

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

Constructor Detail

Habitat

public Habitat(RID currentRID,
               RID startRID)
        throws InvalidStartUriException

Deprecated. As of NetWeaver 7.1

creates a new Habitat and throws a NullPointerException, if one of the two parameters is null

Parameters:

currentRID - the current position of the browsing window

startRID - the lowest ancestor of the currentRID that is allowed for browsing

Throws:

InvalidStartUriException, - if the given startRID is not an ancestor of the currentRID

InvalidStartUriException

Habitat

public Habitat(RID currentRID,
               RID startRID,
               boolean resolveClash)
        throws InvalidStartUriException

Deprecated. As of NetWeaver 7.1

Throws:

InvalidStartUriException

Habitat

public Habitat(RID currentRID)

Deprecated. As of NetWeaver 7.1

Method Detail

current

public RID current()

Deprecated. As of NetWeaver 7.1

ancestor

public RID ancestor()

Deprecated. As of NetWeaver 7.1

toString

public String toString()

Deprecated. As of NetWeaver 7.1

Overrides:

toString in class Object

getHabitat

public static Habitat getHabitat(RID currentRID,
                                 RID startRID)

Deprecated. As of NetWeaver 7.1

Returns a new Habitat and throws a NullPointerException, if the currentRID parameter is null. If the startRID parameter is null or invalid, a new Habitat will be created, using the default constructor

Parameters:

currentRID -

startRID -

Returns:

a new Habitat.

fromString

public static Habitat fromString(String source)

Deprecated. As of NetWeaver 7.1

toString

public static String toString(Habitat habitat)

Deprecated. As of NetWeaver 7.1

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-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM