SilverStream
Application Server 3.5

com.sssw.rt.util
Interface AgiInvokeBusinessObject

All Known Subinterfaces:
AgiDatabase
All Known Implementing Classes:
PvHelperGeneral, AgpPage

public interface AgiInvokeBusinessObject

Tagged interface for objects that can invoke business objects.


Method Summary
 Serializable invokeBusinessObject(String agentSpec)
          Invoke the named business object and return the result.
 Serializable invokeBusinessObject(String agentSpec, Serializable param)
          Invoke the named business object and return the result.
 

Method Detail

invokeBusinessObject

public Serializable invokeBusinessObject(String agentSpec)
                                  throws Exception
Invoke the named business object and return the result.
Parameters:
agentSpec - This can be:
  • The name of an URL invokable agent in the current database
  • Database:agent for an agent in another database, or
  • A full URL to an agent.
Returns:
the result returned by the business object.
Throws:
throws - any exception thrown by the buiness object
Usage:
The writer of the business object sets the result by calling AgoInvokedEvent.setResult(Serializable result) on the AgoInvokedEventobject passed to the invoked event.
See Also:
AgoInvokedEvent

invokeBusinessObject

public Serializable invokeBusinessObject(String agentSpec,
                                         Serializable param)
                                  throws Exception
Invoke the named business object and return the result.
Parameters:
agentSpec - This can be:
  • The name of an URL invokable agent in the current database
  • Database:agent for an agent in another database, or
  • A full URL to an agent.
param - any Serializable parameter you want to pass to the business object
Returns:
the result returned by the business object.
Usage:
The writer of the business object sets the result by calling AgoInvokedEvent.setResult(Serializable result, String mime) on the AgoInvokedEvent object passed to the invoked event.
See Also:
AgoInvokedEvent

SilverStream
Application Server 3.5