Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.makumba.commons.attributes
Class PageAttributes

    java.lang.Object
      org.makumba.commons.attributes.PageAttributes

All Implemented Interfaces:
  Attributes

    public class PageAttributes

extends Object
implements Attributes

Field Summary
`(package private) PageContext` | `pageContext`

Constructor Summary
`PageAttributes(PageContext pageContext)`

Method Summary
`Object` | `checkPageForAttribute(String s)`
`Object` | `getAttribute(String s)` Gets the attribute with the given name.
`static PageAttributes` | `getAttributes(PageContext pc)`
`boolean` | `hasAttribute(String s)` Checks whether an attribute exists
`void` | `removeAttribute(String s)` Removes an attribute
`static void` | `setAttribute(PageContext pc, String var, Object o)`
`Object` | `setAttribute(String s, Object o)` Sets the value of an attribute
`String` | `toString()`

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

Field Detail

### pageContext

    PageContext pageContext

Constructor Detail

### PageAttributes

    PageAttributes(PageContext pageContext)

Method Detail

### getAttributes

    public static PageAttributes getAttributes(PageContext pc)

### setAttribute

    public static void setAttribute(PageContext pc,
                                    String var,
                                    Object o)

### setAttribute

    public Object setAttribute(String s,
                               Object o)
                        throws LogicException

  Description copied from interface: `Attributes`
  Sets the value of an attribute

  Specified by:
    `setAttribute` in interface `Attributes`
  Parameters:
    `s` - the name of the attribute
    `o` - the value of the attribute
  Returns:
    the old value of the attribue, or null if there was none
  Throws:
    `LogicException` - if a business logic problem occured while trying to set the attribute (though at present the BL has no supported way to check that).
  See Also:
    `Attributes.setAttribute(java.lang.String, java.lang.Object)`

### removeAttribute

    public void removeAttribute(String s)
                         throws LogicException

  Description copied from interface: `Attributes`
  Removes an attribute

  Specified by:
    `removeAttribute` in interface `Attributes`
  Parameters:
    `s` - the name of the attribute
  Throws:
    `LogicException` - if a business logic problem occured while trying to remove the attribute
  See Also:
    `Attributes.removeAttribute(java.lang.String)`

### hasAttribute

    public boolean hasAttribute(String s)

  Description copied from interface: `Attributes`
  Checks whether an attribute exists

  Specified by:
    `hasAttribute` in interface `Attributes`
  Parameters:
    `s` - the name of the attribute
  Returns:
    true if the attribute exists, false otherwise.
  See Also:
    `Attributes.hasAttribute(java.lang.String)`

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`
  See Also:
    `Object.toString()`

### getAttribute

    public Object getAttribute(String s)
                        throws LogicException

  Description copied from interface: `Attributes`
  Gets the attribute with the given name.

  Specified by:
    `getAttribute` in interface `Attributes`
  Parameters:
    `s` - the name of the attribute
  Returns:
    the attribute value
  Throws:
    `LogicException` - if a business logic problem occured while trying to determine the attribute
    `AttributeNotFoundException` - if there was no error but the attribute could not be found.
  See Also:
    `Attributes.getAttribute(java.lang.String)`

### checkPageForAttribute

    public Object checkPageForAttribute(String s)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Docs generated on 2009-02-25 14:20