com.actuate.activeportal.forms
Class ChannelListActionForm

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.ChannelListActionForm
All Implemented Interfaces:
IContentList, java.io.Serializable

public class ChannelListActionForm
extends GeneralFilterActionForm
implements IContentList

This form contains the channel list that the user subscribes to.

See Also:
Serialized Form

Constructor Summary
ChannelListActionForm()
           
 
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.
 int getSecurityIntegrationOption()
          Returns the SecurityIntegrationOption (RSSE) level
 boolean isEmpty()
          This method is called by the views to determine whether the list is empty.
 boolean isShowSubscribedChannelsOnly()
           
 void setChannelList(com.actuate.schemas.Channel[] channels)
          This method is called by the ChannelListAction class to set the list of channels retrieved for the current filter.
 void setSecurityIntegrationOption(int i)
          This method is called by the ChannelListAction class to set the SecurityIntegrationOption (RSSE)
 void setShowSubscribedChannelsOnly(boolean b)
          This method is used to indicate whether all or only the subscribed channels should be retrieved.
 
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

ChannelListActionForm

public ChannelListActionForm()
Method Detail

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
See Also:
IContentList.getCategories()

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
See Also:
IContentList.getArray(java.lang.String)

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
See Also:
IContentList.getCollection(java.lang.String)

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
See Also:
IContentList.isEmpty()

isShowSubscribedChannelsOnly

public boolean isShowSubscribedChannelsOnly()
Returns:
A boolean indicating whether to return only the subscribed channels.

setShowSubscribedChannelsOnly

public void setShowSubscribedChannelsOnly(boolean b)
This method is used to indicate whether all or only the subscribed channels should be retrieved. By default the value is true and only subscribed channels are retrieved. This is used by the ChannelListAction class when retrieving the list of channels

Parameters:
b -

setChannelList

public void setChannelList(com.actuate.schemas.Channel[] channels)
This method is called by the ChannelListAction class to set the list of channels retrieved for the current filter.

Parameters:
channels -

getSecurityIntegrationOption

public int getSecurityIntegrationOption()
Returns the SecurityIntegrationOption (RSSE) level

Returns:
int 0,1 or 2

setSecurityIntegrationOption

public void setSecurityIntegrationOption(int i)
This method is called by the ChannelListAction class to set the SecurityIntegrationOption (RSSE)

Parameters:
i -