com.beasys.commerce.axiom.advisor
Interface Advisor

public interface Advisor

extends javax.ejb.EJBObject

The remote bean interface for the Advisor. The advisor makes recommendations for advise requests. To get recommendations, first create a request template for the type of request you want to make by calling the advisor's createRequestTemplate method, then fill out the template with the required information, and then call the advisor's advise() method.

Method Summary

AdviceResults	advise(AdviceRequest adviceRequest) This method makes recommendations based the AdviceRequest passed in.
AdviceRequest	createRequestTemplate(java.lang.String theKindOfAdvice) This method creates an AdviceRequest template for the type of advice requested.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

advise

public AdviceResults advise(AdviceRequest adviceRequest)
                     throws java.lang.IllegalArgumentException,
                            AdvisorException,
                            AdviceRequestValidationException,
                            java.rmi.RemoteException

This method makes recommendations based the AdviceRequest passed in.

Parameters:

adviceRequest - The advice request for which to make a recommendation.

Returns:

AdviceResults The advice results which contain the recommendations based on the type of request made.

Throws:

java.lang.IllegalArgumentException - Thrown if the adviceRequest parameter is null or an unsupported type.

AdvisorException - thrown on an error when processing the request.

AdviceRequestValidationException - thrown on an error when validating the request.

java.rmi.RemoteException - thrown on a communication error.

createRequestTemplate

public AdviceRequest createRequestTemplate(java.lang.String theKindOfAdvice)
                                    throws java.lang.IllegalArgumentException,
                                           AdvisorException,
                                           java.rmi.RemoteException

This method creates an AdviceRequest template for the type of advice requested.

Parameters:

theKindOfAdvice - The name of the kind of advice which is used to create the template.

Returns:

AdviceRequest A advice request template. The caller is responsible for setting the template data before calling the Advisor.advise() method.

Throws:

java.lang.IllegalArgumentException - Thrown if the parameters are null or an unsupported type.

AdvisorException - thrown on an error when creating the template.

java.rmi.RemoteException - thrown on a communication error.