Package com.logicaldoc.webservice.rest

Interface FolderService

All Known Implementing Classes:

RestFolderService, RestFolderSwagger

@Consumes("application/json")
@Produces("application/json")
public interface FolderService

Method Summary

Modifier and Type	Method	Description
WSFolder	create(WSFolder folder)
long	createFolder(long parentId, String name)
WSFolder	createPath(long parentId, String path)
WSFolder	createSimple(String folderPath)
WSFolder	createSimpleForm(String folderPath)
WSFolder	createSimpleJSON(String jsonstr)
void	delete(long folderId)
WSFolder	findByPath(String path)	Finds the folder at the specified path
WSFolder	getFolder(long folderId)
WSFolder[]	getPath(long folderId)
String	getPathString(long folderId)
WSFolder	getRootFolder()	Gets the root folder
WSFolder[]	listChildren(long folderId)
void	move(long folderId, long parentId)
void	rename(long folderId, String name)
void	update(WSFolder folder)

Method Detail

create

@POST
@Path("/create")
WSFolder create(WSFolder folder)
         throws Exception

Throws:

Exception

createSimple

@POST
@Path("/createSimple")
@Consumes({"text/plain","application/json"})
WSFolder createSimple(String folderPath)
               throws Exception

Throws:

Exception

createSimpleForm

@POST
@Path("/createSimpleForm")
@Consumes("application/x-www-form-urlencoded")
WSFolder createSimpleForm(@FormParam("folderPath")
                          String folderPath)
                   throws Exception

Throws:

Exception

createSimpleJSON

@POST
@Path("/createSimpleJSON")
@Consumes("application/json")
WSFolder createSimpleJSON(String jsonstr)
                   throws Exception

Throws:

Exception

createPath

@POST
@Path("/createPath")
@Consumes("application/x-www-form-urlencoded")
WSFolder createPath(@FormParam("parentId")
                    long parentId,
                    @FormParam("path")
                    String path)
             throws Exception

Throws:

Exception

findByPath

@GET
@Path("/findByPath")
@Produces("application/json")
WSFolder findByPath(@QueryParam("path")
                    String path)
             throws Exception

Finds the folder at the specified path

Parameters:

path - the path

Returns:

the folder

Throws:

Exception - error in the server application

getRootFolder

@GET
@Path("/getRootFolder")
@Produces("application/json")
WSFolder getRootFolder()
                throws Exception

Gets the root folder

Returns:

the root folder

Throws:

Exception - error in the server application

createFolder

@POST
@Path("/createFolder")
@Consumes("application/x-www-form-urlencoded")
@Produces({"text/plain","application/json","application/xml"})
long createFolder(@FormParam("parentId")
                  long parentId,
                  @FormParam("name")
                  String name)
           throws Exception

Throws:

Exception

getFolder

@GET
@Path("/getFolder")
@Produces({"application/json","application/xml"})
WSFolder getFolder(@QueryParam("folderId")
                   long folderId)
            throws Exception

Throws:

Exception

delete

@DELETE
@Path("/delete")
void delete(@QueryParam("folderId")
            long folderId)
     throws Exception

Throws:

Exception

listChildren

@GET
@Path("/listChildren")
@Produces({"application/json","application/xml"})
WSFolder[] listChildren(@QueryParam("folderId")
                        long folderId)
                 throws Exception

Throws:

Exception

getPath

@GET
@Path("/getPath")
WSFolder[] getPath(@QueryParam("folderId")
                   long folderId)
            throws Exception

Throws:

Exception

getPathString

@GET
@Path("/getPathString")
String getPathString(@QueryParam("folderId")
                     long folderId)
              throws Exception

Throws:

Exception

update

@POST
@Path("/update")
void update(WSFolder folder)
     throws Exception

Throws:

Exception

rename

@PUT
@Path("/rename")
void rename(@QueryParam("folderId")
            long folderId,
            @QueryParam("name")
            String name)
     throws Exception

Throws:

Exception

move

@PUT
@Path("/move")
void move(@QueryParam("folderId")
          long folderId,
          @QueryParam("parentId")
          long parentId)
   throws Exception

Throws:

Exception