Oracle Fusion Middleware Design Time Java API Reference for Oracle ADF Faces and Data Visualization Components
11g Release 2 (11.1.2.0.0)

E18581-01

oracle.adf.view.rich.dt.param
Class PageUsageParameters

java.lang.Object
  extended by oracle.adf.view.rich.dt.param.PageUsageParameters

public class PageUsageParameters
extends java.lang.Object


Constructor Summary
PageUsageParameters(oracle.adfdt.model.objects.PageDefinitionUsage pdUsage)
          Internal use only.
 
Method Summary
 PageUsageParameter addParameter(java.lang.String id, java.lang.String expr)
          Adds a new parameter to the page definition usage.
 PageUsageParameter getParameter(java.lang.String id)
          Fetches the page parameter with the given id.
 java.util.Collection getParameters()
          Retrieves a collection of PageUsageParameters currently contained within the given page definition usage.
 java.lang.String getParameterValue(java.lang.String id)
          Gets the parameter value for the parameter with the given ID.
 void removeParameter(java.lang.String id)
          Removes a parameter from the defined parameters list.
 void setParameterValue(java.lang.String id, java.lang.String expr)
          sets the parameter value for the parameter with the given ID.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageUsageParameters

public PageUsageParameters(oracle.adfdt.model.objects.PageDefinitionUsage pdUsage)
Internal use only.

Method Detail

getParameters

public java.util.Collection getParameters()
Retrieves a collection of PageUsageParameters currently contained within the given page definition usage.

Returns:
Collection of PageUsageParameters

getParameter

public PageUsageParameter getParameter(java.lang.String id)
Fetches the page parameter with the given id.

Parameters:
id - The id of the parameter to fetch.
Returns:
The PageUsageParameter corresponding to the id, or null, if none exists.

addParameter

public PageUsageParameter addParameter(java.lang.String id,
                                       java.lang.String expr)
Adds a new parameter to the page definition usage.

Parameters:
id - ID of the new parameter.
expr - Expression value of the new parameter.

getParameterValue

public java.lang.String getParameterValue(java.lang.String id)
Gets the parameter value for the parameter with the given ID.

Parameters:
id - The id of the parameter to obtain the value.
Returns:
Expression value for the given parameter.

setParameterValue

public void setParameterValue(java.lang.String id,
                              java.lang.String expr)
sets the parameter value for the parameter with the given ID.

Parameters:
id - The id of the parameter to set the value.
expr - Expression value to set.

removeParameter

public void removeParameter(java.lang.String id)
Removes a parameter from the defined parameters list.

Parameters:
id - The ID of the parameter to remove.

Oracle Fusion Middleware Design Time Java API Reference for Oracle ADF Faces and Data Visualization Components
11g Release 2 (11.1.2.0.0)

E18581-01

Copyright © 1997, 2011, Oracle. All rights reserved.