com.ibm.commerce.tickler.commands

Interface CreateTicklerCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    CreateTicklerCmdImpl


    public interface CreateTicklerCmd
    extends TaskCommand
    The class creates a tickler based on an action object (such as a quote or an order). A tickler reminds a Customer Service Supervisor or Customer Service Representative to perform an action. Example actions are calling a customer to get a replacement payment instruction or to review a price override. The action object types are the types of object to which to-do item is associated. Valid values are as follows:
     ORDER=Order
     QUOTE=Quote
     RMA=Return
     USER=Customer
     
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
      • CLASSNAME

        static final java.lang.String CLASSNAME
        The name of this class.
        See Also:
        Constant Field Values
    • Method Detail

      • getTicklerComment

        java.lang.String getTicklerComment()
        This method retrieves the tickler comment. Tickler comment is the comment on this to-do item.
        Returns:
        the tickler comment.
      • setTicklerComment

        void setTicklerComment(java.lang.String astrTicklerComment)
        This method sets the tickler comment. Tickler comment is the comment on this to-do item.
        Parameters:
        astrTicklerComment - text of the comment
      • getTicklerReasonId

        java.lang.Integer getTicklerReasonId()
        This method retrieves the tickler reason identifier. ticklerReasonIdThe unique Identifier for Tickler reason. Tickler reason defines the purpose for a tickler.
        Returns:
        the tickler reason identifier.
        See Also:
        createTickler
      • setTicklerReasonId

        void setTicklerReasonId(java.lang.Integer anTicklerReasonId)
        This method sets the tickler reason identifier. ticklerReasonIdThe unique Identifier for Tickler reason. Tickler reason defines the purpose for a tickler.
        Parameters:
        anTicklerReasonId - tickler reason identifier.
        See Also:
        createTickler
      • getActionObjectId

        java.lang.Long getActionObjectId()
        This method retrieves the identifier of the action object based on which this tickler is created. The action object are the types of object to which to-do item is associated. Valid values are as follows:
         ORDER=Order
         QUOTE=Quote
         RMA=Return
         USER=Customer
         
        Returns:
        the action object identifier.
        See Also:
        createTickler
      • setActionObjectId

        void setActionObjectId(java.lang.Long anActionObjectId)
        This method sets the identifier of the action object based on which this tickler is created. The action object are the types of object to which to-do item is associated. Valid values are as follows:
         ORDER=Order
         QUOTE=Quote
         RMA=Return
         USER=Customer
         
        Parameters:
        anActionObjectId - action object identifier.
        See Also:
        createTickler
      • getActionObjectType

        java.lang.String getActionObjectType()
        This method retrieves the type of the action object based on which this tickler is created. The action object are the types of object to which to-do item is associated. Valid values are as follows:
         ORDER=Order
         QUOTE=Quote
         RMA=Return
         USER=Customer
         
        Returns:
        the action object type.
        See Also:
        createTickler
      • setActionObjectType

        void setActionObjectType(java.lang.String astrActionObjectType)
        This method sets the type of the action object based on which this tickler is created. The action object are the types of object to which to-do item is associated. Valid values are as follows:
         ORDER=Order
         QUOTE=Quote
         RMA=Return
         USER=Customer
         
        Parameters:
        astrActionObjectType - action object type.
        See Also:
        createTickler
      • getRemindOnDate

        java.sql.Timestamp getRemindOnDate()
        This method retrieves the date-time when this tickler should next pop into the queue of the responsible member.
        Returns:
        the date-time when this tickler should next pop into the queue.
      • setRemindOnDate

        void setRemindOnDate(java.sql.Timestamp aRemindOnDate)
        This method sets the date-time when this tickler should next pop into the queue of the responsible member.
        Parameters:
        aRemindOnDate - date-time when this tickler should next pop into the queue.
      • getAssignToMemberId

        java.lang.Long getAssignToMemberId()
        This method retrieves the identifier of the CSR (Customer Support Representative) to whom this tickler is assigned.
        Returns:
        the CSR (Customer Support Representative) identifier.
      • setAssignToMemberId

        void setAssignToMemberId(java.lang.Long anAssignToMemberId)
        This method sets the identifier of the Customer Service Representative to whom this tickler is assigned.
        Parameters:
        anAssignToMemberId - Customer Service Representative Identifier.
      • setRequestProperties

        void setRequestProperties(TypedProperty reqParms)
                           throws ECApplicationException
        This method is used to set the request properties. TypedProperties is a wrapper to a java.util.Map.
        Parameters:
        reqParms - request properties to be set.
        Throws:
        ECApplicationException
      • getTicklerId

        java.lang.Long getTicklerId()
        This method retrieves the tickler identifier.
        Returns:
        the tickler identifier.