WebSphere Portal: Class PropertyFactory

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

WebSphere Portal 5.0.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.wps.pb.property
Class PropertyFactory

java.lang.Object
  |
  +--com.ibm.wps.pb.property.PropertyFactory

public class PropertyFactory
extends java.lang.Object

A factory class which must be used to create instances of interfaces in the com.ibm.wps.pb.property package.

Method Summary

static Action createAction(PortletSettings settings)
          Create and return an Action object.

static Parameter createParameter(Property property, Action action)
          Create and return a Parameter object associated with the parent action and containing the specified property.

static Property createProperty(PortletSettings settings)
          Create and return a Property object.

static PropertyValue createPropertyValue(Property property, java.lang.Object value)
          Create and return a PropertyValue object encapsulating a property and a value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Summary
`static Action`	`createAction(PortletSettings settings)` Create and return an `Action` object.
`static Parameter`	`createParameter(Property property, Action action)` Create and return a `Parameter` object associated with the parent action and containing the specified property.
`static Property`	`createProperty(PortletSettings settings)` Create and return a `Property` object.
`static PropertyValue`	`createPropertyValue(Property property, java.lang.Object value)` Create and return a `PropertyValue` object encapsulating a property and a value.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

createAction

public static Action createAction(PortletSettings settings)
                           throws InvalidPropertyException

Create and return an Action object. The required fields on the Action must be initialized using setters.

Parameters:: settings - the PortletSettings identifying the caller
Returns:: the Action object
Throws:: InvalidPropertyException - if argument is invalid
See Also:: Action

createProperty

public static Property createProperty(PortletSettings settings)
                               throws InvalidPropertyException

Create and return a Property object. The required fields on the Property must be initialized using setters.

Parameters:: settings - the PortletSettings identifying the caller
Returns:: the Property object
Throws:: InvalidPropertyException - if argument is invalid
See Also:: Property

createParameter

public static Parameter createParameter(Property property,
                                        Action action)
                                 throws InvalidPropertyException

Create and return a Parameter object associated with the parent action and containing the specified property. The required fields on the Parameter must be initialized using setters.

Parameters:: property - the Property identifying the contained property; action - the Action identifying the parent action
Returns:: the Parameter object
Throws:: InvalidPropertyException - if argument is invalid
See Also:: Parameter

createPropertyValue

public static PropertyValue createPropertyValue(Property property,
                                                java.lang.Object value)
                                         throws InvalidPropertyException

Create and return a PropertyValue object encapsulating a property and a value. The value must be an instance of the java class the property is associated with.

Parameters:: property - the Property identifying the contained property; value - the value
Returns:: the PropertyValue object
Throws:: InvalidPropertyException - if argument is invalid
See Also:: PropertyValue