com.sapportals.wcm.repository.manager.entrypoints

Interface IEntryPointsProvider

All Known Implementing Classes:

AbstractEntryPointsProvider

public interface IEntryPointsProvider

Functionalities to handle entry points

Field Summary

static String

IVIEW_PARAM_CONTEXT_ID iView parameter that can be retrieved to get the context ID for internal processing

Method Summary

void	addAndRemoveRootEntryPoints(ICollection parentCollection, IEntryPointList entryPoints, DisplayMode displayMode) Handles the already existing list of entry points on the first level of the entry points hierarchy.
IEntryPointList	getEntryPointChildren(ICollection parentCollection, IEntryPoint parentEntryPoint, DisplayMode displayMode) Gets entry points as children for a specific folder inside a entry points hierarchy.
String	getName() Gets the name of the entry points provider
String	getOptionalBundleFile() Gets the optional bundle file.
int	getPriority() Gets the priority of the provider
IPropertyMap	getProperties(IResource resource, IEntryPoint entryPoint, DisplayMode displayMode) Gets properties of an entry point represented by a resource
IProperty	getProperty(IPropertyName propertyName, IResource resource, IEntryPoint entryPoint, DisplayMode displayMode) Gets a property of an entry point represented by a resource
boolean	isActive() Checks if the provider is in state active
void	setOptionalBundleFile(String optionalBundleFile) Sets the optional bundle file.

Field Detail

IVIEW_PARAM_CONTEXT_ID

public static final String IVIEW_PARAM_CONTEXT_ID

iView parameter that can be retrieved to get the context ID for internal processing

See Also:

Constant Field Values

Method Detail

addAndRemoveRootEntryPoints

public void addAndRemoveRootEntryPoints(ICollection parentCollection,
                                        IEntryPointList entryPoints,
                                        DisplayMode displayMode)
                                 throws WcmException

Handles the already existing list of entry points on the first level of the entry points hierarchy. New entry points can be added and entry points of other providers can be removed.

Parameters:

parentCollection - root folder of the entry points repository

entryPoints - entry point list that can be manipulated

displayMode - display mode of the current request

Throws:

WcmException

getEntryPointChildren

public IEntryPointList getEntryPointChildren(ICollection parentCollection,
                                             IEntryPoint parentEntryPoint,
                                             DisplayMode displayMode)
                                      throws WcmException

Gets entry points as children for a specific folder inside a entry points hierarchy. Only the provider that provided the first level entry point of this hierarchy is called.

Parameters:

parentCollection - parent folder inside the entry points repository

parentEntryPoint - parent entry point (also repesented as parent folder)

displayMode - display mode of the current request

Returns:

list of entry points as children of the parent entry point

Throws:

WcmException

getName

public String getName()

Gets the name of the entry points provider

Returns:

provider name

getPriority

public int getPriority()

Gets the priority of the provider

Returns:

provider priority

isActive

public boolean isActive()

Checks if the provider is in state active

Returns:

true if the provider is active

setOptionalBundleFile

public void setOptionalBundleFile(String optionalBundleFile)

Sets the optional bundle file.

Parameters:

optionalBundleFile -

getOptionalBundleFile

public String getOptionalBundleFile()

Gets the optional bundle file.

Returns:

optional bundle file name, if existing

getProperties

public IPropertyMap getProperties(IResource resource,
                                  IEntryPoint entryPoint,
                                  DisplayMode displayMode)
                           throws ResourceException

Gets properties of an entry point represented by a resource

Parameters:

resource - entry point resource

entryPoint - entry point (also repesented as resource)

displayMode - display mode of the current request

Returns:

properties of the entry point

Throws:

ResourceException

getProperty

public IProperty getProperty(IPropertyName propertyName,
                             IResource resource,
                             IEntryPoint entryPoint,
                             DisplayMode displayMode)
                      throws ResourceException

Gets a property of an entry point represented by a resource

Parameters:

propertyName - name of the property

resource - entry point resource

entryPoint - entry point (also repesented as resource)

displayMode - display mode of the current request

Returns:

property of the entry point

Throws:

ResourceException