org.apache.tapestry.engine
Interface IEngineService

All Known Implementing Classes:

AssetService, DirectEventService, DirectService, EngineServiceInnerProxy, EngineServiceOuterProxy, ExceptionService, ExternalService, HomeService, PageService, PortletHomeService, RenderService, ResetService, RestartService, RoundedCornerService, XTileService

public interface IEngineService

A service, provided by the IEngine, for its pages and/or components. Services are responsible for constructing EngineServiceLinks (an encoding of URLs) to represent dynamic application behavior, and for parsing those URLs when a subsequent request involves them.

Author:

Howard Lewis Ship

Method Summary

ILink	getLink(boolean post, Object parameter) Builds a URL for a service.
String	getName() Returns the name of the service.
void	service(IRequestCycle cycle) Perform the service, interpreting the URL (from the HttpServletRequest) responding appropriately, and rendering a result page.

Method Detail

getLink

ILink getLink(boolean post,
              Object parameter)

Builds a URL for a service. This is performed during the rendering phase of one request cycle and builds URLs that will invoke activity in a subsequent request cycle.

This method changed incompatibly between release 3.0 and release 4.0.

Parameters:

post - if true, then the link will be used for a post (not a get, i.e., for a HTML form); this may affect what information is encoded into the link

parameter - An object that provide any additional information needed by the service. Each service implementation will expect that an object of the proper type be passed in. In some cases, a simple String will do; in others, a specific object (possibly implementing an interface) will be required.

Returns:

The URL for the service. The URL will have to be encoded via HttpServletResponse.encodeURL(java.lang.String).

service

void service(IRequestCycle cycle)
             throws IOException

Perform the service, interpreting the URL (from the HttpServletRequest) responding appropriately, and rendering a result page.

Parameters:

cycle - the incoming request

Throws:

IOException

getName

String getName()

Returns the name of the service.

Since:

1.0.1