@Produces(value={"application/xml","application/json"}) @Consumes(value={"application/xml","application/json"}) public interface ISourceDocResource extends SourceDocResource
RESOURCE_NAME_REGEX, RESOURCE_SLUG_REGEX, RESOURCE_SLUG_TEMPLATE, SERVICE_PATH
Modifier and Type | Method and Description |
---|---|
org.jboss.resteasy.client.ClientResponse<String> |
deleteResource(String idNoSlash)
Delete a Document.
|
org.jboss.resteasy.client.ClientResponse<List<ResourceMeta>> |
get(Set<String> extensions)
Retrieve the List of Documents (Resources) belonging to a Project
iteration.
|
org.jboss.resteasy.client.ClientResponse<Resource> |
getResource(String idNoSlash,
Set<String> extensions)
Retrieves information for a Document.
|
org.jboss.resteasy.client.ClientResponse<ResourceMeta> |
getResourceMeta(String idNoSlash,
Set<String> extensions)
Retrieves meta-data information for a Document.
|
org.jboss.resteasy.client.ClientResponse<String> |
post(Resource messageBody,
Set<String> extensions,
boolean copytrans)
Creates a new Document.
|
org.jboss.resteasy.client.ClientResponse<String> |
putResource(String idNoSlash,
Resource resource,
Set<String> extensions)
Deprecated.
|
org.jboss.resteasy.client.ClientResponse<String> |
putResource(String idNoSlash,
Resource resource,
Set<String> extensions,
boolean copytrans)
Creates or modifies a Document.
|
org.jboss.resteasy.client.ClientResponse<String> |
putResourceMeta(String idNoSlash,
ResourceMeta messageBody,
Set<String> extensions)
Modifies an existing document's meta-data.
|
head
@GET org.jboss.resteasy.client.ClientResponse<List<ResourceMeta>> get(@QueryParam(value="ext") Set<String> extensions)
SourceDocResource
get
in interface SourceDocResource
extensions
- The document extensions to fetch along with the documents
(e.g. "gettext", "comment"). This parameter allows multiple
values e.g. "ext=gettext&ext=comment".@POST org.jboss.resteasy.client.ClientResponse<String> post(Resource messageBody, @QueryParam(value="ext") Set<String> extensions, @QueryParam(value="copyTrans")@DefaultValue(value="true") boolean copytrans)
SourceDocResource
post
in interface SourceDocResource
messageBody
- The document information.extensions
- The document extensions to save with the new document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".copytrans
- Boolean value that indicates whether reasonably close
translations from other projects should be found to initially
populate this document's translations.@GET @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}") org.jboss.resteasy.client.ClientResponse<Resource> getResource(@PathParam(value="id") String idNoSlash, @QueryParam(value="ext") Set<String> extensions)
SourceDocResource
getResource
in interface SourceDocResource
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').extensions
- The document extensions to fetch along with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".@PUT @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}") org.jboss.resteasy.client.ClientResponse<String> putResource(@PathParam(value="id") String idNoSlash, Resource resource, @QueryParam(value="ext") Set<String> extensions, @QueryParam(value="copyTrans")@DefaultValue(value="true") boolean copytrans)
SourceDocResource
putResource
in interface SourceDocResource
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').resource
- The document information.extensions
- The document extensions to save with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".copytrans
- Boolean value that indicates whether reasonably close
translations from other projects should be found to initially
populate this document's translations.@PUT @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}") @Deprecated org.jboss.resteasy.client.ClientResponse<String> putResource(@PathParam(value="id") String idNoSlash, Resource resource, @QueryParam(value="ext") Set<String> extensions)
@DELETE @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}") org.jboss.resteasy.client.ClientResponse<String> deleteResource(@PathParam(value="id") String idNoSlash)
SourceDocResource
deleteResource
in interface SourceDocResource
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').@GET @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}/meta") org.jboss.resteasy.client.ClientResponse<ResourceMeta> getResourceMeta(@PathParam(value="id") String idNoSlash, @QueryParam(value="ext") Set<String> extensions)
SourceDocResource
getResourceMeta
in interface SourceDocResource
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').extensions
- The document extensions to retrieve with the document's
meta-data (e.g. "gettext", "comment"). This parameter allows
multiple values e.g. "ext=gettext&ext=comment".@PUT @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}/meta") org.jboss.resteasy.client.ClientResponse<String> putResourceMeta(@PathParam(value="id") String idNoSlash, ResourceMeta messageBody, @QueryParam(value="ext") Set<String> extensions)
SourceDocResource
putResourceMeta
in interface SourceDocResource
idNoSlash
- The document identifier. Some document ids could have forward
slashes ('/') in them which would cause conflicts with the
browser's own url interpreter. For this reason, the supplied
id must have all its '/' characters replaced with commas
(',').messageBody
- The document's meta-data.extensions
- The document extensions to save with the document (e.g.
"gettext", "comment"). This parameter allows multiple values
e.g. "ext=gettext&ext=comment".Copyright © 2015 Zanata Project. All rights reserved.