com.ibm.portal.resolver
Interface Resolved

public interface Resolved

Identification of the result of the resolution process. Implementations will contain sensible defaults for the navigational state that are determined by the calling framework. In particular the empty state is a valid default. The Resolved interface can only be accessed by one thread at a time and must not be passed across thread boundaries.

Since:

6.0.1

Note:

This interface is designed to be implemented by clients.

Method Summary

java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap() Returns a modifiable version of the parameter map that will be passed to the servlet or portlet as request parameters.
StateHolderController	getStateHolderController() Returns the state represented by the resolution result in a modifiable way.
void	setBinding(Binding binding) Sets the requested binding.
void	setProtected(java.lang.Boolean bFlag) Indicates if the resolution result needs to point to the private pages in WP or to the public pages.
void	setSecure(java.lang.Boolean bFlag) Indicates the security setting for this resolution result.

Method Detail

getParameterMap

java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Returns a modifiable version of the parameter map that will be passed to the servlet or portlet as request parameters. If the binding specifies e.g. a POST binding then these parameters will be sent as POST parameters, in case of a GET binding they will be made available as QueryParameters. Note that the visibility of these parameters for portlet follows the standard portlet specification (in particular that query parameters will not be visible to JSR168 portlets unless the portlet is the target of a render request). The parameter map ist of type (String, String[]).

Returns:

the parameter map (never null but potentially empty)

getStateHolderController

StateHolderController getStateHolderController()

Returns the state represented by the resolution result in a modifiable way.

Returns:

Controller to the state, not null.

setBinding

void setBinding(Binding binding)

Sets the requested binding. The implementation of this interface is free to calculate the actual binding in case of conflicting setBinding calls sent by different parties.

Parameters:

binding - requested binding

setProtected

void setProtected(java.lang.Boolean bFlag)

Indicates if the resolution result needs to point to the private pages in WP or to the public pages. If null is passed in then a default will be selected automatically that depends on the current context.

Parameters:

bFlag - Boolean.TRUE, if the resolution result should point to the private area

setSecure

void setSecure(java.lang.Boolean bFlag)

Indicates the security setting for this resolution result. Secure set to Boolean.TRUE indicates that a https connection should be used to represent the result. If null is passed in then a default will be selected automatically that depends on the current context.

Parameters:

bFlag - Boolean.TRUE, if the resolver requests to have a secure connection