站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

ComponentURL - JBOSS Portal 2.2 API 英文版文档


org.jboss.portal.server.app
Class ComponentURL

java.lang.Object
  extended byorg.jboss.portal.server.app.ComponentURL

public class ComponentURL
extends java.lang.Object


Field Summary
protected  java.lang.Boolean authenticated
          If it is secure or not.
protected  Mode mode
          The mode.
protected  Parameters parameters
          The target parameters.
protected  java.lang.Boolean secure
          If it is secure or not.
protected  int type
          The url type.
static int TYPE_ACTION
           
static int TYPE_RENDER
           
protected  WindowState windowState
          The window state.
 
Constructor Summary
ComponentURL(ComponentURL url)
          Copy constructor.
ComponentURL(int type, Mode mode, WindowState windowState, Parameters parameters, java.lang.Boolean secure, java.lang.Boolean authenticated)
          Constructor that fully initialize the state of the url.
 
Method Summary
 java.lang.Boolean getAuthenticated()
           
 Mode getMode()
           
 java.lang.String getParameter(java.lang.String name)
           
 Parameters getParameters()
           
 java.lang.Boolean getSecure()
           
 int getType()
           
 WindowState getWindowState()
           
 void setAuthenticated(java.lang.Boolean authenticated)
           
 void setMode(Mode mode)
           
 void setParameter(java.lang.String name, java.lang.String value)
           
 void setSecure(java.lang.Boolean secure)
           
 void setType(int type)
           
 void setWindowState(WindowState windowState)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_ACTION

public static final int TYPE_ACTION
See Also:
Constant Field Values

TYPE_RENDER

public static final int TYPE_RENDER
See Also:
Constant Field Values

type

protected int type
The url type.


mode

protected Mode mode
The mode.


windowState

protected WindowState windowState
The window state.


parameters

protected Parameters parameters
The target parameters.


secure

protected java.lang.Boolean secure
If it is secure or not.


authenticated

protected java.lang.Boolean authenticated
If it is secure or not.

Constructor Detail

ComponentURL

public ComponentURL(int type,
                    Mode mode,
                    WindowState windowState,
                    Parameters parameters,
                    java.lang.Boolean secure,
                    java.lang.Boolean authenticated)
Constructor that fully initialize the state of the url.


ComponentURL

public ComponentURL(ComponentURL url)
             throws java.lang.IllegalArgumentException
Copy constructor.

Throws:
java.lang.IllegalArgumentException - if the url passed in argument is null
Method Detail

getType

public int getType()

setType

public void setType(int type)

getMode

public Mode getMode()

setMode

public void setMode(Mode mode)

getWindowState

public WindowState getWindowState()

setWindowState

public void setWindowState(WindowState windowState)

getSecure

public java.lang.Boolean getSecure()

setSecure

public void setSecure(java.lang.Boolean secure)

getAuthenticated

public java.lang.Boolean getAuthenticated()

setAuthenticated

public void setAuthenticated(java.lang.Boolean authenticated)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
                  throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException - if the url does not have parameters set

getParameter

public java.lang.String getParameter(java.lang.String name)
                              throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException - if the url does not have parameters set

getParameters

public Parameters getParameters()

toString

public java.lang.String toString()