FindStoreDialog

java.lang.Object
- org.eclipse.jface.window.Window
- - org.eclipse.jface.dialogs.Dialog
  - - org.eclipse.jface.dialogs.TrayDialog
    - - org.eclipse.jface.dialogs.TitleAreaDialog
      - com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog
        
        com.ibm.commerce.telesales.ui.dialogs.ConfiguredTitleAreaDialog
        
        com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog
        
        com.ibm.commerce.telesales.ui.impl.dialogs.find.store.FindStoreDialog

All Implemented Interfaces:

IDialog, IWidgetManagerListener, org.eclipse.jface.window.IShellProvider
```
public class FindStoreDialog
extends com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog
```
FindStoreDialog is the ConfiguredFindDialog implementation used for finding Stores.
The find store managed composites for the dialog area and button bar are defined in the "com.ibm.commerce.telesales.ui.impl.find.store" fragment.

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
  org.eclipse.jface.window.Window.IExceptionHandler

Field Summary
- Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
  DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE
- Fields inherited from class org.eclipse.jface.dialogs.Dialog
  blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS
- Fields inherited from class org.eclipse.jface.window.Window
  CANCEL, OK
- Fields inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog
  KEY_ADDRESSES, KEY_CHECKED_ITEMS, KEY_COMPARE_SELECTION, KEY_CONTACT_HISTORY_DISPLAY_SETTING, KEY_CONTRACT_ID, KEY_CONTRACT_PRICES, KEY_CUSTOMER, KEY_CUSTOMER_COMMENT, KEY_DELAY, KEY_DYNAMIC_KIT, KEY_ENABLE_FILTER, KEY_FOR_USER, KEY_INITIAL_SEARCH_RESULTS, KEY_INSTANT_ADDITION, KEY_INSTANT_CREATION, KEY_IS_ORDER_ITEM_LEVEL_CHARGES, KEY_ITEM, KEY_ITEMS, KEY_NEW_ORGANIZATION, KEY_NEW_PRESSED, KEY_ORDER, KEY_ORDER_BLOCK, KEY_ORDER_BLOCKS, KEY_ORDER_CHANGE_INFO, KEY_ORDER_CHANGEREASON_LIST, KEY_ORGANIZATION, KEY_ORGANIZATIONS, KEY_PASSWORD, KEY_PASSWORD_EXPIRED, KEY_PAYMENT, KEY_PAYMENT_METHODS, KEY_PRICE_LIST, KEY_PROCESS_SELECTION, KEY_PRODUCT, KEY_PRODUCT_ITEM, KEY_PROMOTION, KEY_PROMOTION_APPLIED, KEY_PROMOTION_APPLY_TYPE, KEY_QUOTE, KEY_QUOTE_EXPIRY, KEY_RETURN, KEY_RETURN_ITEM_SERIALNUMBERLIST, KEY_RETURN_RECEIPT_LIST, KEY_SALES_CONTAINER_LIST, KEY_SELECTED_ITEMS, KEY_SELECTION_ITEMS, KEY_SERVICE_REQUEST, KEY_SHIPPING_CARRIERS, KEY_SHIPPING_INSTRUCTIONS, KEY_STATUS_MESSAGE, KEY_STORE, KEY_STORE_IDENTIFIER, KEY_STORES_AVAILABLE, KEY_STORES_OPEN, KEY_SUPPRESS_OK_ACTION, KEY_TICKLER, KEY_TICKLER_ACTIONS_AVAILABLE, KEY_TICKLERS_SELECTED, KEY_TSR_AVAILABLE, KEY_UNPAID_BALANCE, KEY_USER_NAME, KEY_VIEW_REGISTRY

Constructor Summary

Constructors
Constructor and Description

FindStoreDialog()
Construct a new find store dialog.

Constructors
Constructor and Description
`FindStoreDialog()` Construct a new find store dialog.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`configureShell(org.eclipse.swt.widgets.Shell newShell)` Configures the given shell in preparation for opening this window in it.
`protected org.eclipse.swt.widgets.Control`	`createDialogArea(org.eclipse.swt.widgets.Composite parent)` Creates and returns the contents of the upper part of the dialog (above the button bar).
`protected java.lang.String`	`getButtonBarManagedCompositeId()` Returns the button bar managed composite ID.
`protected java.lang.String`	`getDialogAreaManagedCompositeId()` Returns the dialog area managed composite ID.
`protected java.lang.String`	`getDialogId()` This method returns the specific (find) dialog ID.
`protected java.lang.String`	`getHelpContextId()` Retrieve the help context ID.
`protected java.util.List`	`getStores(java.lang.String[] storeIds, java.lang.String[] storeLanguageIds)` This method makes a request to the server to obtain the details of the selected stores.
`void`	`okPressed()` Call back method.

Methods inherited from class com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog
cancelPressed, getResult, getSelectedSearchResults, setResult

Methods inherited from class com.ibm.commerce.telesales.ui.dialogs.ConfiguredTitleAreaDialog
activate, close, createButtonBar, createContents, getButtonBarManagedComposite, getDefaultMessage, getDialogAreaManagedComposite, getWidgetManagerInputProperties, hasRequiredInput, isDirty, refresh, refreshStatusMessage, setData, setFocus, widgetManagerChanged

Methods inherited from class com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog
getData

Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
getInitialSize, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
closeTray, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonsForButtonBar, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog
open

- Constructor Detail
  - FindStoreDialog
```
public FindStoreDialog()
```
    Construct a new find store dialog. IBM Sales Center dialogs should be constructed using the dialog factory.
    
    See Also:
    
    DialogFactory.getFindStoreDialog()
- Method Detail
  - configureShell
```
protected void configureShell(org.eclipse.swt.widgets.Shell newShell)
```
    Configures the given shell in preparation for opening this window in it.
    
    Overrides:
    
    configureShell in class com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog
    
    Parameters:
    
    newShell - the shell
  - getHelpContextId
```
protected java.lang.String getHelpContextId()
```
    Retrieve the help context ID. Value is ITelesalesHelpContextIds.FIND_STORE_DIALOG.
    
    Specified by:
    
    getHelpContextId in class com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog
    
    Returns:
    
    context ID
    
    See Also:
    
    ITelesalesHelpContextIds.FIND_STORE_DIALOG
  - createDialogArea
```
protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
```
    Creates and returns the contents of the upper part of the dialog (above the button bar).
    
    Overrides:
    
    createDialogArea in class ConfiguredTitleAreaDialog
    
    Parameters:
    
    parent - composite to contain the dialog area.
    
    Returns:
    
    The dialog area control.
    
    See Also:
    
    Dialog.createDialogArea(org.eclipse.swt.widgets.Composite)
  - getDialogAreaManagedCompositeId
```
protected java.lang.String getDialogAreaManagedCompositeId()
```
    Returns the dialog area managed composite ID. Value is "com.ibm.commerce.telesales.ui.impl.findStoreManagedComposite".
    
    Specified by:
    
    getDialogAreaManagedCompositeId in class ConfiguredTitleAreaDialog
    
    Returns:
    
    dialog area managed composite ID
    
    See Also:
    
    ConfiguredTitleAreaDialog.getDialogAreaManagedCompositeId()
  - getButtonBarManagedCompositeId
```
protected java.lang.String getButtonBarManagedCompositeId()
```
    Returns the button bar managed composite ID. Value is "com.ibm.commerce.telesales.ui.impl.findDialogButtonsManagedComposite".
    
    Specified by:
    
    getButtonBarManagedCompositeId in class ConfiguredTitleAreaDialog
    
    Returns:
    
    button bar managed composite ID
    
    See Also:
    
    ConfiguredTitleAreaDialog.getButtonBarManagedCompositeId()
  - getDialogId
```
protected java.lang.String getDialogId()
```
    This method returns the specific (find) dialog ID. This ID is used to determine the content that belongs to this dialog. The value returned is com.ibm.commerce.telesales.findStoreDialog
    
    Specified by:
    
    getDialogId in class com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog
    
    Returns:
    
    The dialog ID.
  - getStores
```
protected java.util.List getStores(java.lang.String[] storeIds,
                       java.lang.String[] storeLanguageIds)
```
    This method makes a request to the server to obtain the details of the selected stores. If successful, the dialog results are set to the list of selected stores.
    
    Parameters:
    
    storeIds - a string array of store ids to be retrieved
    
    storeLanguageIds - a string array of store language ids to be retrieved
    
    Returns:
    
    List of Store model objects corresponding to storeIds
  - okPressed
```
public void okPressed()
```
    Call back method. This method will be invoked when the 'OK' button of this dialog is clicked.
    When the 'OK' button is pressed, the store is added to the list of open stores at the client, if it is not already opened. To open a store, this method checks if the store details are present in the client cache. And if not present, the store details will be retrieved from the server.
    
    Overrides:
    
    okPressed in class com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog
    
    See Also:
    
    Dialog.okPressed()

Class FindStoreDialog

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

Field Summary

Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

Fields inherited from class org.eclipse.jface.dialogs.Dialog

Fields inherited from class org.eclipse.jface.window.Window

Fields inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.telesales.ui.impl.dialogs.find.ConfiguredFindDialog

Methods inherited from class com.ibm.commerce.telesales.ui.dialogs.ConfiguredTitleAreaDialog

Methods inherited from class com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog

Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

Methods inherited from class org.eclipse.jface.dialogs.Dialog

Methods inherited from class org.eclipse.jface.window.Window

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog

Constructor Detail

FindStoreDialog

Method Detail

configureShell

getHelpContextId

createDialogArea

getDialogAreaManagedCompositeId

getButtonBarManagedCompositeId

getDialogId

getStores

okPressed