com.ibm.commerce.tickler.commands

Class TicklerCreateCmdImpl

  • All Implemented Interfaces:
    AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, TicklerCreateCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable


    public class TicklerCreateCmdImpl
    extends ControllerCommandImpl
    implements TicklerCreateCmd
    The class TicklerCreateCmdImpl creates a tickler based on an action object (such as a quote or an order).

    Mandatory parameters: ticklerReasonId, URL, storeId

    Optional parameters: inActionObjectId, actionObjectType, strRemindOnDate, comment, inAssignToMemberId

    Behavior:

    • Checks that if an action object's identifier is supplied, then so is its type, and vice-versa.
    • Checks if the supplied action object identifier is valid for its type.
    • Calls the CreateTickler task command to create the tickler.

    Exceptional conditions:

    • Of the action object identifier-type pair, only one is supplied.
    • The tickler reason is not supplied.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

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

        public static java.lang.String ISO_DATETIME_PATTERN
        ISO date-time format pattern
      • GMT_DATETIME_PATTERN

        public static java.lang.String GMT_DATETIME_PATTERN
        GMT date-time format pattern
      • CLASSNAME

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

      • TicklerCreateCmdImpl

        public TicklerCreateCmdImpl()
    • Method Detail

      • getURL

        public java.lang.String getURL()
        This method retrieves the redirect URL.
        Returns:
        redirect URL.
      • setURL

        public void setURL(java.lang.String astrURL)
        This method sets the redirect URL.
        Parameters:
        astrURL - redirect URL.
      • getTicklerComment

        public java.lang.String getTicklerComment()
        This method returns the tickler comment.
        Returns:
        the tickler comment.
      • setTicklerComment

        public void setTicklerComment(java.lang.String astrComment)
        This method is used to set the tickler comment.
        Parameters:
        astrComment - text of the comment.
      • getTicklerReasonId

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

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

        public 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

        public 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

        public java.lang.String getActionObjectType()
        This method retrieves the type of the action object based on which this tickler is created. The action object type 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

        public 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 type 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

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

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

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

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

        public void reset()
        This method resets all the command parameters.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class AbstractECTargetableCommand