com.sapportals.wcm.repository

Interface IInternalLinkResource

public interface IInternalLinkResource

Extended interface for internal link resources.

Two types of links are supported:

1) static links behave like symbolic links in POSIX: there is no live connection to the link target, links may be relative and may point to non-existing targets.

2) dynamic links can only be created for an existing target resource, and "follow" this target resource automatically upon MOVE/RENAME, and disappear when the target is deleted or moved to a different target repository. Note that in general, dynamic links do not work across repository boundaries.

Copyright (c) SAP AG 2002-2004

Method Summary

IResource	getTargetResource() Gets the link target.
RID	getTargetRID() Gets the link target.
boolean	isDynamic()
boolean	isPermanent()
void	setTargetRID(RID target) Sets the link target.

Method Detail

getTargetResource

IResource getTargetResource()
                            throws ResourceException

Gets the link target.

Note: this information may be non-live.

Returns:

the link target resource (or null when it does not exist)

Throws:

ResourceException - Exception raised in failure situation

getTargetRID

RID getTargetRID()
                 throws ResourceException

Gets the link target.

Note: this information may be non-live.

Returns:

the RID of the link target (or null when it does not exist)

Throws:

ResourceException - Exception raised in failure situation

setTargetRID

void setTargetRID(RID target)
                  throws ResourceException

Sets the link target.

Parameters:

target - targetRID to be set

Throws:

ResourceException - Exception raised in failure situation

isDynamic

boolean isDynamic()
                  throws ResourceException

Returns:

whether the link is dynamic or static

Throws:

ResourceException - Exception raised in failure situation

isPermanent

boolean isPermanent()
                    throws ResourceException

Returns:

whether the redirection is permanent (equivalent to HTTP status 301) or not (302)

Throws:

ResourceException - Exception raised in failure situation

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