AbstractCrudItemBean (josef 3.2.5 API)

java.lang.Object
- org.josef.web.jsf.bean.crud.AbstractCrudItemBean<T>

Type Parameters:

T - The type of the Items to maintain.

All Implemented Interfaces:

Serializable, Observer

Direct Known Subclasses:

AbstractCrudEntityBean
```
public abstract class AbstractCrudItemBean<T extends Serializable>
extends Object
implements Observer, Serializable
```
Super class for JSF Beans that perform CRUD actions (including searching and sorting) on Items.
An item could be a JPA entity but it could also be a POJO. This class has several limitations:
1. The items must be stored in a List (since the ListDataModel is used)
2. A single item must be identifiable by an object ID
Design considerations:
Searching, sorting, selecting an Item and maintaining an Item must work using a single managed bean and a single jsf page.
Both searching/sorting items and maintaining a single Item use a fair amount of member variables. This is why I decided to use two separate inner classes. Since these classes are nested they can easily access all (private) data of this class. The nested classes are not written using inheritance in mind. Instead, every method that is likely to be overridden is a direct member of this class, for example: searchItems(), getSearchCriteria() and sort(). Additionally, all JSF events are a direct member of this class for the same reason.
Version:

1.0 $Revision: 6287 $

Author:

Kees Schotanus

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`AbstractCrudItemBean.DetailItemDelegate` Delegate for the maintenance of a single Item.
`class`	`AbstractCrudItemBean.SearchItemsDelegate` Delegate for searching and sorting of Items.

Constructor Summary

Constructors
Constructor and Description

AbstractCrudItemBean()
Public constructor to make this a bean.

Constructors
Constructor and Description
`AbstractCrudItemBean()` Public constructor to make this a bean.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`backToSearchItemsListener(javax.faces.event.ActionEvent actionEvent)` When moving to the search page from the detail page, perform a search so changes at the item level are reflected at the search level.
`AbstractCrudItemBean.DetailItemDelegate`	`getDetailDelegate()` Gets the delegate responsible for CRUD actions on a single Item.
`protected ItemObservable`	`getItemObservable()` Gets the Observable.
`abstract Class<T>`	`getItemType()` Gets the type of the Item to maintain.
`abstract Searchable`	`getSearchCriteria()` Gets the search criteria.
`AbstractCrudItemBean.SearchItemsDelegate`	`getSearchDelegate()` Gets the delegate responsible for search and sort actions.
`protected javax.faces.event.PhaseListener`	`getSearchModePhaseListener()` PhaseListener that checks the request for "searchMode".
`abstract void`	`merge()` Merges the Item.
`void`	`newItemListener(javax.faces.event.ActionEvent actionEvent)` Creates a new instance of the Item and notifies all observers.
`abstract void`	`persist()` Persists the Item.
`abstract boolean`	`remove()` Removes the current Item.
`void`	`removeItemListener(javax.faces.event.ActionEvent actionEvent)` Removes the Item and performs a new search.
`void`	`resetSearchCriteriaListener(javax.faces.event.ActionEvent actionEvent)` Clears the search criteria by calling the search criteria's reset method.
`abstract List<T>`	`searchItems()` Search for Items.
`void`	`searchItemsListener(javax.faces.event.ActionEvent actionEvent)` Searches for Items.
`abstract T`	`selectItem(Object objectId)` Selects the Item identified by the supplied objectId.
`void`	`selectItemListener(javax.faces.event.ActionEvent actionEvent)` Selects the Item that was selected by the user.
`abstract void`	`sort()` Sorts the Items.
`void`	`submitItemListener(javax.faces.event.ActionEvent actionEvent)` Submits the current Item.
`void`	`update(Observable observable, Object argument)` .

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

- Constructor Detail
  - AbstractCrudItemBean
```
public AbstractCrudItemBean()
```
    Public constructor to make this a bean.
- Method Detail
  - getItemType
```
public abstract Class<T> getItemType()
```
    Gets the type of the Item to maintain.
    
    Returns:
    
    The type of the Item to maintain.
  - getSearchDelegate
```
public AbstractCrudItemBean.SearchItemsDelegate getSearchDelegate()
```
    Gets the delegate responsible for search and sort actions.
    
    Returns:
    
    The delegate responsible for search and sort actions.
  - getDetailDelegate
```
public AbstractCrudItemBean.DetailItemDelegate getDetailDelegate()
```
    Gets the delegate responsible for CRUD actions on a single Item.
    
    Returns:
    
    The delegate responsible for CRUD actions on a single Item.
  - getItemObservable
```
protected ItemObservable getItemObservable()
```
    Gets the Observable.
    
    Returns:
    
    The Observable.
  - searchItems
```
public abstract List<T> searchItems()
```
    Search for Items.
    Searching for Items normally takes the current search and sort criteria into account.
    
    Returns:
    
    The found Items.
  - getSearchCriteria
```
public abstract Searchable getSearchCriteria()
```
    Gets the search criteria.
    
    Returns:
    
    The search criteria.
  - sort
```
public abstract void sort()
```
    Sorts the Items.
  - persist
```
public abstract void persist()
```
    Persists the Item.
    The programmer should set the mode to JsfBeanMode.UPDATE after a successful persist!
  - selectItem
```
public abstract T selectItem(Object objectId)
```
    Selects the Item identified by the supplied objectId.
    Precondition: objectId is not null.
    
    Parameters:
    
    objectId - The object ID of the Item.
    
    Returns:
    
    The Item with the supplied objectId or null when no such Item exists.
  - merge
```
public abstract void merge()
```
    Merges the Item.
  - remove
```
public abstract boolean remove()
```
    Removes the current Item.
    
    Returns:
    
    True when the removal was successful, otherwise false should be returned.
  - searchItemsListener
```
public void searchItemsListener(javax.faces.event.ActionEvent actionEvent)
```
    Searches for Items.
    Clears the current Items, performs a new search and sorts the items.
    
    Parameters:
    
    actionEvent - The ActionEvent.
  - resetSearchCriteriaListener
```
public void resetSearchCriteriaListener(javax.faces.event.ActionEvent actionEvent)
```
    Clears the search criteria by calling the search criteria's reset method.
    
    Parameters:
    
    actionEvent - The ActionEvent.
  - newItemListener
```
public void newItemListener(javax.faces.event.ActionEvent actionEvent)
```
    Creates a new instance of the Item and notifies all observers.
    Postcondition: The mode is changed to JsfBeanMode.NEW.
    Postcondition: A JSF Message is added when for some reason no new instance of the Item at hand could be created.
    
    Parameters:
    
    actionEvent - The ActionEvent.
  - submitItemListener
```
public void submitItemListener(javax.faces.event.ActionEvent actionEvent)
```
    Submits the current Item.
    When the mode is JsfBeanMode.NEW a persist is performed, when the mode is JsfBeanMode.UPDATE a merge is performed. Other modes are simply ignored.
    
    Parameters:
    
    actionEvent - The ActionEvent.
  - backToSearchItemsListener
```
public void backToSearchItemsListener(javax.faces.event.ActionEvent actionEvent)
```
    When moving to the search page from the detail page, perform a search so changes at the item level are reflected at the search level.
    
    Parameters:
    
    actionEvent - The ActionEvent.
    
    See Also:
    
    searchItemsListener(ActionEvent)
  - selectItemListener
```
public void selectItemListener(javax.faces.event.ActionEvent actionEvent)
```
    Selects the Item that was selected by the user.
    Gets the object ID from the supplied actionEvent and notifies all observers.
    Postcondition: The mode is changed to JsfBeanMode.UPDATE.
    Postcondition: A JSF Message is added when no or an invalid object ID exists on the actionEvent or when the Item corresponding to the Object ID could not be found.
    
    Parameters:
    
    actionEvent - The ActionEvent.
    
    Throws:
    
    NullPointerException - When the supplied actionEvent is null.
  - removeItemListener
```
public void removeItemListener(javax.faces.event.ActionEvent actionEvent)
```
    Removes the Item and performs a new search.
    
    Parameters:
    
    actionEvent - The ActionEvent.
  - update
```
public void update(Observable observable,
                   Object argument)
```
    .
    
    Specified by:
    
    update in interface Observer
    
    Parameters:
    
    observable - The observable.
    
    argument - The object ID of the parent or null.
  - getSearchModePhaseListener
```
protected final javax.faces.event.PhaseListener getSearchModePhaseListener()
```
    PhaseListener that checks the request for "searchMode".
    When found the search mode is set to JsfSearchMode.MAINTENANCE.
    This implementation is just a hack. A better solution would be to have the menu item contain an actionListener attribute but currently this causes a page to not appear at all!! (IceFaces 1.8.1)
    
    Returns:
    
    A PhaseListener that checks the request for "searchMode".

Class AbstractCrudItemBean<T extends Serializable>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractCrudItemBean

Method Detail

getItemType

getSearchDelegate

getDetailDelegate

getItemObservable

searchItems

getSearchCriteria

sort

persist

selectItem

merge

remove

searchItemsListener

resetSearchCriteriaListener

newItemListener

submitItemListener

backToSearchItemsListener

selectItemListener

removeItemListener

update

getSearchModePhaseListener