Package com.aquima.web.rest.v1.linker

Interface IResourceLinker<T>

Type Parameters:
T - the resource type this linker can handle
All Known Implementing Classes:
CaseEventLinker, CaseLinker, EndpointLinker, MetadataLinker, ProjectLinker, RuntimeLinker, ShortcutLinker, TaskLinker, WebserviceLinker
public interface IResourceLinker<T>
Adds HATEOAS links to REST resources.
Since:
9.6
Author:
Petru Galanton

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    void
    link(PagedObject<T> pagedObject, IPaginator<T> paginator)
    Adds HATEOAS links to the given paged set of resources.
    void
    link(T resource)
    Adds HATEOAS links to the given resource.

  • Method Details Link icon

    • link Link icon

      void link(T resource)
      Adds HATEOAS links to the given resource.
      Parameters:
      resource - the resource on which links should be added

    • link Link icon

      void link(PagedObject<T> pagedObject, IPaginator<T> paginator)
      Adds HATEOAS links to the given paged set of resources. Adds links both on the enclosing paged object (if pagination is enabled) and on the enclosed resources. Pagination ma
      Parameters:
      pagedObject - the object enclosing a page of resources
      paginator - the paginator, used for determining whether paging is enabled, first page number, last page number, etc.