com.revo.deployr.client

Interface RProject

All Superinterfaces:

RProjectDirectoryCalls, RProjectExecuteCalls, RProjectPackageCalls, RProjectWorkspaceCalls

public interface RProject
extends RProjectExecuteCalls, RProjectWorkspaceCalls, RProjectDirectoryCalls, RProjectPackageCalls

Represents a DeployR managed project.

Method Summary

Methods

Modifier and Type	Method and Description
RProjectDetails	about() About project.
void	close() Close project.
void	close(ProjectCloseOptions options) Close project.
void	delete() Delete project.
java.io.InputStream	export() Export project.
RProjectDetails	grant(java.lang.String username) Grant project authorship to another user.
boolean	ping() Ping project.
RProjectDetails	recycle() Recycle R session on project.
RProjectDetails	recycle(boolean preserveWorkspace, boolean preserveDirectory) Recycle R session on project.
RProjectDetails	save() Save project.
RProjectDetails	save(RProjectDetails details) Save project.
RProjectDetails	save(RProjectDetails details, ProjectDropOptions dropOptions) Save project.
RProject	saveAs(RProjectDetails details) Save-as project.
RProject	saveAs(RProjectDetails details, ProjectDropOptions dropOptions) Save-as project.
RProjectDetails	update(RProjectDetails about) Update project.

Methods inherited from interface com.revo.deployr.client.api.RProjectExecuteCalls

deleteResults, downloadResults, executeCode, executeCode, executeExternal, executeScript, executeScript, executeScript, executeScript, flushHistory, getConsole, getHistory, interruptExecution, listResults

Methods inherited from interface com.revo.deployr.client.api.RProjectWorkspaceCalls

deleteObject, deleteObject, getObject, getObject, getObjects, getObjects, listObjects, listObjects, loadObject, pushObject, pushObject, saveObject, storeObject, transferObject, uploadObject

Methods inherited from interface com.revo.deployr.client.api.RProjectDirectoryCalls

downloadFiles, downloadFiles, listFiles, loadFile, transferFile, uploadFile, writeFile

Methods inherited from interface com.revo.deployr.client.api.RProjectPackageCalls

attachPackage, attachPackage, detachPackage, detachPackage, listPackages

Method Detail

about

RProjectDetails about()

About project.

See Also:

RProjectDetails

ping

boolean ping()
             throws RClientException,
                    RSecurityException

Ping project.

Throws:

RClientException - if RClient fails to complete call.

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

update

RProjectDetails update(RProjectDetails about)
                       throws RClientException,
                              RSecurityException

Update project.

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProjectDetails

grant

RProjectDetails grant(java.lang.String username)
                      throws RClientException,
                             RSecurityException

Grant project authorship to another user.

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProjectDetails

save

RProjectDetails save()
                     throws RClientException,
                            RSecurityException

Save project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProjectDetails

save

RProjectDetails save(RProjectDetails details)
                     throws RClientException,
                            RSecurityException

Save project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProjectDetails

save

RProjectDetails save(RProjectDetails details,
                   ProjectDropOptions dropOptions)
                     throws RClientException,
                            RSecurityException

Save project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProjectDetails

saveAs

RProject saveAs(RProjectDetails details)
                throws RClientException,
                       RSecurityException

Save-as project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProject

saveAs

RProject saveAs(RProjectDetails details,
              ProjectDropOptions dropOptions)
                throws RClientException,
                       RSecurityException

Save-as project.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProject

recycle

RProjectDetails recycle()
                        throws RClientException,
                               RSecurityException

Recycle R session on project.

Recycles the R session associated with the project by deleting all R objects from the workspace and all files from the working directory.

Recommended for temporary and blackbox projects. Recycle persistent projects with caution as this operation can not be reversed.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProjectDetails

recycle

RProjectDetails recycle(boolean preserveWorkspace,
                      boolean preserveDirectory)
                        throws RClientException,
                               RSecurityException

Recycle R session on project.

Recycles the R session associated with the project by deleting all R objects from the workspace and all files from the working directory.

Workspace objects and/or directory files can be preserved on a recycle by enabling the respective parameter.

Recycling a project is a convenient and efficient alternative to starting over by closing an existing project and then creating a new project.

Recommended for temporary and blackbox projects. Recycle persistent projects with caution as this operation can not be reversed.

Returns:

RProject

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RProjectDetails

close

void close()
           throws RClientException,
                  RSecurityException

Close project.

Throws:

RClientException - if RClient fails to complete call.

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

close

void close(ProjectCloseOptions options)
           throws RClientException,
                  RSecurityException

Close project.

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

ProjectCloseOptions

delete

void delete()
            throws RClientException,
                   RSecurityException

Delete project.

Throws:

RClientException - if RClient fails to complete call.

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

export

java.io.InputStream export()
                           throws RClientException,
                                  RSecurityException

Export project.

Throws:

RClientException - if RClient fails to complete call.

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