org.jasig.portal.channels.jsp
Interface IServantController

All Known Implementing Classes:

ServantChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface IServantController

An interface that an instance of IController for the jsp channel type must implement to be used within the ServantChannel subclass of the jsp channel type and hence can provide servant capabilities. This interface provides the same functionality for the jsp channel type that IServant does for IChannel.

Version:

$Revision: 19776 $

Author:

Mark Boyd

Method Summary

void	configure(Object o) Deprecated. Enables the containing channel to change configuration of the servant if supported by the servant channel at any point in time.
Object[]	getResults() Deprecated. Many servant channels will fulfill their function by providing some set of 1 or more Objects to the Master Channel.
boolean	isFinished() Deprecated. Allows the Master Channel to ascertain if the Servant has accomplished the requested task (Note that the way which a certain task is requested can be specified by this interface or through some particular configuration paramaters used to initialize the servant.)

Method Detail

configure

void configure(Object o)

Deprecated.

Enables the containing channel to change configuration of the servant if supported by the servant channel at any point in time. If this method is called the servant must discard its current state and reconfigure itself according to the information passed in via this method. The type of object allowed for a given servant must be information obtained from documentation or other means.

Parameters:

o -

isFinished

boolean isFinished()

Deprecated.

Allows the Master Channel to ascertain if the Servant has accomplished the requested task (Note that the way which a certain task is requested can be specified by this interface or through some particular configuration paramaters used to initialize the servant.)

Returns:

boolean

getResults

Object[] getResults()

Deprecated.

Many servant channels will fulfill their function by providing some set of 1 or more Objects to the Master Channel.

Returns:

Object[] the expected Object type should be documented by the IServant implementation