IOrbRoute Interface

The IOrbRoute interface allows a class to be used to action web requests (for details, see "Routing Engine", elsewhere in this document).

The IOrbRoute interface has the following methods.

• execute, which has the following signature.

  execute(): Integer;

  The execute method of the class is called when a URL associated with the class implementing the IOrbRoute interface is accessed.

  The execute method is called after properties on the instance of the route class are populated and before the render method is called.

  The method returns an Integer. The significance of this return value is user‑defined; for example, you can return a value indicating success or failure. The result returned by this method is passed to the render method.

• render, which has the following signature.

  render(executeResult: Integer): Binary;

  The render method is called after the execute method returns.

  The value returned by the execute method is passed to the render method as the executeResult parameter.

  The Binary value returned by this method is sent to the web browser; for example, the return value of this method can be the result of a call to the bind method.