service.tut.pori.contentsuggest.reference

Class ClientService

java.lang.Object

service.tut.pori.contentsuggest.reference.ClientService

@HTTPService(name="csrc")
public class ClientService
extends java.lang.Object

Reference implementation for client API methods.

Implementation Service path cs

See Also:

ContentSuggestService

Constructor Summary

Constructors

Constructor and Description
ClientService()

Method Summary

Modifier and Type	Method and Description
Response	suggest(AuthenticationParameter authenticatedUser, DataGroups dataGroups, StringParameter query, Limits limits) This method is for retrieving a list of suggestions based on the indexed data of the user.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientService

public ClientService()

Method Detail

suggest

@HTTPServiceMethod(name="suggest",
                   acceptedMethods="GET")
public Response suggest(@HTTPAuthenticationParameter(required=false)
                                                                                                       AuthenticationParameter authenticatedUser,
                                                                                                       @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                       DataGroups dataGroups,
                                                                                                       @HTTPMethodParameter(name="query",required=true)
                                                                                                       StringParameter query,
                                                                                                       @HTTPMethodParameter(name="limits",required=false,defaultValue="0-9")
                                                                                                       Limits limits)

This method is for retrieving a list of suggestions based on the indexed data of the user. The data can include content be generated by any back-end, by the authenticated user, and can also include public content created by other users. This method can be used to provide general content suggestions, or it can be used to implement auto-complete functionality to be used, for example, with search fields in web applications.

Example Query:

GET /rest/csrc/suggest?query=peter

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="suggest" service="csrc">
  <autoCompleteResults>
    <collation/>
    <suggestionList>
      <suggestion>petervzVRrjYPVA</suggestion>
      <suggestion>peterqgPOHoodUU</suggestion>
      <suggestion>peterhClEKRgcnM</suggestion>
      <suggestion>peterUqieawanPu</suggestion>
      <suggestion>petercwvpqHwXyQ</suggestion>
      <suggestion>peterFWLXITPbAA</suggestion>
      <suggestion>peterwZHjddRtrm</suggestion>
      <suggestion>peteruUyOwVxMAb</suggestion>
      <suggestion>peterCRQChgQeOv</suggestion>
      <suggestion>peternWulmCvqjW</suggestion>
    </suggestionList>
  </autoCompleteResults>
  <status>OK</status>
</response>

Parameters:

authenticatedUser - Note: this method requires authentication, but for the reference implementation, anonymous access is granted.

dataGroups - filters based on MediaObject.MediaObjectType. Applicable values are face, keywords, metadata and object.

query - The query string for a suggestion. The query string is tokenized with character "32", and the last token is sent to the suggestion back-end.

limits - paging limits

Returns:

See AutoCompleteResult