com.ibm.commerce.ordermanagement.commands

Interface ReturnEditBeginCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand
    All Known Implementing Classes:
    ReturnEditBeginCmdImpl


    public interface ReturnEditBeginCmd
    extends ControllerCommand
    The ReturnEditBeginCmd controller command interface locked the RMA and brings it into editing mode(EDT).

    This ReturnEditBeginCmd implementation class and ReturnEditEndCmd command stages a RMA for editing. Between the execution of the ReturnEditBeginCmd and ReturnEditEndCmd commands, ReturnItem Update can occur.

    To invoke this command, a valid RMA ID has to be passed in from command context. An exception is thrown if an invalid RMA is passed.

    If the RMA is not locked by others, lock it. Otherwise, if the iTakeOverLock flag set to "Y", unlock the RMA which is locked by others, and lock it. An ECException will be thrown if it can't be locked by current user.

    After the command is invoked, the RMA is in an editable state. RMAs that are in edit(EDT), pending(PND) and approved(APP) state can be edited.

    If the command is successful, the status of the RMA will be set to EDT and the RMA "INUSE" flag will be set to "Y". The RMA will not be processed by the system until the RMA gets submitted again.

    If unsuccessful, the command throws the ECException.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        Copyright statement.
        See Also:
        Constant Field Values
      • EC_RMA_ID

        static final java.lang.String EC_RMA_ID
        URL parameter constant.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The full class name for this interface file.
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        This method is the default implementation class.
        See Also:
        Constant Field Values
    • Method Detail

      • setRMAId

        void setRMAId(java.lang.String strRMAId)
        This method sets an RMA ID, a required field, for edit.
        Parameters:
        strRMAId - A String of a valid RMAId
      • setRMA

        void setRMA(RMAAccessBean aAbRMA)
        This method sets a RMA AccessBean for edit.
        Parameters:
        aAbRMA - An AccessBean of a valid RMA
      • setTakeOverLock

        void setTakeOverLock(java.lang.String takeOverLock)
        This method sets if take over lock from others
        Parameters:
        takeOverLock - If take over locks from others