Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field

  See Also:

  Constant Field Values

• EDITOR_ID

  public static final java.lang.String EDITOR_ID
  

  A unique constant to indicate product compare editor ID. Value is "com.ibm.commerce.telesales.productCompareEditor".

  See Also:

  Constant Field Values

• PRODUCT_COMPARE_EDITOR_MANAGED_COMPOSITE_ID

  public static final java.lang.String PRODUCT_COMPARE_EDITOR_MANAGED_COMPOSITE_ID
  

  A unique constant to indicate product compare editor managed composite ID. Value is "com.ibm.commerce.telesales.ui.impl.productCompareEditorManagedComposite".

  See Also:

  Constant Field Values

• PRODUCT_COMPARE_EDITOR_BUTTON_BAR_MANAGED_COMPOSITE_ID

  public static final java.lang.String PRODUCT_COMPARE_EDITOR_BUTTON_BAR_MANAGED_COMPOSITE_ID
  

  A unique constant to indicate product compare editor button bar managed composite ID. Value is "com.ibm.commerce.telesales.ui.impl.productCompareEditorButtonBarManagedComposite".

  See Also:

  Constant Field Values

Constructor Detail

• ProductCompareEditor

  public ProductCompareEditor()
  

Method Detail

• init

  public void init(org.eclipse.ui.IEditorSite site,
          org.eclipse.ui.IEditorInput editorInput)
            throws org.eclipse.ui.PartInitException
  

  This method initializes this editor.

  Specified by:

  init in interface org.eclipse.ui.IEditorPart

  Overrides:

  init in class TelesalesEditorPart

  Parameters:

  site - The editor site.

  editorInput - The editor input.

  Throws:

  org.eclipse.ui.PartInitException

  See Also:

  IEditorPart.init(org.eclipse.ui.IEditorSite, org.eclipse.ui.IEditorInput)

• dispose

  public void dispose()
  

  This implementation ensures that the context is deactivated before calling the parent's dispose method.

  Specified by:

  dispose in interface org.eclipse.ui.IWorkbenchPart

  Overrides:

  dispose in class TelesalesConfigurableEditorPart

  See Also:

  IContextService.deactivateContext(org.eclipse.ui.contexts.IContextActivation), IWorkbenchPart.dispose()

• getProducts

  public ModelObjectList getProducts()
  

  This method returns the list of Products that needs to be compared. If it has not yet been set, it will be retrieved from the ProductCompareEditorInput.

  Returns:

  The products to be compared.

• useButtonBar

  protected boolean useButtonBar()
  

  This method indicates that the product compare editor requires a button bar.

  Overrides:

  useButtonBar in class TelesalesConfigurableEditorPart

  Returns:

  true if a button bar is required, false otherwise.

  See Also:

  TelesalesEditorPart.useButtonBar()

• getHelpResource

  protected java.lang.String getHelpResource()
  

  This method returns a help HREF for linking a Help action within the title area's toolbar.

  Help action will not added if this value is null.

  Subclasses should override this method.

  Overrides:

  getHelpResource in class TelesalesEditorPart

  Returns:

  The help HREF

  See Also:

  TelesalesEditorPart.createToolBarManager(Composite)

• getHelpContextId

  protected java.lang.String getHelpContextId()
  

  This method returns the help context ID so that Product Compare Editor Part has info pops. This ID is declared in ITelesalesHelpContextIds.

  Specified by:

  getHelpContextId in class TelesalesEditorPart

  Returns:

  The help context ID.

• getPartName

  public java.lang.String getPartName()
  

  This method returns the part title.

  Specified by:

  getPartName in interface org.eclipse.ui.IWorkbenchPart2

  Overrides:

  getPartName in class org.eclipse.ui.part.WorkbenchPart

  Returns:

  The title.

• getTitleImage

  public org.eclipse.swt.graphics.Image getTitleImage()
  

  This method returns the image to appear in the title of the editor.

  Specified by:

  getTitleImage in interface org.eclipse.ui.IWorkbenchPart

  Overrides:

  getTitleImage in class org.eclipse.ui.part.WorkbenchPart

  Returns:

  The title image.

  See Also:

  IWorkbenchPart.getTitleImage()

• addNewProductToCompare

  public void addNewProductToCompare()
  

  This method called when the user selects the "More..." button. It launches the FindProduct Dialog so as to obtain the additional products to compare.

• removeProduct

  public void removeProduct(Product product)
  

  This method is called to remove a given product from the comparison.

  Parameters:

  product - A product to remove.

• openFindProductDialog

  public void openFindProductDialog(Product product)
  

  This method opens the Find Product Dialog for finding a replacement for the specified product.

  Parameters:

  product - A product to open the find dialog.

• processSingleProductAddition

  protected void processSingleProductAddition(Product product)
  

  This method gets called to add a single product to the current comparison.

  Parameters:

  product - A product to add.

• processSingleProductReplacement

  protected void processSingleProductReplacement(Product product,
                                     int replaceIndex)
  

  This method gets called to replace a product currently in the comparison with another one.

  Parameters:

  product - A product to replace.

  replaceIndex - An index.

• processMultipleProductAddition

  protected void processMultipleProductAddition(Product[] products)
  

  This method gets called when multiple products are selected from the Find Product Dialog. These products are need to be inserted at the location of a currently compared product.

  Parameters:

  products - An array of new products to add.

• processMultipleProductReplacement

  protected void processMultipleProductReplacement(Product[] products,
                                       int replaceIndex)
  

  This method gets called when one product is to be replaced with multiple other products.

  Parameters:

  products - An array of products to replace.

  replaceIndex - An index.

• openInventoryFor

  public void openInventoryFor(Product product)
  

  This method opens the Product Inventory Dialog.

  Parameters:

  product - A product to open for inventory.

• openProductAttributesDialog

  public void openProductAttributesDialog(Product product)
  

  This method opens the product attributes dialog if the given product has attributes.

  Parameters:

  product - A product to open.

• addProductToOrder

  public void addProductToOrder(Product product)
  

  This method is called when the "Add To Order" button is pressed. You can only add a product to an order if the product compare is being done for a customer. if the compare is done for the operator, then the "Add to Order" button cannot be selected.

  Parameters:

  product - The product that is to be added to the order.

• getApplicableSales

  protected SalesContainer[] getApplicableSales()
  

  This method returns the applicable Order and Quote objects from the current opened sales containers.

  Returns:

  the currently opened order and quote sales containers.

• isApplicableQuote

  protected boolean isApplicableQuote(Quote quote)
  

  This method returns true if the Quote in question is in NEW state.

  Parameters:

  quote - a Quote object.

  Returns:

  true if the quote is in NEW state.

• isApplicableOrder

  protected boolean isApplicableOrder(Order order)
  

  This method returns true if the Order in question is in NEW or EDIT state.

  Parameters:

  order - an Order object.

  Returns:

  true if the order is in either NEW or EDIT state.

• addProductToTargetObject

  protected void addProductToTargetObject(Product product,
                              java.lang.Object targetObject)
  

  This method adds the selected products to the selected Order or Quote editor.

  Parameters:

  product - A product to add.

  targetObject - The target object.

• cancelPressed

  public void cancelPressed()
  

  This method gets called when the "Cancel" (or Close) button is pressed.

  Overrides:

  cancelPressed in class TelesalesEditorPart

• getMember

  public java.lang.Object getMember()
  

  This method returns the member (either Customer or Operator) for whom this product compare editor was opened.

  Returns:

  The member.

• setMember

  public void setMember(java.lang.Object member)
  

  This method sets the member (either Customer or Operator) for whom this product compare editor was opened.

  Parameters:

  member - The member to set.

• getInventory

  protected boolean getInventory(Product product)
  

  This method refreshes the inventory of the given product by requesting GetInventoryBalanceRequest service.

  Parameters:

  product - The product whose inventory will be retrieved.

  Returns:

  true if gets the inventory, false otherwise.

• getInventoryBalanceParameters

  protected TelesalesProperties getInventoryBalanceParameters(Product product)
  

  Deprecated. Do not use this method for any customization, rather use action class.
  This method creates parameters to run GetInventoryBalanceRequest request. Parameters include:

  • customer = A Customer object representing active customer.
  • store.id = A String object representing current active store ID
  • product = A Product object representing the product that the request is inquiring about.
  • find.criteria contains "catEntryId = the catEntryId of the product".