com.imsweb.seerapi.client.glossary

Interface GlossaryService

public interface GlossaryService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<GlossaryChangelogResults>	changelogs(java.lang.String version, java.lang.String fromDate, java.lang.String toDate, java.lang.Integer count) Return the changelog entries for the passed database version
retrofit2.Call<Glossary>	getById(java.lang.String version, java.lang.String id) Return a complete glossary entity based in identifier
retrofit2.Call<GlossarySearchResults>	search(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> searchParams) Return a list of matching glossaries
retrofit2.Call<GlossarySearchResults>	search(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> searchParams, java.util.Set<Glossary.Category> categories) Return a list of matching glossaries
retrofit2.Call<GlossarySearchResults>	search(java.lang.String version, java.lang.String query) Return a list of matching glossaries
retrofit2.Call<GlossarySearchResults>	search(java.lang.String version, java.lang.String query, java.util.Set<Glossary.Category> categories) Return a list of matching glossaries
retrofit2.Call<java.util.List<GlossaryVersion>>	versions() Return a list of all glossary versions and information about them

Method Detail

versions

@GET(value="glossary/versions")
retrofit2.Call<java.util.List<GlossaryVersion>> versions()

Return a list of all glossary versions and information about them

Returns:

a list of GlossaryVersion objects

getById

@GET(value="glossary/{version}/id/{id}")
retrofit2.Call<Glossary> getById(@Path(value="version")
                                                                          java.lang.String version,
                                                                          @Path(value="id")
                                                                          java.lang.String id)

Return a complete glossary entity based in identifier

Parameters:

version - Glossary version

id - Glossary identifier

Returns:

a Glossary object

search

@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
                                                                              java.lang.String version,
                                                                              @Query(value="q")
                                                                              java.lang.String query)

Return a list of matching glossaries

Parameters:

version - Glossary version

query - search query

Returns:

a GlossarySearchResults object

search

@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
                                                                              java.lang.String version,
                                                                              @Query(value="q")
                                                                              java.lang.String query,
                                                                              @Query(value="category")
                                                                              java.util.Set<Glossary.Category> categories)

Return a list of matching glossaries

Parameters:

version - Glossary version

query - search query

categories - a list of categories

Returns:

a GlossarySearchResults object

search

@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
                                                                              java.lang.String version,
                                                                              @QueryMap
                                                                              java.util.Map<java.lang.String,java.lang.String> searchParams)

Return a list of matching glossaries

Parameters:

version - Glossary version

searchParams - A Map of search parameters. Use GlossarySearch to easily build parameter list.

Returns:

a GlossarySearchResults object

search

@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
                                                                              java.lang.String version,
                                                                              @QueryMap
                                                                              java.util.Map<java.lang.String,java.lang.String> searchParams,
                                                                              @Query(value="category")
                                                                              java.util.Set<Glossary.Category> categories)

Return a list of matching glossaries

Parameters:

version - Glossary version

searchParams - A Map of search parameters. Use GlossarySearch to easily build parameter list.

categories - a list of categories

Returns:

a GlossarySearchResults object

changelogs

@GET(value="glossary/{version}/changelog")
retrofit2.Call<GlossaryChangelogResults> changelogs(@Path(value="version")
                                                                                               java.lang.String version,
                                                                                               @Query(value="from")
                                                                                               java.lang.String fromDate,
                                                                                               @Query(value="to")
                                                                                               java.lang.String toDate,
                                                                                               @Query(value="count")
                                                                                               java.lang.Integer count)

Return the changelog entries for the passed database version

Parameters:

version - Glossary version

fromDate - if not null, only include changes from this date forward (YYYY-MM-DD)

toDate - if not null, only include changes prior to this date (YYYY-MM-DD)

count - if not null, limit the number returned

Returns:

a list of GlossaryChangelogResults objects