com.centrasite.control
Interface ActionContext

All Superinterfaces:
com.softwareag.cis.plugin.command.context.CommandContext

public interface ActionContext
extends com.softwareag.cis.plugin.command.context.CommandContext

This interface provides context information for an action (command or view) to be executed


Field Summary
 
Fields inherited from interface com.softwareag.cis.plugin.command.context.CommandContext
rcs_id
 
Method Summary
 void addFavoriteToBrowser(java.lang.String title, java.lang.String url)
           
 void browseValue(java.lang.String msg, AbstractPromptCommand cmd, java.lang.String title)
          Prompt for a string value
 void browseValueWithoutPopup(java.lang.String msg, AbstractPromptCommand cmd, java.lang.String title)
          Prompt for a string value whithout open a Popup needed for AddAssetWizard
 void closeView()
           
 void downloadFile(java.lang.String fileName, byte[] content, java.lang.String contentType)
           
 void enableTitleBarCommands(java.lang.String wizardAdapterName)
           
 void execute(com.softwareag.cis.plugin.command.Command command)
           
 void executeAfterSyncOfContentFrame(com.softwareag.cis.plugin.interfaces.RunnableDeferred runnable)
           
 void executeDeferred(com.softwareag.cis.plugin.interfaces.RunnableDeferred runnable)
           
 java.lang.String getApplicationServerUrl()
           
 java.lang.Object getClipBoard()
           
 Connector getConnector()
           
 java.util.Locale getLocale()
          Get locale to be used for strings and messages
 Item getSelectedFavoriteItem()
           
 java.util.Collection getSelectedFavoriteItems()
           
 Item getSelectedItem()
          Get the selected item
 java.util.Collection getSelectedItems()
          Obtain collection of selected items
 java.lang.String getUserAgent()
           
 void itemAddedAsFavorite(Item item)
           
 void itemCreated(Item item)
          Item created.
 void itemDeleted(Item item)
          Item deleted.
 void itemRemovedFromFavorite(Item item)
           
 void itemRenamed(Item item)
          Item renamed.
 void itemsCreated(java.util.Collection items)
           
 void itemsDeleted(java.util.Collection items)
           
 void itemsUpdated(java.util.Collection items)
           
 void itemUpdated(Item item)
          Item updated.
 void messagePopup(java.lang.String message, java.lang.String title)
          Open a popup dialog displaying a message.
 void messagePopup(java.lang.String message, java.lang.String title, boolean useCurrentAdapter)
          Open a popup dialog displaying a message.
 void messagePopup(java.lang.String message, java.lang.String title, boolean useCurrentAdapter, PromptOKHandler okHandler)
          Open a popup dialog displaying a message.
 void openCreateFavoriteDialog()
          Open Create Favorite Dialog.
 void openCreateFavoriteDialog(java.lang.String type)
          Open Create Favorite Dialog.
 void openMultiValueDlg(java.lang.String title, MultipleValueInputActionListener listener, java.util.Iterator displayHeadings, java.util.Iterator methodHeadings, java.util.Collection lineItems, boolean viewToolbarItems, java.lang.Class modeltype)
           
 void openPageInTarget(java.lang.String downloadURL, java.lang.String string)
           
 void openPairInputDialog(java.lang.String title, PairInputListener piListener, java.util.Collection labels, java.util.Collection initialValues)
           
 void openRoleSelectDialog(java.lang.String title, AbstractSingleSelectedItemListener listener)
           
 void openSearchDialog(SelectItemDescriptor sid)
           
 void openSearchDialog(java.lang.String objectType, com.centrasite.jaxr.query.predicates.Predicate[] predicates, java.lang.String title, SelectedItemsListener listener)
           
 void openSearchDialog(java.lang.String objectType, java.lang.String title, SelectedItemsListener listener, ItemFilter itemFilter)
          Deprecated. Please use openSearchDialog(String objectType, Predicate[] predicates, String title, SelectedItemsListener listener)
 void openSearchDialogLayered(java.lang.String objectType, com.centrasite.jaxr.query.predicates.Predicate[] predicates, java.lang.String title, SelectedItemsListener listener)
          Open a search dialog allowing to select instance(s) of given or all object types using layered popUp
 void openUserRoleSelectDialog(java.lang.String title, AbstractSingleSelectedItemListener listener)
           
 void outputMessage(java.lang.String type, java.lang.String shortText)
           
 void promptAttrValue(java.lang.String msg, java.lang.String initialValue, AbstractPromptCommand cmd, java.lang.String title, java.lang.String helpText)
           
 void promptValue(java.lang.String msg, java.lang.String initialValue, AbstractPromptCommand cmd)
          Prompt for a string value
 void promptValue(java.lang.String msg, java.lang.String initialValue, AbstractPromptCommand cmd, java.lang.String title)
          Prompt for a string value
 void promptValue(java.lang.String msg, java.lang.String initialValue, AbstractPromptCommand cmd, java.lang.String title, java.lang.String helpText)
          Prompt for a string value
 void promptValue(java.lang.String msg, java.lang.String initialValue, AbstractPromptCommand cmd, java.lang.String title, java.lang.String helpText, boolean deferExecution)
           
 void promptYesNo(java.lang.String msg, PromptYesNoHandler cmd, java.lang.String title)
          Prompt ok Cancel dailog
 void putClipBoard(java.lang.Object o)
           
 void refresh()
          Refresh current selection (for example after inserting a new child node).
 void refresh(Item item, int change)
           
 void refresh(java.lang.String adapterClassName)
          Refresh all adapters of given class
 void refreshDetailView()
          Refresh detail views after processing commands in tree view
 void refreshTargetFrame(java.lang.String targetFrame)
           
 void refreshTypeList()
          Refresh type list
 void sendError(java.lang.String text)
          Display an error message
 void sendErrorMessage(java.lang.String text)
           
 void sendInfo(java.lang.String text)
           
 void showDetailView(Item item)
           
 void showDetailView(Item item, java.lang.String messageType, java.lang.String message)
           
 void showExternalURL(java.lang.String externalURL, java.lang.String title)
           
 void showExternalURL(java.lang.String externalURL, java.lang.String title, java.lang.String requestHeaderParams)
           
 void showLicenseError()
          Display error message when functionality is not permitted due to license error.
 void showLicenseError(java.lang.String additionalMessage)
          Display error message when functionality is not permitted due to license error.
 void showMenu(java.util.Collection commands)
          Display a menu containing specified commands
 void showMyNotifications(ReportInterface ri)
          Show a report
 void showPage(java.lang.String pageURL, java.lang.String title)
          Open page in workplace
 void showPage(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass)
          Open page in workplace
 void showPage(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass, java.util.Collection initializers)
          Open page in workplace
 void showPage(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass, java.util.Collection initializers, boolean reinit)
          Open page in workplace
 void showPage(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass, java.util.Collection initializers, java.lang.String pageId)
          Open page in workplace.
 void showPage(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass, java.util.Collection initializers, java.lang.String pageId, boolean reinit)
          Open page in workplace.
 void showPagePopUp(java.lang.String pageURL, java.lang.String title)
           
 void showPagePopUp(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass, java.util.Collection<?> initializers, int width, int height, boolean newInstance)
           
 void showPagePopUp(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass, java.util.Collection initializers, int width, int height)
           
 void showPagePopUp(java.lang.String invokingAdapter, java.lang.String pageURL, java.lang.String title, java.lang.String popupAdapterClass, java.util.Collection initializers, int width, int height)
           
 void showPopUp(java.lang.String pageURL, java.lang.String title)
           
 void showPopUp(java.lang.String pageURL, java.lang.String title, java.lang.String adapterClass, java.util.Collection initializers, int width, int height)
           
 void showReport(ReportInterface ri)
          Show a report
 void showReport(ReportInterface ri, java.lang.String pageURL, java.lang.String subClassOfTextGridAdapter)
          Show a report of in the pageURL using the subclass TextGridAdapter
 void showThrowable(java.lang.String title, java.lang.String msg, java.lang.Throwable t)
          Display any Throwable which occured during processing
 void showThrowable(java.lang.Throwable t)
          Display any Throwable which occured during processing
 void uploadFile(IFileUploadListener listener)
           
 void uploadFile(IFileUploadListener listener, java.lang.String title)
           
 
Methods inherited from interface com.softwareag.cis.plugin.command.context.CommandContext
getApplicationContext, getItem, showImageForCommand, showMessage
 

Method Detail

getSelectedItem

Item getSelectedItem()
Get the selected item

Returns:
The item

getSelectedItems

java.util.Collection getSelectedItems()
Obtain collection of selected items

Returns:
a possibly empty collection if Item objects

getSelectedFavoriteItem

Item getSelectedFavoriteItem()

getSelectedFavoriteItems

java.util.Collection getSelectedFavoriteItems()

refresh

void refresh()
Refresh current selection (for example after inserting a new child node).


refresh

void refresh(Item item,
             int change)

refresh

void refresh(java.lang.String adapterClassName)
Refresh all adapters of given class

Parameters:
adapterClassName - fully qualified name of adapter class whose living instances are to be refreshed - must be a subclass of BaseAdapter

getConnector

Connector getConnector()
Returns:
The Connector

sendInfo

void sendInfo(java.lang.String text)
Parameters:
text - Text to display

sendErrorMessage

void sendErrorMessage(java.lang.String text)
Parameters:
text - Text to display

sendError

void sendError(java.lang.String text)
Display an error message

Specified by:
sendError in interface com.softwareag.cis.plugin.command.context.CommandContext
Parameters:
text - Text to display

showThrowable

void showThrowable(java.lang.Throwable t)
Display any Throwable which occured during processing

Specified by:
showThrowable in interface com.softwareag.cis.plugin.command.context.CommandContext
Parameters:
t - the Throwable

showThrowable

void showThrowable(java.lang.String title,
                   java.lang.String msg,
                   java.lang.Throwable t)
Display any Throwable which occured during processing

Specified by:
showThrowable in interface com.softwareag.cis.plugin.command.context.CommandContext
Parameters:
title -
msg -
t - the Throwable

putClipBoard

void putClipBoard(java.lang.Object o)

getClipBoard

java.lang.Object getClipBoard()

showDetailView

void showDetailView(Item item)
Parameters:
item - The Item whose details are to be displayed

showDetailView

void showDetailView(Item item,
                    java.lang.String messageType,
                    java.lang.String message)

refreshDetailView

void refreshDetailView()
Refresh detail views after processing commands in tree view


showExternalURL

void showExternalURL(java.lang.String externalURL,
                     java.lang.String title)
Parameters:
externalURL - The external URL
title - The title

showExternalURL

void showExternalURL(java.lang.String externalURL,
                     java.lang.String title,
                     java.lang.String requestHeaderParams)
Parameters:
externalURL - The external URL
title - The title

showReport

void showReport(ReportInterface ri)
Show a report

Parameters:
ri -

showReport

void showReport(ReportInterface ri,
                java.lang.String pageURL,
                java.lang.String subClassOfTextGridAdapter)
Show a report of in the pageURL using the subclass TextGridAdapter

Parameters:
ri - ReportInterface
pageURL - URL of CIS page to be shown
subClassOfTextGridAdapter - subclass of the TextGridAdapter

showMyNotifications

void showMyNotifications(ReportInterface ri)
Show a report

Parameters:
ri -

showPage

void showPage(java.lang.String pageURL,
              java.lang.String title)
Open page in workplace

Parameters:
pageURL - URL of CIS page to be shown
title - title used to represent activity in workplace

showPage

void showPage(java.lang.String pageURL,
              java.lang.String title,
              java.lang.String adapterClass)
Open page in workplace

Parameters:
pageURL - URL of CIS page to be shown
title - title used to represent activity in workplace
adapterClass - name of adapter class - required to set ActionContext for adapter for new page

showPage

void showPage(java.lang.String pageURL,
              java.lang.String title,
              java.lang.String adapterClass,
              java.util.Collection initializers)
Open page in workplace

Parameters:
pageURL - URL of CIS page to be shown
title - title used to represent activity in workplace
adapterClass - name of adapter class - required to set ActionContext for adapter for new page
initializers - optional initializers for an Adapter implementing the Initializable interface

showPage

void showPage(java.lang.String pageURL,
              java.lang.String title,
              java.lang.String adapterClass,
              java.util.Collection initializers,
              boolean reinit)
Open page in workplace

Parameters:
pageURL - URL of CIS page to be shown
title - title used to represent activity in workplace
adapterClass - name of adapter class - required to set ActionContext for adapter for new page
initializers - optional initializers for an Adapter implementing the Initializable interface
reinit - if true invoke initialize method in any case.

showPage

void showPage(java.lang.String pageURL,
              java.lang.String title,
              java.lang.String adapterClass,
              java.util.Collection initializers,
              java.lang.String pageId)
Open page in workplace. Use this method to start different pages with same title. Use parameter pageId to pass unique identifier.

Parameters:
pageURL - URL of CIS page to be shown
title - title used to represent activity in workplace
adapterClass - name of adapter class - required to set ActionContext for adapter for new page
initializers - optional initializers for an Adapter implementing the Initializable interface
pageId - identififier of page to start.

showPage

void showPage(java.lang.String pageURL,
              java.lang.String title,
              java.lang.String adapterClass,
              java.util.Collection initializers,
              java.lang.String pageId,
              boolean reinit)
Open page in workplace. Use this method to start different pages with same title. Use parameter pageId to pass unique identifier.

Parameters:
pageURL - URL of CIS page to be shown
title - title used to represent activity in workplace
adapterClass - name of adapter class - required to set ActionContext for adapter for new page
initializers - optional initializers for an Adapter implementing the Initializable interface
pageId - identififier of page to start.
reinit - if true invoke initialize method in any case.

promptYesNo

void promptYesNo(java.lang.String msg,
                 PromptYesNoHandler cmd,
                 java.lang.String title)
Prompt ok Cancel dailog

Parameters:
msg -
cmd - PromptYesNoHandler to be executed if prompt is confirmed
title -

messagePopup

void messagePopup(java.lang.String message,
                  java.lang.String title,
                  boolean useCurrentAdapter,
                  PromptOKHandler okHandler)
Open a popup dialog displaying a message.

Parameters:
message - The Message to display.
title - The title for the popup dialog.
useCurrentAdapter - Force to use currently processed adapter.
okHandler - Handler for "OK" being pressed.

messagePopup

void messagePopup(java.lang.String message,
                  java.lang.String title,
                  boolean useCurrentAdapter)
Open a popup dialog displaying a message.

Parameters:
message - The Message to display.
title - The title for the popup dialog.
useCurrentAdapter - Force to use currently processed adapter.

messagePopup

void messagePopup(java.lang.String message,
                  java.lang.String title)
Open a popup dialog displaying a message.

Parameters:
message - The Message to display.
title - The title for the popup dialog.

promptValue

void promptValue(java.lang.String msg,
                 java.lang.String initialValue,
                 AbstractPromptCommand cmd)
Prompt for a string value

Parameters:
msg - Message to display
initialValue -
cmd - The AbstractPromptCommand to be executed

promptValue

void promptValue(java.lang.String msg,
                 java.lang.String initialValue,
                 AbstractPromptCommand cmd,
                 java.lang.String title)
Prompt for a string value

Parameters:
msg - Message to display
initialValue -
cmd - The AbstractPromptCommand to be executed
title - Title for popup dialog

promptValue

void promptValue(java.lang.String msg,
                 java.lang.String initialValue,
                 AbstractPromptCommand cmd,
                 java.lang.String title,
                 java.lang.String helpText)
Prompt for a string value

Parameters:
msg - Message to display
initialValue -
cmd - The AbstractPromptCommand to be executed
title - Title for popup dialog
helpText - Help text for popup dialog

promptValue

void promptValue(java.lang.String msg,
                 java.lang.String initialValue,
                 AbstractPromptCommand cmd,
                 java.lang.String title,
                 java.lang.String helpText,
                 boolean deferExecution)

promptAttrValue

void promptAttrValue(java.lang.String msg,
                     java.lang.String initialValue,
                     AbstractPromptCommand cmd,
                     java.lang.String title,
                     java.lang.String helpText)

browseValue

void browseValue(java.lang.String msg,
                 AbstractPromptCommand cmd,
                 java.lang.String title)
Prompt for a string value

Parameters:
msg - Message to display
cmd - The AbstractPromptCommand to be executed
title - Title for popup dailog

browseValueWithoutPopup

void browseValueWithoutPopup(java.lang.String msg,
                             AbstractPromptCommand cmd,
                             java.lang.String title)
Prompt for a string value whithout open a Popup needed for AddAssetWizard

Parameters:
msg - Message to display
cmd - The AbstractPromptCommand to be executed
title - Title for popup dailog

openSearchDialog

void openSearchDialog(java.lang.String objectType,
                      java.lang.String title,
                      SelectedItemsListener listener,
                      ItemFilter itemFilter)
Deprecated. Please use openSearchDialog(String objectType, Predicate[] predicates, String title, SelectedItemsListener listener)

Open a search dialog allowing to select instance(s) of given or all object types

Parameters:
objectType - use value of object type concept or ObjectTypePredicate.ALL_OBJECT_TYPES
title -
listener -
itemFilter -

openSearchDialog

void openSearchDialog(java.lang.String objectType,
                      com.centrasite.jaxr.query.predicates.Predicate[] predicates,
                      java.lang.String title,
                      SelectedItemsListener listener)

openSearchDialogLayered

void openSearchDialogLayered(java.lang.String objectType,
                             com.centrasite.jaxr.query.predicates.Predicate[] predicates,
                             java.lang.String title,
                             SelectedItemsListener listener)
Open a search dialog allowing to select instance(s) of given or all object types using layered popUp

Parameters:
objectType - use value of object type concept or ObjectTypePredicate.ALL_OBJECT_TYPES
title -
listener -

openPairInputDialog

void openPairInputDialog(java.lang.String title,
                         PairInputListener piListener,
                         java.util.Collection labels,
                         java.util.Collection initialValues)

openCreateFavoriteDialog

void openCreateFavoriteDialog()
Open Create Favorite Dialog.


openCreateFavoriteDialog

void openCreateFavoriteDialog(java.lang.String type)
Open Create Favorite Dialog.

Parameters:
type - of the favourite

openSearchDialog

void openSearchDialog(SelectItemDescriptor sid)
Parameters:
sid -

openMultiValueDlg

void openMultiValueDlg(java.lang.String title,
                       MultipleValueInputActionListener listener,
                       java.util.Iterator displayHeadings,
                       java.util.Iterator methodHeadings,
                       java.util.Collection lineItems,
                       boolean viewToolbarItems,
                       java.lang.Class modeltype)

showPopUp

void showPopUp(java.lang.String pageURL,
               java.lang.String title)

showPopUp

void showPopUp(java.lang.String pageURL,
               java.lang.String title,
               java.lang.String adapterClass,
               java.util.Collection initializers,
               int width,
               int height)

showPagePopUp

void showPagePopUp(java.lang.String pageURL,
                   java.lang.String title)

showPagePopUp

void showPagePopUp(java.lang.String pageURL,
                   java.lang.String title,
                   java.lang.String adapterClass,
                   java.util.Collection initializers,
                   int width,
                   int height)

showPagePopUp

void showPagePopUp(java.lang.String pageURL,
                   java.lang.String title,
                   java.lang.String adapterClass,
                   java.util.Collection<?> initializers,
                   int width,
                   int height,
                   boolean newInstance)

showPagePopUp

void showPagePopUp(java.lang.String invokingAdapter,
                   java.lang.String pageURL,
                   java.lang.String title,
                   java.lang.String popupAdapterClass,
                   java.util.Collection initializers,
                   int width,
                   int height)

showLicenseError

void showLicenseError()
Display error message when functionality is not permitted due to license error.


showLicenseError

void showLicenseError(java.lang.String additionalMessage)
Display error message when functionality is not permitted due to license error.

Parameters:
additionalMessage - an optional supplementary message, may be null

showMenu

void showMenu(java.util.Collection commands)
Display a menu containing specified commands

Parameters:
commands -

openRoleSelectDialog

void openRoleSelectDialog(java.lang.String title,
                          AbstractSingleSelectedItemListener listener)

openUserRoleSelectDialog

void openUserRoleSelectDialog(java.lang.String title,
                              AbstractSingleSelectedItemListener listener)

closeView

void closeView()

itemAddedAsFavorite

void itemAddedAsFavorite(Item item)

itemRemovedFromFavorite

void itemRemovedFromFavorite(Item item)

itemCreated

void itemCreated(Item item)
Item created.


itemsCreated

void itemsCreated(java.util.Collection items)

itemRenamed

void itemRenamed(Item item)
Item renamed.


itemUpdated

void itemUpdated(Item item)
Item updated.


itemsUpdated

void itemsUpdated(java.util.Collection items)

itemDeleted

void itemDeleted(Item item)
Item deleted.


itemsDeleted

void itemsDeleted(java.util.Collection items)

openPageInTarget

void openPageInTarget(java.lang.String downloadURL,
                      java.lang.String string)
Specified by:
openPageInTarget in interface com.softwareag.cis.plugin.command.context.CommandContext
Parameters:
downloadURL -
string -

executeDeferred

void executeDeferred(com.softwareag.cis.plugin.interfaces.RunnableDeferred runnable)
Parameters:
runnable -

executeAfterSyncOfContentFrame

void executeAfterSyncOfContentFrame(com.softwareag.cis.plugin.interfaces.RunnableDeferred runnable)
Parameters:
runnable -

execute

void execute(com.softwareag.cis.plugin.command.Command command)
Specified by:
execute in interface com.softwareag.cis.plugin.command.context.CommandContext
Parameters:
command -

refreshTypeList

void refreshTypeList()
Refresh type list


getLocale

java.util.Locale getLocale()
Get locale to be used for strings and messages

Specified by:
getLocale in interface com.softwareag.cis.plugin.command.context.CommandContext
Returns:
the locale

getUserAgent

java.lang.String getUserAgent()

getApplicationServerUrl

java.lang.String getApplicationServerUrl()

uploadFile

void uploadFile(IFileUploadListener listener)

uploadFile

void uploadFile(IFileUploadListener listener,
                java.lang.String title)

downloadFile

void downloadFile(java.lang.String fileName,
                  byte[] content,
                  java.lang.String contentType)

addFavoriteToBrowser

void addFavoriteToBrowser(java.lang.String title,
                          java.lang.String url)

refreshTargetFrame

void refreshTargetFrame(java.lang.String targetFrame)

outputMessage

void outputMessage(java.lang.String type,
                   java.lang.String shortText)
Parameters:
type - Type of message (error/warning/success) - please reference the corresponding constants MT_* inside this class.
shortText - text which is displayed inside the satus bar.

enableTitleBarCommands

void enableTitleBarCommands(java.lang.String wizardAdapterName)