com.sapportals.wcm.repository.manager.entrypoints
Class EntryPoint

[contained in: com.sap.km.cm.repository.manager.par - km.shared.rep.util_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.repository.manager.entrypoints.EntryPoint

All Implemented Interfaces:

IEntryPoint

public class EntryPoint

extends java.lang.Object

implements IEntryPoint

Item within an entry point hierarchy.

Constructor Summary

EntryPoint(java.lang.String id, RID targetRid, LinkType linkType, boolean isCollection, java.lang.String providerName)
Creates a new entry point object that represents a link to another repository.

EntryPoint(java.lang.String id, java.lang.String providerName)
Creates a new entry point object that represents a virtual folder within an entry point hierarchy

Method Summary

java.lang.String	getID() ID of the entry point
java.util.Map	getInternalInfo() Gets additional information about the entry point that has been set by the entry point provider
LinkType	getLinkType() Gets the link type of the entry point.
java.lang.String	getProviderName() Gets the name of the entry point provider that provided this entry point.
RID	getTargetRID() Gets the ID of the target resource where the entry point points to.
boolean	isCollection() Checks if the entry point is a collection (folder)
void	setInternalInfo(java.util.Map internalInfo) Sets additional information for the entry point

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryPoint

public EntryPoint(java.lang.String id,
                  java.lang.String providerName)

Creates a new entry point object that represents a virtual folder within an entry point hierarchy

Parameters:

id - id of the entry point

providerName - name of the entry point provider

EntryPoint

public EntryPoint(java.lang.String id,
                  RID targetRid,
                  LinkType linkType,
                  boolean isCollection,
                  java.lang.String providerName)

Creates a new entry point object that represents a link to another repository. The type of object that is linked can be set by the constructor parameters.

Parameters:

id - id of the entry point

targetRid - resource ID of the target resource

linkType - determines if it is an internal or extneral link (resource ID or URL)

isCollection - determines if the link is a collection or not

providerName - name of the entry point provider

Method Detail

getTargetRID

public RID getTargetRID()

Gets the ID of the target resource where the entry point points to. If entry point is no link (LinkType.NONE), null is returned.

Specified by:

getTargetRID in interface IEntryPoint

Returns:

target resource ID

getProviderName

public java.lang.String getProviderName()

Gets the name of the entry point provider that provided this entry point.

Specified by:

getProviderName in interface IEntryPoint

Returns:

provider name

getLinkType

public LinkType getLinkType()

Gets the link type of the entry point.

Specified by:

getLinkType in interface IEntryPoint

Returns:

link type of the entry point

getID

public java.lang.String getID()

ID of the entry point

Specified by:

getID in interface IEntryPoint

Returns:

ID of the entry point

isCollection

public boolean isCollection()

Checks if the entry point is a collection (folder)

Specified by:

isCollection in interface IEntryPoint

Returns:

true if entry point is a collection

setInternalInfo

public void setInternalInfo(java.util.Map internalInfo)

Sets additional information for the entry point

Specified by:

setInternalInfo in interface IEntryPoint

Parameters:

internalInfo - additional information about the entry point

getInternalInfo

public java.util.Map getInternalInfo()

Gets additional information about the entry point that has been set by the entry point provider

Specified by:

getInternalInfo in interface IEntryPoint

Returns:

additional information for the entry point