com.centrasite.control.adapters.collection
Interface CollectionContext

All Known Implementing Classes:
BaseCollectionContext, FlexLineColumnsCollectionContext

public interface CollectionContext

Interface providing contextual information for ReportCollection instances. Encapsulates convenient methods shared between report collections as well as for executing report commands.


Method Summary
 boolean doClientSideSorting(java.lang.String property)
          Check whether sorting for that column shall be done on the client side
 void executeReportCommand(java.lang.Class commandClass)
          Executes the first report command with the given type.
 void executeReportDefaultCommand()
          Executes the contained report's default command.
 com.centrasite.control.ActionContext getActionContext()
          Retrieves the ActionContext used by the ReportCollection and for executing report commands.
 BaseAdapter getAdapter()
          Retrieves the adapter using the collection.
 com.centrasite.control.ReportInterface getReport()
          Retrieves the ReportInterface.
 ReportCollectionListener getReportCollectionListener()
          Retrieves the ReportCollectionListener.
 com.softwareag.cis.plugin.command.Command getReportCommand(java.lang.Class commandClass)
          Retrieves report command instance from the given type.
 com.centrasite.control.discovery.ServerSideSortingInfo getServerSideSortingInfo()
           
 ToolbarExt getToolbar()
          Return the report toolbar.
 boolean isContextMenuAllowed()
           
 void setActionContext(com.centrasite.control.ActionContext actionContext)
          Sets the ActionContext to be used by the ReportCollection.
 void setReport(com.centrasite.control.ReportInterface report)
          Sets the ReportInterface to be used.
 void setReportCollectionListener(ReportCollectionListener reportCollectionListener)
          Sets the ReportCollectionListener.
 void setServerSideSortingInfo(com.centrasite.control.discovery.ServerSideSortingInfo sortingInfo)
           
 void showPopupMenu(com.softwareag.cis.server.util.TREECollection treecollection)
           
 

Method Detail

getReport

com.centrasite.control.ReportInterface getReport()
Retrieves the ReportInterface.

Returns:
ReportInterface

setReport

void setReport(com.centrasite.control.ReportInterface report)
Sets the ReportInterface to be used.

Parameters:
report -

setReportCollectionListener

void setReportCollectionListener(ReportCollectionListener reportCollectionListener)
Sets the ReportCollectionListener.

Parameters:
reportCollectionListener -

getReportCollectionListener

ReportCollectionListener getReportCollectionListener()
Retrieves the ReportCollectionListener.

Returns:
ReportCollectionListener

executeReportDefaultCommand

void executeReportDefaultCommand()
Executes the contained report's default command. Uses the contained ActionContext.


executeReportCommand

void executeReportCommand(java.lang.Class commandClass)
Executes the first report command with the given type. Uses the contained ActionContext.

Parameters:
commandClass -

getReportCommand

com.softwareag.cis.plugin.command.Command getReportCommand(java.lang.Class commandClass)
Retrieves report command instance from the given type.

Parameters:
commandClass -
Returns:
command

getActionContext

com.centrasite.control.ActionContext getActionContext()
Retrieves the ActionContext used by the ReportCollection and for executing report commands.

Returns:
action context

setActionContext

void setActionContext(com.centrasite.control.ActionContext actionContext)
Sets the ActionContext to be used by the ReportCollection.

Parameters:
actionContext -

getAdapter

BaseAdapter getAdapter()
Retrieves the adapter using the collection.

Returns:
adapter

doClientSideSorting

boolean doClientSideSorting(java.lang.String property)
Check whether sorting for that column shall be done on the client side

Parameters:
property -
Returns:
true if to be sorted on client side

getToolbar

ToolbarExt getToolbar()
Return the report toolbar.

Returns:
Toolbar

isContextMenuAllowed

boolean isContextMenuAllowed()

showPopupMenu

void showPopupMenu(com.softwareag.cis.server.util.TREECollection treecollection)

setServerSideSortingInfo

void setServerSideSortingInfo(com.centrasite.control.discovery.ServerSideSortingInfo sortingInfo)

getServerSideSortingInfo

com.centrasite.control.discovery.ServerSideSortingInfo getServerSideSortingInfo()