org.gcube.portlets.admin.irbootstrapperportlet.gwt.client.interfaces
Interface IRBootstrapperService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
IRBootstrapperServiceImpl

public interface IRBootstrapperService
extends com.google.gwt.user.client.rpc.RemoteService

A RemoteService interface for the IRBootstrapper service following GWT RPC design

Author:
Spyros Boutsis, NKUA

Method Summary
 void cancelSubmittedJob(String jobUID)
          A method to cancel a submitted job.
 void deleteJob(JobUIElement job)
          A method to delete an existing
 List<JobTypeUIElement> getAllJobsPerJobType()
          A method to get all the jobs available per each job type
 JobAutoCompleteData getAutoCompleteData()
          A method to retrieve auto-complete data for all the available jobs
 List<ResourceTypeUIElement> getJobs()
          A method to get all the jobs available for each resource
 JobUIElement getSubmittedJobByUID(String jobUID)
          A method to get a submitted job, given its UID.
 List<ResourceTypeUIElement> getSubmittedJobs()
          A method to get all the submitted jobs available for each resource
 void initialize()
          This method performs initialization tasks (such as parsing the IRBootstrapepr configuration in the current scope) and must be invoked when the portlet is initialized.
 List<ResourceTypeUIElement> refreshAndGetJobs()
          A method to refresh the list of available jobs for each resource and retrieve it
 void removeSubmittedJob(String jobUID)
          A method to remove a submitted job.
 String saveJob(JobUIElement job)
          A method to save a new or modified job
 String submitJobForExecution(String jobUID, Map<String,String> userInputs)
          A method to submit a job for execution.
 String submitJobsForBatchExecution(ArrayList<String> jobsUIDs, Map<String,String> userInputs)
           
 

Method Detail

initialize

void initialize()
                throws Exception
This method performs initialization tasks (such as parsing the IRBootstrapepr configuration in the current scope) and must be invoked when the portlet is initialized.

Throws:
Exception - Server side exception as dictated by GWTs RPC framework

getJobs

List<ResourceTypeUIElement> getJobs()
                                    throws Exception
A method to get all the jobs available for each resource

Returns:
the list of jobs
Throws:
Exception - Server side exception as dictated by GWTs RPC framework

refreshAndGetJobs

List<ResourceTypeUIElement> refreshAndGetJobs()
                                              throws Exception
A method to refresh the list of available jobs for each resource and retrieve it

Returns:
the list of jobs
Throws:
Exception - Server side exception as dictated by GWTs RPC framework

getSubmittedJobs

List<ResourceTypeUIElement> getSubmittedJobs()
                                             throws Exception
A method to get all the submitted jobs available for each resource

Returns:
the list of submitted jobs
Throws:
Exception - Server side exception as dictated by GWTs RPC framework

getSubmittedJobByUID

JobUIElement getSubmittedJobByUID(String jobUID)
                                  throws Exception
A method to get a submitted job, given its UID.

Parameters:
the - UID of the job to get
Returns:
the job UI element
Throws:
Exception - Server side exception as dictated by GWTs RPC framework

submitJobForExecution

String submitJobForExecution(String jobUID,
                             Map<String,String> userInputs)
                             throws Exception
A method to submit a job for execution.

Parameters:
jobUID - the UID of the job to submit for execution
Throws:
Exception

submitJobsForBatchExecution

String submitJobsForBatchExecution(ArrayList<String> jobsUIDs,
                                   Map<String,String> userInputs)
                                   throws Exception
Throws:
Exception

cancelSubmittedJob

void cancelSubmittedJob(String jobUID)
                        throws Exception
A method to cancel a submitted job.

Parameters:
jobUID - the UID of the job to cancel
Throws:
Exception

removeSubmittedJob

void removeSubmittedJob(String jobUID)
                        throws Exception
A method to remove a submitted job.

Parameters:
jobUID - the UID of the job to remove
Throws:
Exception

getAllJobsPerJobType

List<JobTypeUIElement> getAllJobsPerJobType()
                                            throws Exception
A method to get all the jobs available per each job type

Returns:
the list of jobs per job type
Throws:
Exception - Server side exception as dictated by GWTs RPC framework

saveJob

String saveJob(JobUIElement job)
               throws Exception
A method to save a new or modified job

Parameters:
job - the job to save
Returns:
the saved jobUID
Throws:
Exception - Server side exception as dictated by GWTs RPC framework

deleteJob

void deleteJob(JobUIElement job)
               throws Exception
A method to delete an existing

Parameters:
job - the job to delete
Throws:
Exception - Server side exception as dictated by GWTs RPC framework

getAutoCompleteData

JobAutoCompleteData getAutoCompleteData()
                                        throws Exception
A method to retrieve auto-complete data for all the available jobs

Returns:
the auto-complete data structure
Throws:
Exception


Copyright © 2013. All Rights Reserved.