oracle.webcenter.portal.runtime.context

Interface URLGenerator

public interface URLGenerator

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateFriendlyPath(ManagedPortalObject object) Generate a friendly URL path for the given object.
java.lang.String	generateGlobalPath(ManagedPortalObject object) Generate a global URL path for the given object.
java.lang.String	generateShortPath(ManagedPortalObject object) Generate a short URL path for the given object.

Method Detail

generateFriendlyPath

java.lang.String generateFriendlyPath(ManagedPortalObject object)

Generate a friendly URL path for the given object. A friendly URL must provide a human reader with a reasonable idea of what the object is that it represents, and should not contain any opaque IDs. It can be longer than the short path, but shouldn???t be any longer than is necessary.

Parameters:

object - the portal object to represent

Returns:

the friendly URL path representing this object

generateShortPath

java.lang.String generateShortPath(ManagedPortalObject object)

Generate a short URL path for the given object. The short URL must represent the object in as short a string as possible. The URL path is only required to identify the object on this portal server instance.

Parameters:

object - the portal object to represent

Returns:

the short URL path representing this object

generateGlobalPath

java.lang.String generateGlobalPath(ManagedPortalObject object)

Generate a global URL path for the given object. The global URL must represent the object in such as way as the path can be used on any portal server instance to represent the same object.

Parameters:

object - the portal object to represent

Returns:

the global URL path representing this object