com.actuate.activeportal.list
Interface IContentList

All Known Implementing Classes:
ChannelListActionForm, FileListActionForm, SearchFilesActionForm, SubscribeChannelActionForm

public interface IContentList

This is the base list interface that is implemented by the File List form. It defines the behaviour of the list page.

For a categorized view, the getCategories method needs to be implemented and the jsp page can call this method to organize the items displayed in the page. Each categorized view can be retrieved by calling getArray() or getCollection()

Author:
Actuate Corporation

Method Summary
 java.lang.Object[] getArray(java.lang.String _categoryName)
           This method should return the list of objects whose properties are to be displayed.
 java.lang.String[] getCategories()
           This method is used by the categories view to retrieve the list of categories it is supposed to display.
 java.util.Collection getCollection(java.lang.String _categoryName)
           This method should return the list of objects whose properties are to be displayed.
 boolean isEmpty()
          This method is called by the views to determine whether the list is empty.
 

Method Detail

getCategories

java.lang.String[] getCategories()

This method is used by the categories view to retrieve the list of categories it is supposed to display.

For e.g.
The file list implementation will return
{folders}
{documents}
{executables}
etc....

Returns:
The list of category names

getArray

java.lang.Object[] getArray(java.lang.String _categoryName)

This method should return the list of objects whose properties are to be displayed.

For e.g. If the file list is being displayed then each object in the array will be an instance of com.actuate.schemas.File
If this method returns null then the getCollection() method will be called.
This method is called with the category name as a parameter. Bear in mind that this can be null if the view is not the category view; in such a case the entire list should normally be returned.

Parameters:
_categoryName - The category which is being displayed currently
Returns:
The list of objects to display

getCollection

java.util.Collection getCollection(java.lang.String _categoryName)

This method should return the list of objects whose properties are to be displayed.

For e.g. If the file list is being displayed then each object in the array will be an instance of com.actuate.schemas.File If this method returns null then the getCollection() method will be called. This method is called with the category name as a parameter. Bear in mind that this can be null if the view is not the category view; in such a case the entire list should normally be returned.

Parameters:
_categoryName - The category which is being displayed currently
Returns:
The collection of objects to display

isEmpty

boolean isEmpty()
This method is called by the views to determine whether the list is empty. The implementing class needs to return a true if there are no items available

Returns:
A boolean indicating whether there are any items available to display