oracle.adf.controller.metadata.model
Interface Bookmark

All Superinterfaces:

AdfcNode, IdHolder, NodeHolder, UIInfo

public interface Bookmark
extends UIInfo

Describes how a view should be bookmarked.

Method Summary

boolean	addUrlParameter(UrlParameter parameter) Adds a new url parameter to this bookmark.
java.lang.String	getMethod()
UrlParameter	getUrlParameter(java.lang.String name) Gets the mutable url paramater with a matching name from this bookmark.
java.util.Map<java.lang.String,? extends UrlParameter>	getUrlParameters()
boolean	removeUrlParameter(UrlParameter parameter) Removes this url parameter from the bookmark.
boolean	setMethod(java.lang.String method) Adds a method binding for the application method to this bookmark, or removes if, if the specified value is null.

Methods inherited from interface oracle.adf.controller.metadata.model.UIInfo

getDescription, getDisplayName, getLargeIcon, getSmallIcon, getUIInfo, setDescription, setDisplayName, setLargeIcon, setSmallIcon

Methods inherited from interface oracle.adf.controller.metadata.model.AdfcNode

getParsingContext, validate

Methods inherited from interface oracle.adf.controller.metadata.model.IdHolder

getIdAttribute, setIdAttribute

Methods inherited from interface oracle.adf.controller.metadata.model.NodeHolder

getNode

Method Detail

getUrlParameters

java.util.Map<java.lang.String,? extends UrlParameter> getUrlParameters()

Returns:

the parameters to include in the URL.

getMethod

java.lang.String getMethod()

Returns:

EL expression for the logic to execute when the bookmark is dereferenced or null if no method was specified.

setMethod

boolean setMethod(java.lang.String method)

Adds a method binding for the application method to this bookmark, or removes if, if the specified value is null.

Parameters:

method - an EL method binding expression, or null

Returns:

true, if method was successfully set, false otherwise

getUrlParameter

UrlParameter getUrlParameter(java.lang.String name)

Gets the mutable url paramater with a matching name from this bookmark.

Parameters:

name - url parameter name

Returns:

a mutable url parameter name

addUrlParameter

boolean addUrlParameter(UrlParameter parameter)

Adds a new url parameter to this bookmark.

Parameters:

parameter - new url parameter

Returns:

true, if url paramerer was successfully added, false otherwise

removeUrlParameter

boolean removeUrlParameter(UrlParameter parameter)

Removes this url parameter from the bookmark.

Parameters:

parameter - url parameter to remove

Returns:

true, if url parameter was successfully removed, false otherwise