com.ibm.portal.resolver.friendly
Interface SelectionResult

All Known Implementing Classes:

DefaultSelectionResult

public interface SelectionResult

Captures the result of the friendly selection resolution process.

Since:

6.1.0

See Also:

DefaultSelectionResult

Note:

This interface is designed to be implemented by clients.

Method Summary

java.lang.String	getFriendlyPath() The friendly path or null if no friendly path was set.
java.util.List<ObjectID>	getNodes() The the current node result list
java.lang.String	getPathInfo() The path info or null
void	setFriendlyPath(java.lang.String str) Assigns the friendly path.
void	setNodes(java.util.List<ObjectID> res) assign the result list
void	setPathInfo(java.lang.String str) Assigns the portion of the path, that could not be matched against a friendly URL, i.e.

Method Detail

getFriendlyPath

java.lang.String getFriendlyPath()

The friendly path or null if no friendly path was set. The friendly path is the combination of all path segments that could be decoded.

• for a path "/friendly1/friendly2/unfriendly" the return value would be "/friendly1/friendly2"
• for a path "/unfriendly" the return value would be null
• for a path "/" the return value would be null

Returns:

the friendly path or null

getNodes

java.util.List<ObjectID> getNodes()

The the current node result list

Returns:

list of selection results containing ObjectID elements

getPathInfo

java.lang.String getPathInfo()

The path info or null

Returns:

the path info or null.

setFriendlyPath

void setFriendlyPath(java.lang.String str)

Assigns the friendly path. This is the substring of the path used for parsing that represents the friendly URL match. If no friendly URL could be matched this will be null.

Parameters:

str - the friendly path or null

setNodes

void setNodes(java.util.List<ObjectID> res)

assign the result list

Parameters:

res - current result containing ObjectID elements

setPathInfo

void setPathInfo(java.lang.String str)

Assigns the portion of the path, that could not be matched against a friendly URL, i.e. the remaining path portion. If the friendly URL represents the complete path this will be null

Parameters:

str - the path info or null