com.ibm.commerce.foundation.server.command.bod

Class BusinessObjectDocumentCommandKeyImpl

  • java.lang.Object
    • com.ibm.commerce.foundation.server.command.bod.BusinessObjectDocumentCommandKeyImpl
  • All Implemented Interfaces:
    CommandKey


    public class BusinessObjectDocumentCommandKeyImpl
    extends java.lang.Object
    implements CommandKey
    This class represents a command key for business object documents. Based on a given business object document, this command key implementation will determine the command interface that represents the command key. This implementation will take the interface name of the business object document and replace the datatype package with server.commands and change the interface class from Type to Cmd.
    • Method Summary

      All Methods Instance Methods Concrete 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 name of the command that represents the processing of the business object document.
      java.lang.String getKey()
      This method always returns null for the key attribute of the command.
      java.lang.Integer getStoreId()
      This method returns the store ID if it has been set.
      java.lang.String toString()
      This method returns the string representation of the object.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BusinessObjectDocumentCommandKeyImpl

        public BusinessObjectDocumentCommandKeyImpl(BusinessObjectDocumentType businessObjectDocument)
        Creates an instance of the business object document command key.
        Parameters:
        businessObjectDocument - The business object document to express as a command.
      • BusinessObjectDocumentCommandKeyImpl

        public BusinessObjectDocumentCommandKeyImpl(BusinessObjectDocumentType businessObjectDocument,
                                                    java.lang.Integer storeId)
        Creates an instance of the business object document command key using the store ID.
        Parameters:
        businessObjectDocument - The business object document to express as a command.
        storeId - The store ID.
    • Method Detail

      • getInterface

        public java.lang.String getInterface()
        This method returns the interface name of the command that represents the processing of the business object document.
        Specified by:
        getInterface in interface CommandKey
        Returns:
        The generated command interface of the business object document.
        See Also:
        CommandKey.getInterface()
      • getKey

        public java.lang.String getKey()
        This method always returns null for the key attribute of the command.
        Specified by:
        getKey in interface CommandKey
        Returns:
        Always null.
        See Also:
        CommandKey.getKey()
      • getStoreId

        public java.lang.Integer getStoreId()
        This method returns the store ID if it has been set. Otherwise, it will return null for the store ID of the command.
        Returns:
        The store ID.
      • getDefaultImplementation

        public 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.
        Specified by:
        getDefaultImplementation in interface CommandKey
        Returns:
        Always true.
      • toString

        public java.lang.String toString()
        This method returns the string representation of the object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string representation of the object.