Package net.bluemind.document.api

Interface IDocument

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

Document APIs.

Method Summary

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

Method Details

create

@PUT
@Path("{uid}")
void create(@PathParam("uid")
 String uid,
 Document doc)
     throws ServerFault

Creates a new Document entry

Parameters:

uid -

doc -

Throws:

ServerFault

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String uid,
 Document doc)
     throws ServerFault

Updates a Document entry

Parameters:

uid -

doc -

Throws:

ServerFault

delete

@DELETE
@Path("{uid}")
void delete(@PathParam("uid")
 String uid)
     throws ServerFault

Deletes a Document entry

Parameters:

uid -

Throws:

ServerFault

fetch

@GET
@Path("{uid}")
Document fetch(@PathParam("uid")
 String uid)
        throws ServerFault

Fetches a Document entry

Parameters:

uid -

Returns:

Throws:

ServerFault

fetchMetadata

@GET
@Path("{uid}/metadata")
DocumentMetadata fetchMetadata(@PathParam("uid")
 String uid)
                        throws ServerFault

Fetches Document metadata DocumentMetadata

Parameters:

uid -

Returns:

Throws:

ServerFault

list

@GET
@Path("_list")
List<DocumentMetadata> list()
                     throws ServerFault

Retrives all Document metadata DocumentMetadata

Returns:

Throws:

ServerFault