{ } }
Tree 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES   SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.policy.manager
Interface RuleContext

All Known Implementing Classes:
HttpRequestRuleContext, MapRequestContext, PortletRequestRuleContext
public interface RuleContext

RuleContext interface allows for others to implement a mechanism used by a rules engine to classify different types of Targets. Note:This class is designed to be implemented by clients. NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:
6.0
Note:
This interface is designed to be implemented by clients.

Method Summary
 java.util.Collection getContext()
          Retrieve the collection of rules engine objects in this RuleContext.
 java.lang.String getId()
          Retrieve a unique identifier for the session if one is available.
 

Method Detail

getContext

java.util.Collection getContext()
Retrieve the collection of rules engine objects in this RuleContext. The rules engine must be aware of the contents of the returned collection.

An example implementation class named FooRuleContext, contains a single attribute named foo with a value of either:

  • bar
  • choo
. The rules engine is configured to return a classification based on the value of the foo attribute.

Returns:
Read only Collection of Serialized Objects that can be typed as expected rules engine types The types of the objects in the collection depend on the implementation used. For example
  • PortletRequestRuleContext the collection objects will be of type PortletRequest
  • HttpRequestRuleContext the collection objects will be of type HttpServletRequest
.

getId

java.lang.String getId()
Retrieve a unique identifier for the session if one is available. Return null if not available.

Tree 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES   SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD