net.sf.basedb.ws.server
Class ProjectService

java.lang.Object
  net.sf.basedb.ws.server.AbstractRPCService
      net.sf.basedb.ws.server.ProjectService

public class ProjectService
extends AbstractRPCService

Web service class for Project Project.

Version:

2.5

Author:

Nicklas, Martin

Field Summary

Fields inherited from class net.sf.basedb.ws.server.AbstractRPCService

util

Constructor Summary

ProjectService()

Method Summary

ProjectInfo	getById(String ID, int itemId) Get information about a project that you know the ID of.
ProjectInfo[]	getProjects(String ID, QueryOptions qOpt) Gets information about projects that are available for an active session.
String	setActiveProject(String ID, int projectId) Sets a project active

Methods inherited from class net.sf.basedb.ws.server.AbstractRPCService

attachFile, getRemoteId, getSessionControl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectService

public ProjectService()

Method Detail

getById

public ProjectInfo getById(String ID,
                           int itemId)

Get information about a project that you know the ID of.

Parameters:

ID - Id to identify the session.

itemId - The ID of the project

Returns:

The project information

setActiveProject

public String setActiveProject(String ID,
                               int projectId)

Sets a project active

Parameters:

ID - Id to identify the active session

projectId - Id of the project to set as active

Returns:

The Session ID

getProjects

public ProjectInfo[] getProjects(String ID,
                                 QueryOptions qOpt)

Gets information about projects that are available for an active session.

Parameters:

ID - Id to identify the session.

qOpt - QueryOptions to use when getting the projects

Returns:

Information objects in an array for each found project.