org.springframework.extensions.surf

Interface LinkBuilder

All Known Implementing Classes:

AbstractLinkBuilder, RequestParameterLinkBuilder, ServletLinkBuilder

public interface LinkBuilder

Link builder interface that defines methods for building URIs within Surf.

Author:

muzquiano

Method Summary

Methods

Modifier and Type	Method and Description
String	object(RequestContext context, String objectId) Constructs a link to a given object.
String	object(RequestContext context, String objectId, String formatId) Constructs a link to a given object.
String	object(RequestContext context, String objectId, String formatId, Map<String,String> params) Constructs a link to a given object.
String	page(RequestContext context, String pageId) Constructs a link to a given page instance.
String	page(RequestContext context, String pageId, String formatId) Constructs a link to a given page for a given format.
String	page(RequestContext context, String pageId, String formatId, String objectId) Constructs a link to a given page for a given format.
String	page(RequestContext context, String pageId, String formatId, String objectId, Map<String,String> params) Constructs a link to a given page for a given format.
String	pageType(RequestContext context, String pageTypeId) Constructs a link to a given page type.
String	pageType(RequestContext context, String pageTypeId, String formatId) Constructs a link to a given page type for a given format.
String	pageType(RequestContext context, String pageTypeId, String formatId, String objectId) Constructs a link to a given page type for a given format.
String	pageType(RequestContext context, String pageTypeId, String formatId, String objectId, Map<String,String> params) Constructs a link to a given page type for a given format.
String	resource(RequestContext context, String uri) Constructs a link to a resources at a given relative uri.

Method Detail

page

String page(RequestContext context,
          String pageId)

Constructs a link to a given page instance. This will automatically use the default format.

Parameters:

context - The Request Context instance

pageId - The id of the page instance

page

String page(RequestContext context,
          String pageId,
          String formatId)

Constructs a link to a given page for a given format.

Parameters:

context - The Request Context instance

pageId - The id of the page instance

formatId - The id of the format to render

page

String page(RequestContext context,
          String pageId,
          String formatId,
          String objectId)

Constructs a link to a given page for a given format. The provided object is passed in as context.

Parameters:

context - The Request Context instance

pageId - The id of the page instance

formatId - The id of the format to render

objectId - The id of the object

page

String page(RequestContext context,
          String pageId,
          String formatId,
          String objectId,
          Map<String,String> params)

Constructs a link to a given page for a given format. The provided object is passed in as context. The provided parameters are appended to the URL.

Parameters:

context - The Request Context instance

pageId - The id of the page instance

formatId - The id of the format to render

objectId - The id of the object

params - A map of name/value pairs to be appended to the URL

pageType

String pageType(RequestContext context,
              String pageTypeId)

Constructs a link to a given page type. This will automatically use the default format.

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

pageType

String pageType(RequestContext context,
              String pageTypeId,
              String formatId)

Constructs a link to a given page type for a given format.

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

formatId - The id of the format to render

pageType

String pageType(RequestContext context,
              String pageTypeId,
              String formatId,
              String objectId)

Constructs a link to a given page type for a given format. The provided object is passed in as context.

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

formatId - The id of the format to render

objectId - The id of the object

pageType

String pageType(RequestContext context,
              String pageTypeId,
              String formatId,
              String objectId,
              Map<String,String> params)

Constructs a link to a given page type for a given format. The provided object is passed in as context. The provided parameters are appended to the URL.

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

formatId - The id of the format to render

objectId - The id of the object

params - A map of name/value pairs to be appended to the URL

object

String object(RequestContext context,
            String objectId)

Constructs a link to a given object. This will automatically use the default format.

Parameters:

context - The Request Context instance

objectId - The id of the object

object

String object(RequestContext context,
            String objectId,
            String formatId)

Constructs a link to a given object. This will automatically use the default format.

Parameters:

context - The Request Context instance

objectId - The id of the object

formatId - The id of the format to render

object

String object(RequestContext context,
            String objectId,
            String formatId,
            Map<String,String> params)

Constructs a link to a given object. The provided object is passed in as context. The provided parameters are appended to the URL.

Parameters:

context - The Request Context instance

objectId - The id of the object

formatId - The id of the format to render

params - A map of name/value pairs to be appended to the URL

resource

String resource(RequestContext context,
              String uri)

Constructs a link to a resources at a given relative uri.

Parameters:

context - RequestContext

uri - String

Returns:

the