net.bluemind.document.api

Interface IDocument

All Known Implementing Classes:

DocumentService

@Path(value="/document/{containerUid}/{itemUid}")
public interface IDocument

Document APIs.

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String uid, Document doc) Creates a new Document entry
void	delete(java.lang.String uid) Deletes a Document entry
Document	fetch(java.lang.String uid) Fetches a Document entry
DocumentMetadata	fetchMetadata(java.lang.String uid) Fetches Document metadata DocumentMetadata
java.util.List<DocumentMetadata>	list() Retrives all Document metadata DocumentMetadata
void	update(java.lang.String uid, Document doc) Updates a Document entry

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       Document doc)
                                throws ServerFault

Creates a new Document entry

Parameters:

uid -

doc -

Throws:

ServerFault

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        Document doc)
                                 throws ServerFault

Updates a Document entry

Parameters:

uid -

doc -

Throws:

ServerFault

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Deletes a Document entry

Parameters:

uid -

Throws:

ServerFault

fetch

@GET
 @Path(value="{uid}")
Document fetch(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Fetches a Document entry

Parameters:

uid -

Returns:

Throws:

ServerFault

fetchMetadata

@GET
 @Path(value="{uid}/metadata")
DocumentMetadata fetchMetadata(@PathParam(value="uid")
                                                                   java.lang.String uid)
                                                            throws ServerFault

Fetches Document metadata DocumentMetadata

Parameters:

uid -

Returns:

Throws:

ServerFault

list

@GET
 @Path(value="_list")
java.util.List<DocumentMetadata> list()
                                                          throws ServerFault

Retrives all Document metadata DocumentMetadata

Returns:

Throws:

ServerFault