com.ibm.commerce.foundation.server.command

Interface CommandKey

  • All Known Implementing Classes:
    BusinessObjectDocumentCommandKeyImpl, GenericCommandKeyImpl


    public interface CommandKey
    A command key is an interface that returns a list of potential keys to determine the implementation of the command. Based on a set of different object and values, a list of keys is returned to determine the search order of which command to instantiate.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      boolean getDefaultImplementation()
      This method returns whether or not the default implementation should be instantiated if the key has been specified.
      java.lang.String getInterface()
      This method returns the interface of the command to instantiate.
      java.lang.String getKey()
      This method returns all the possible keys that can be used to create an instance of the command.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
    • Method Detail

      • getInterface

        java.lang.String getInterface()
        This method returns the interface of the command to instantiate.
        Returns:
        The interface of the command to instantiate.
      • getKey

        java.lang.String getKey()
        This method returns all the possible keys that can be used to create an instance of the command. The list contains the keys in order to iterate through to determine the command implementation.
        Returns:
        A list of keys that represent the command to instantiate.
      • getDefaultImplementation

        boolean getDefaultImplementation()
        This method returns whether or not the default implementation should be instantiated if the key has been specified. A value of true means that the default implementation is resolved if the key implementation cannot be resolved. A value of false will indicate that the null is returned if the key implementation has not been found.
        Returns:
        Whether or not that the default implementation can be returned in the case where the key is specified and no implementation can be found.