Bookshelf Home | Contents | Index | Search | PDF

Siebel eSales Administration Guide > Shopping Service API > Workflow Methods >

RemoveInvalidItems

---

RemoveInvalidItems is called in Check Out workflow. It deletes each record in the Quote Item business component whose Invalid Flag is Y.

Expected Preconditions Before the Method Can Be Called

This method is invoked in the eSales - Checkout Process workflow. The sequence called is OrderQuote (see OrderQuote), then ValidQuote (see ValidQuote), and then RemoveInvalidItems.
This method only checks the Base Price field in the Quote Item business component. If this field is empty for a record, then the record is invalid. You can override this method to do your own validity checking.

Arguments

The RemoveInvalidItems method has the arguments shown in Table 49.

Table 49. RemoveInvalidItems Arguments

Name	Type	Data Type	Optional	Comments
Return Error Code	Input	String	Y	If equal to N, the method will not return errors. When a method returns an error, the workflow stops. In order not to kill the workflow, you can set this input to N. This way the Shopping Service will not return an error, but instead will save the error message in the output argument Error Message. You can then handle the error message as you wish.
Error Message	Output	String	Y	Stores error messages.
Invalid	Input	String	Y	If equal to N, do nothing. Else loop through each line item to delete invalid items.
Quote Id	Input	String	Y	Not used.
ReturnVal	Output	String	Y	Returns Success or Fail. Not used.

Pseudo-Algorithm

Get the Quote and Quote Item business components.
Check the Invalid input argument:

If Invalid = N, go to step 4.

For each record in the Quote Item business component, check the Invalid Flag field:

If the field value is Y, delete the record.

Set the Error Message output argument if there is any error;

If Return Error Code = N, do not return an error;

Else return an error.

Bookshelf Home | Contents | Index | Search | PDF