com.ibm.commerce.contract.commands

Interface ParticipantAddCmd

  • All Superinterfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.security.Protectable
    All Known Implementing Classes:
    ParticipantAddCmdImpl


    public interface ParticipantAddCmd
    extends com.ibm.commerce.command.ControllerCommand
    This contract controller command is used to add a participant to a trading agreement (Contract/Account). It is also used to add a participant to a Contract terms and conditions (WebSphere Commerce Enterprise only). The default implementation of this command is ParticipantAddCmdImpl. The ParticipantAdd URL is mapped to this command by default.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      The name of the default implementation class.
      static java.lang.String NAME
      The name of this interface.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void setInfo(java.lang.String info)
      Sets information of the participant
      void setMemberId(java.lang.Long memberId)
      Sets member ID of the participant.
      void setRole(java.lang.String role)
      Sets the role type of the participant.
      void setTcId(java.lang.Long tcId)
      Sets ID of the term and condition to which the participant will be added
      void setTradingId(java.lang.Long tradingId)
      Sets ID of the trading agreement to which the participant will be added
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.command.ControllerCommand

        checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
      • Methods inherited from interface com.ibm.commerce.command.AccCommand

        accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills, getOwner
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The name of the default implementation class.
        See Also:
        Constant Field Values
    • Method Detail

      • setInfo

        void setInfo(java.lang.String info)
        Sets information of the participant
        Parameters:
        info - a string of information for the participant
      • setMemberId

        void setMemberId(java.lang.Long memberId)
        Sets member ID of the participant.
        Parameters:
        memberId - the member ID of the participant
      • setRole

        void setRole(java.lang.String role)
        Sets the role type of the participant.
        Parameters:
        role - the type of the participant role
      • setTcId

        void setTcId(java.lang.Long tcId)
        Sets ID of the term and condition to which the participant will be added
        Parameters:
        tcId - term condition ID
      • setTradingId

        void setTradingId(java.lang.Long tradingId)
        Sets ID of the trading agreement to which the participant will be added
        Parameters:
        tradingId - the trading agreement ID