com.actuate.activeportal.forms
Class SubscribeChannelActionForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by com.actuate.activeportal.forms.BaseActionForm
          extended by com.actuate.activeportal.forms.GeneralFilterActionForm
              extended by com.actuate.activeportal.forms.SubscribeChannelActionForm
All Implemented Interfaces:
IContentList, java.io.Serializable

public class SubscribeChannelActionForm
extends GeneralFilterActionForm
implements IContentList

The form contains list of (un)subscribed channels available to the login user.

-The action classes use the setter methods to set channel list.
-The JSP pages use the getter method to get the channel list.

See Also:
Serialized Form

Constructor Summary
SubscribeChannelActionForm()
           
 
Method Summary
 void clear()
           
 java.lang.Object[] getArray(java.lang.String _categoryName)
           This method should return the list of objects whose properties are to be displayed.
 java.util.Vector getAvailableChannels()
          Gets the list of available channels for the user.
 java.lang.String[] getCategories()
           This method is used by the categories view to retrieve the list of categories it is supposed to display.
 java.lang.String getCheckboxlist()
          Gets the list of items
 java.util.Collection getCollection(java.lang.String _categoryName)
           This method should return the list of objects whose properties are to be displayed.
 java.lang.String getSubmitState()
          Gets the submitState
 boolean isEmpty()
          This method is called by the views to determine whether the list is empty.
 void setAvailableChannels(java.util.Vector vector)
          Sets the list of available channels.
 void setCheckboxlist(java.lang.String string)
          Sets the checkbox list.
 void setSubmitState(java.lang.String string)
          Sets the submit state.
 
Methods inherited from class com.actuate.activeportal.forms.GeneralFilterActionForm
getCompletedFilter, getFilter, getPendingFilter, getRunningFilter, getScheduledFilter, getWaitingFilter, isApplyFilter, isCbFail, isCbSuccess, isFilterEnabled, isOnlyLatest, isResetFilter, isShowDocuments, isShowExecutables, isShowFolders, reset, setApplyFilter, setCbFail, setCbSuccess, setCompletedFilter, setFilter, setFilterEnabled, setOnlyLatest, setPendingFilter, setResetFilter, setRunningFilter, setScheduledFilter, setShowDocuments, setShowExecutables, setShowFolders, setWaitingFilter
 
Methods inherited from class com.actuate.activeportal.forms.BaseActionForm
fixUTF8, isPostback, setPostback
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubscribeChannelActionForm

public SubscribeChannelActionForm()
Method Detail

clear

public void clear()

getAvailableChannels

public java.util.Vector getAvailableChannels()
Gets the list of available channels for the user.


setAvailableChannels

public void setAvailableChannels(java.util.Vector vector)
Sets the list of available channels.


getSubmitState

public java.lang.String getSubmitState()
Gets the submitState


setSubmitState

public void setSubmitState(java.lang.String string)
Sets the submit state.


getCheckboxlist

public java.lang.String getCheckboxlist()
Gets the list of items


setCheckboxlist

public void setCheckboxlist(java.lang.String string)
Sets the checkbox list.


getCategories

public java.lang.String[] getCategories()
Description copied from interface: IContentList

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....

Specified by:
getCategories in interface IContentList
Returns:
The list of category names

getArray

public java.lang.Object[] getArray(java.lang.String _categoryName)
Description copied from interface: IContentList

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.

Specified by:
getArray in interface IContentList
Parameters:
_categoryName - The category which is being displayed currently
Returns:
The list of objects to display

getCollection

public java.util.Collection getCollection(java.lang.String _categoryName)
Description copied from interface: IContentList

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.

Specified by:
getCollection in interface IContentList
Parameters:
_categoryName - The category which is being displayed currently
Returns:
The collection of objects to display

isEmpty

public boolean isEmpty()
Description copied from interface: IContentList
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

Specified by:
isEmpty in interface IContentList
Returns:
A boolean indicating whether there are any items available to display