@Path(value="/glossary") public class MockGlossaryResource extends Object implements GlossaryResource
GLOBAL_QUALIFIED_NAME, MAX_PAGE_SIZE, SERVICE_PATH
Constructor and Description |
---|
MockGlossaryResource() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
deleteAllEntries(String qualifiedName)
Delete all entries in a glossary.
|
javax.ws.rs.core.Response |
deleteEntry(Long id,
String qualifiedName)
Delete a glossary entry.
|
javax.ws.rs.core.Response |
downloadFile(String fileType,
String locales,
String qualifiedName)
Download all glossary entries as a file
|
javax.ws.rs.core.Response |
getDetails(LocaleId locale,
List<Long> termIds)
Get the details for a set of glossary terms.
|
javax.ws.rs.core.Response |
getEntries(LocaleId srcLocale,
LocaleId transLocale,
int page,
int sizePerPage,
String filter,
String sort,
String qualifiedName)
Returns a subset of Glossary entries for the given source and translation
locale as indicated by the paging parameters.
|
javax.ws.rs.core.Response |
getInfo(String qualifiedName)
Return source locales available for all glossary entries
|
javax.ws.rs.core.Response |
getQualifiedName()
Return default global glossary qualifiedName
|
javax.ws.rs.core.Response |
post(List<GlossaryEntry> glossaryEntries,
String locale,
String qualifiedName)
Create or update glossary entries.
|
javax.ws.rs.core.Response |
search(LocaleId srcLocale,
LocaleId transLocale,
int maxResults,
String searchText,
String projectSlug)
Returns Glossary entries based on a fuzzy text search.
|
javax.ws.rs.core.Response |
upload(GlossaryFileUploadForm glossaryFileUploadForm)
Upload glossary file (currently supported formats: po, csv)
|
public javax.ws.rs.core.Response getInfo(String qualifiedName)
GlossaryResource
getInfo
in interface GlossaryResource
qualifiedName
- Qualified name of glossary, default to GlossaryResource.GLOBAL_QUALIFIED_NAME
public javax.ws.rs.core.Response getEntries(LocaleId srcLocale, LocaleId transLocale, int page, int sizePerPage, String filter, String sort, String qualifiedName)
GlossaryResource
getEntries
in interface GlossaryResource
srcLocale
- Source locale - Required (default value: en-US).transLocale
- Translation localepage
- Current request page (default value: 1)sizePerPage
- Size of entry per page (default/max value: 1000)
GlossaryResource.MAX_PAGE_SIZE
filter
- String filter for source contentsort
- Fields to sort. Comma separated. e.g sort=desc,-part_of_speech
See GlossarySortField
qualifiedName
- Qualified name of glossary, default to GlossaryResource.GLOBAL_QUALIFIED_NAME
org.zanata.rest.dto.GlossaryEntry} for details on the result
list's contents.
public javax.ws.rs.core.Response search(LocaleId srcLocale, LocaleId transLocale, int maxResults, String searchText, String projectSlug)
GlossaryResource
search
in interface GlossaryResource
srcLocale
- Source localetransLocale
- Translation localemaxResults
- Maximum results for global and project queries. May return
up to double this number. Default: 20searchText
- Text containing terms to match in the search.projectSlug
- (optional) Project slug if a project glossary should be searched
in addition to the global glossary.org.zanata.rest.dto.GlossaryEntry} for details on the result
list's contents.
public javax.ws.rs.core.Response getDetails(LocaleId locale, List<Long> termIds)
GlossaryResource
getDetails
in interface GlossaryResource
locale
- include locale-specific detail for this localetermIds
- id for glossary terms in the default locale, found in
results of GlossaryResource.search(LocaleId, LocaleId, int, String, String)
public javax.ws.rs.core.Response downloadFile(@DefaultValue(value="csv") String fileType, String locales, String qualifiedName)
GlossaryResource
downloadFile
in interface GlossaryResource
fileType
- 'po' or 'csv' (case insensitive) are currently supportedlocales
- optional comma separated list of languages required.qualifiedName
- Qualified name of glossary, default to GlossaryResource.GLOBAL_QUALIFIED_NAME
public javax.ws.rs.core.Response post(List<GlossaryEntry> glossaryEntries, String locale, String qualifiedName)
GlossaryResource
post
in interface GlossaryResource
glossaryEntries
- The glossary entries to create/updatelocale
- Locale to which the given glossary entries belongqualifiedName
- Qualified name of glossary, defaults to GlossaryResource.GLOBAL_QUALIFIED_NAME
public javax.ws.rs.core.Response getQualifiedName()
GlossaryResource
getQualifiedName
in interface GlossaryResource
public javax.ws.rs.core.Response upload(GlossaryFileUploadForm glossaryFileUploadForm)
GlossaryResource
upload
in interface GlossaryResource
glossaryFileUploadForm
- Multi-part form with the following named parts: public javax.ws.rs.core.Response deleteEntry(Long id, String qualifiedName)
GlossaryResource
deleteEntry
in interface GlossaryResource
id
- id for source glossary termqualifiedName
- Qualified name of glossary, defaults to GlossaryResource.GLOBAL_QUALIFIED_NAME
public javax.ws.rs.core.Response deleteAllEntries(String qualifiedName)
GlossaryResource
deleteAllEntries
in interface GlossaryResource
qualifiedName
- Qualified name of glossary, defaults to GlossaryResource.GLOBAL_QUALIFIED_NAME
Copyright © 2018 Zanata Project. All rights reserved.