com.ibm.commerce.price.commands

Interface ComposePriceForCatalogEntryCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    ComposePriceForCatalogEntryCmdImpl

    public interface ComposePriceForCatalogEntryCmd
extends com.ibm.commerce.command.TaskCommand
    This is the interface of the ComposePriceForCatalogEntryCmdImpl.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String NAME
      The name of this command.

      • Fields inherited from interface com.ibm.commerce.command.CacheableECCommand

        defaultCommandClassName

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.foundation.common.datatypes.PriceInfoType[] getPrice()
      The function of this method is returning the PriceInfoType of the catentries.
      void setCatalogEntryIds(java.lang.String[] catalogEntryIds)
      Set the catentryIds to the global variable.
      void setContractIds(java.lang.String[] contractIds)
      The function of this method is setting the contractIds to the global variable.
      void setProfile(java.lang.String[] profileString)
      Set the profileString to the global variable.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute

      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

    • Method Detail

      • getPrice

        com.ibm.commerce.foundation.common.datatypes.PriceInfoType[] getPrice()
        The function of this method is returning the PriceInfoType of the catentries. For one kind of sub type price, if there isn't valid price for one catentry, the corresponding sub price type will be null. If all the requested sub kinds price are all invalid, the PriceInfoType of the catentry will be null. If all the request catentries haven't valid prices, the array PriceInfoType object will be null.
        Returns:
        return the PriceInfoType array.

      • setCatalogEntryIds

        void setCatalogEntryIds(java.lang.String[] catalogEntryIds)
        Set the catentryIds to the global variable.
        Parameters:
        catalogEntryIds - the catentry ids of the catentries which prices will be gotten for in this Command.

      • setContractIds

        void setContractIds(java.lang.String[] contractIds)
        The function of this method is setting the contractIds to the global variable. The param contractIds is a contractId array which specified for all the catentries(only applicable for product/item/package).
        For example, the specified catentries is cat1, cat2, cat3.

        cat1 have valid contract price under: contract1, contract2, contract3.

        cat2 have valid contract price under: contract2,

        cat3 have valid contract price under: contract2, contract3,

        The contractIds contain contract1, contract3. Then finally, the valid contractprices returned are:

        cat1: contract1 price, contract3 price.

        cat2: no valid contract price.

        cat3: contract3 price.
        Parameters:
        contractIds - indicates the specified contractIds of the catentries.

      • setProfile

        void setProfile(java.lang.String[] profileString)
        Set the profileString to the global variable. profileString is String array. It indicates what sub kinds price is retrieved. The value and the description is listed:
        Value Description
        StandardPrice indicates get Standard Price
        ContractPrice indicates get Contract Price
        FloorPrice indicates get Floor Price
        If the profileString is null, that mean, all the kinds of prices need to be returned.
        Parameters:
        profileString - indicates what kinds of price need to be retrieved.
Skip navigation links