AgentListController (CDM Library 3.2.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

eu.etaxonomy.cdm.remote.controller
Class AgentListController

java.lang.Object
  eu.etaxonomy.cdm.remote.controller.AbstractController<T,SERVICE>
      eu.etaxonomy.cdm.remote.controller.AbstractListController<T,SERVICE>
          eu.etaxonomy.cdm.remote.controller.BaseListController<T,SERVICE>
              eu.etaxonomy.cdm.remote.controller.IdentifiableListController<AgentBase,IAgentService>
                  eu.etaxonomy.cdm.remote.controller.AgentListController

@Controller @RequestMapping(value="/agent") public class AgentListController
extends IdentifiableListController<AgentBase,IAgentService>
extends IdentifiableListController<AgentBase,IAgentService>

The AgentListController class is a Spring MVC Controller.

The syntax of the mapped service URIs contains the the {datasource-name} path element. The available {datasource-name}s are defined in a configuration file which is loaded by the UpdatableRoutingDataSource. If the UpdatableRoutingDataSource is not being used in the actual application context any arbitrary {datasource-name} may be used.

Methods mapped at type level, inherited from super classes (BaseController):

URI: /{datasource-name}/agent/ Depending on the URI parameters used this service returns either a Pager on or a List of the AgentBase entities identified by the {agent-uuid}. The returned AgentBase instances are initialized by the following strategy: AbstractController.DEFAULT_INIT_STRATEGY
URI Parameters to return a Pager:

pageNumber the number of the page to be returned, the first page has the pageNumber = 1 - optional parameter
pageSize the maximum number of entities returned per page (can be null to return all entities in a single page) - optional parameter
type Further restricts the type of entities to be returned. If null the base type <T> is being used. - optional parameter

URI Parameters to return a List:

start The offset index from the start of the list. The first entity has the index = 0 - required parameter The start parameter is used to distinguish between the List and Pager variants!
limit The maximum number of entities returned. - optional parameter
type Further restricts the type of entities to be returned. If null the base type <T> is being used. - optional parameter

Author:: a.kohlbecker

Field Summary

Fields inherited from class eu.etaxonomy.cdm.remote.controller.BaseListController
`logger`

Fields inherited from class eu.etaxonomy.cdm.remote.controller.AbstractController
`DEFAULT_INIT_STRATEGY, DEFAULT_PAGE_SIZE, initializationStrategy, service`

Constructor Summary
`AgentListController()`

Method Summary
`void`	`setService(IAgentService service)`

Methods inherited from class eu.etaxonomy.cdm.remote.controller.IdentifiableListController
`doFindByTitle`

Methods inherited from class eu.etaxonomy.cdm.remote.controller.BaseListController
`doList, doPage, initBinder`

Methods inherited from class eu.etaxonomy.cdm.remote.controller.AbstractController
`requestPathAndQuery, setInitializationStrategy`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail