com.revo.deployr.client.api

Interface RProjectWorkspaceCalls

All Known Subinterfaces:

RProject

public interface RProjectWorkspaceCalls

Defines workspace related interfaces for DeployR managed project.

Method Summary

Modifier and Type	Method and Description
void	deleteObject(java.util.List<java.lang.String> objectNames) Delete objects in project workspace.
void	deleteObject(java.lang.String objectName) Delete objects in project workspace.
RData	getObject(java.lang.String objectName) Retrieve encoded objects from project workspace.
RData	getObject(java.lang.String objectName, boolean encodeDataFramePrimitiveAsVector) Retrieve encoded objects from project workspace.
java.util.List<RData>	getObjects(java.util.List<java.lang.String> objectNames) Retrieve encoded objects from project workspace.
java.util.List<RData>	getObjects(java.util.List<java.lang.String> objectNames, boolean encodeDataFramePrimitiveAsVector) Retrieve encoded objects from project workspace.
java.util.List<RData>	listObjects() List objects in project workspace.
java.util.List<RData>	listObjects(ProjectWorkspaceOptions options) List objects in project workspace.
void	loadObject(RRepositoryFile file) Load user repository object into project workspace.
void	pushObject(java.util.List<RData> objects) Push objects to project workspace.
void	pushObject(RData object) Push object to project workspace.
RProjectFile	saveObject(java.lang.String name, java.lang.String descr, boolean versioning) Save object from project workspace to project directory.
RRepositoryFile	storeObject(java.lang.String name, java.lang.String descr, boolean versioning, java.lang.String restricted, boolean shared, boolean published) Store object from project workspace to user repository.
void	transferObject(java.lang.String name, java.net.URL url) Transfer object to project workspace.
void	uploadObject(java.lang.String name, java.io.InputStream fileStream) Upload object to project workspace.

Method Detail

listObjects

java.util.List<RData> listObjects()
                           throws RClientException,
                                  RSecurityException

List objects in project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

listObjects

java.util.List<RData> listObjects(ProjectWorkspaceOptions options)
                           throws RClientException,
                                  RSecurityException

List objects in project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

getObject

RData getObject(java.lang.String objectName)
         throws RClientException,
                RSecurityException

Retrieve encoded objects from project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

getObject

RData getObject(java.lang.String objectName,
                boolean encodeDataFramePrimitiveAsVector)
         throws RClientException,
                RSecurityException

Retrieve encoded objects from project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

getObjects

java.util.List<RData> getObjects(java.util.List<java.lang.String> objectNames)
                          throws RClientException,
                                 RSecurityException

Retrieve encoded objects from project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

getObjects

java.util.List<RData> getObjects(java.util.List<java.lang.String> objectNames,
                                 boolean encodeDataFramePrimitiveAsVector)
                          throws RClientException,
                                 RSecurityException

Retrieve encoded objects from project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

uploadObject

void uploadObject(java.lang.String name,
                  java.io.InputStream fileStream)
           throws RClientException,
                  RSecurityException

Upload object to project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

transferObject

void transferObject(java.lang.String name,
                    java.net.URL url)
             throws RClientException,
                    RSecurityException

Transfer object to project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

pushObject

void pushObject(RData object)
         throws RClientException,
                RSecurityException,
                RDataException

Push object to project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

RDataException

pushObject

void pushObject(java.util.List<RData> objects)
         throws RClientException,
                RSecurityException,
                RDataException

Push objects to project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

RDataException

saveObject

RProjectFile saveObject(java.lang.String name,
                        java.lang.String descr,
                        boolean versioning)
                 throws RClientException,
                        RSecurityException

Save object from project workspace to project directory.

Throws:

RClientException - if RClient fails to complete call.

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

storeObject

RRepositoryFile storeObject(java.lang.String name,
                            java.lang.String descr,
                            boolean versioning,
                            java.lang.String restricted,
                            boolean shared,
                            boolean published)
                     throws RClientException,
                            RSecurityException

Store object from project workspace to user repository.

Throws:

RClientException - if RClient fails to complete call.

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

loadObject

void loadObject(RRepositoryFile file)
         throws RClientException,
                RSecurityException

Load user repository object into project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

deleteObject

void deleteObject(java.lang.String objectName)
           throws RClientException,
                  RSecurityException

Delete objects in project workspace.

Throws:

RClientException - if RClient fails to complete call.

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

deleteObject

void deleteObject(java.util.List<java.lang.String> objectNames)
           throws RClientException,
                  RSecurityException

Delete objects in project workspace.

Throws:

RClientException - if RClient fails to complete call.

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