com.revo.deployr.client.api

Interface RUserProjectCalls

All Known Subinterfaces:

RUser

public interface RUserProjectCalls

Defines project related interfaces for DeployR-managed user.

Method Summary

Modifier and Type	Method and Description
void	autosaveProjects(boolean save) Enabled/disable project auto-save semantics for duration of user session.
RProject	createProject() Create a temporary project.
RProject	createProject(ProjectCreationOptions options) Create a temporary project.
RProject	createProject(java.lang.String name, java.lang.String descr) Create a named persistent project.
RProject	createProject(java.lang.String name, java.lang.String descr, ProjectCreationOptions adoptions) Create a named persistent project based on adoptions from existing projects.
java.util.List<RProject>	createProjectPool(int poolSize, ProjectCreationOptions options) Create a pool of temporary projects.
RProject	getProject(java.lang.String pid) Retrieve project reference.
RProject	importProject(java.io.InputStream fileStream, java.lang.String descr) Import project.
java.util.List<RProject>	listProjects() List projects.
java.util.List<RProject>	listProjects(boolean sortByLastModified, boolean showPublicProjects) List projects.
void	releaseProjects() Releases all server-wide live project grid resources associated with this user.

Method Detail

autosaveProjects

void autosaveProjects(boolean save)
               throws RClientException,
                      RSecurityException

Enabled/disable project auto-save semantics for duration of user session.

Parameters:

save - true to enable auto-save of projects on close or logout.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

releaseProjects

void releaseProjects()
              throws RClientException,
                     RSecurityException

Releases all server-wide live project grid resources associated with this user.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

createProject

RProject createProject()
                throws RClientException,
                       RSecurityException,
                       RDataException,
                       RGridException

Create a temporary project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

createProject

RProject createProject(ProjectCreationOptions options)
                throws RClientException,
                       RSecurityException,
                       RDataException,
                       RGridException

Create a temporary project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

createProjectPool

java.util.List<RProject> createProjectPool(int poolSize,
                                           ProjectCreationOptions options)
                                    throws RClientException,
                                           RSecurityException,
                                           RDataException,
                                           RGridException

Create a pool of temporary projects.

Returns:

List<RProject>

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

createProject

RProject createProject(java.lang.String name,
                       java.lang.String descr)
                throws RClientException,
                       RSecurityException,
                       RDataException,
                       RGridException

Create a named persistent project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

createProject

RProject createProject(java.lang.String name,
                       java.lang.String descr,
                       ProjectCreationOptions adoptions)
                throws RClientException,
                       RSecurityException,
                       RDataException,
                       RGridException

Create a named persistent project based on adoptions from existing projects.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

getProject

RProject getProject(java.lang.String pid)
             throws RClientException,
                    RSecurityException

Retrieve project reference.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

listProjects

java.util.List<RProject> listProjects()
                               throws RClientException,
                                      RSecurityException

List projects.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

listProjects

java.util.List<RProject> listProjects(boolean sortByLastModified,
                                      boolean showPublicProjects)
                               throws RClientException,
                                      RSecurityException

List projects.

Parameters:

sortByLastModified - true is projects to be sorted by last modified date.

showPublicProjects - true is projects list to include public projects.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

importProject

RProject importProject(java.io.InputStream fileStream,
                       java.lang.String descr)
                throws RClientException,
                       RSecurityException

Import project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.