|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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()
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 |
---|
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....
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.
_categoryName
- The category which is being displayed currently
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.
_categoryName
- The category which is being displayed currently
boolean isEmpty()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |