org.gcube.portlets.admin.fulltextindexportlet.gwt.client.interfaces
Interface ManagementServiceAsync


public interface ManagementServiceAsync

An asynchronous interface for the ManagementService following GWT RPC design


Method Summary
 void createIndex(String clusterID, String collectionID, String RIEPR, com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
          Creates a new Index for a specified collection
 void deleteIndexType(IndexTypeBean idxType, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
          Deletes an indexType from the IS.
 void getAllIndexTypes(com.google.gwt.user.client.rpc.AsyncCallback<Map<String,IndexTypeBean>> callback)
          Retrieves all the indexType descriptions from the IS.
 void getAvailableIndexTypeIDs(com.google.gwt.user.client.rpc.AsyncCallback<List<FullTextIndexTypeBean>> callback)
          A method to get FullTextIndexTypeBeans for every fulltext index type available in the VO
 void getCollections(com.google.gwt.user.client.rpc.AsyncCallback<List<CollectionBean>> callback)
           
 void getIndexTypeID(String indexID, com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
          A method to get the IndexTypeID of an Index
 void getIndices(String collectionID, com.google.gwt.user.client.rpc.AsyncCallback<IndexBean[]> callback)
          A method to get IndexBeans for every Index connected to a specific Collection
 void getResourceProperties(String indexID, com.google.gwt.user.client.rpc.AsyncCallback<MgmtPropertiesBean> callback)
          A method used to get information about the ResourceProperties of an Index
 void getRunningInstances(com.google.gwt.user.client.rpc.AsyncCallback<List<RunningInstanceBean>> callback)
          A method to get all the available FullTextIndexManagement service running instances
 void query(String queryString, String indexID, com.google.gwt.user.client.rpc.AsyncCallback<List<String>> callback)
           
 void removeIndex(String indexID, com.google.gwt.user.client.rpc.AsyncCallback<Boolean> callback)
          Removes/destroys an Index
 void saveIndexType(IndexTypeBean idxType, com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
          Saves an indexType to the IS.
 void updateIndex(String indexID, String rsLocator, com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
           
 

Method Detail

getRunningInstances

void getRunningInstances(com.google.gwt.user.client.rpc.AsyncCallback<List<RunningInstanceBean>> callback)
A method to get all the available FullTextIndexManagement service running instances

Parameters:
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

getCollections

void getCollections(com.google.gwt.user.client.rpc.AsyncCallback<List<CollectionBean>> callback)

getIndices

void getIndices(String collectionID,
                com.google.gwt.user.client.rpc.AsyncCallback<IndexBean[]> callback)
A method to get IndexBeans for every Index connected to a specific Collection

Parameters:
indexID - - the ID of the Collection to get the Indices from
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

getAvailableIndexTypeIDs

void getAvailableIndexTypeIDs(com.google.gwt.user.client.rpc.AsyncCallback<List<FullTextIndexTypeBean>> callback)
A method to get FullTextIndexTypeBeans for every fulltext index type available in the VO

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

getIndexTypeID

void getIndexTypeID(String indexID,
                    com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
A method to get the IndexTypeID of an Index

Parameters:
indexID - - The ID of the Index of which to get the IndexTypeID
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

getResourceProperties

void getResourceProperties(String indexID,
                           com.google.gwt.user.client.rpc.AsyncCallback<MgmtPropertiesBean> callback)
A method used to get information about the ResourceProperties of an Index

Parameters:
indexID - - The ID of the Index of which to get the ResourceProperties
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

createIndex

void createIndex(String clusterID,
                 String collectionID,
                 String RIEPR,
                 com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
Creates a new Index for a specified collection

Parameters:
clusterID - - The ID of the cluster to be created. Null if an ID should be asigned automatically.
collectionID - - the CollectionID of the Collection the Index should belong to
indexTypeID - - the IndexType of the Index to create (NULL allowed if ROWSETs used to update this index contain indexTypeID)
contentType - - the Content Type of the Index to create (usually MetaData or RealData)
RIEPR - - the EPR of the Running Instance to use for the index creation
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

removeIndex

void removeIndex(String indexID,
                 com.google.gwt.user.client.rpc.AsyncCallback<Boolean> callback)
Removes/destroys an Index

Parameters:
indexID - - The ID of the Index to destroy
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

query

void query(String queryString,
           String indexID,
           com.google.gwt.user.client.rpc.AsyncCallback<List<String>> callback)

updateIndex

void updateIndex(String indexID,
                 String rsLocator,
                 com.google.gwt.user.client.rpc.AsyncCallback<String> callback)

getAllIndexTypes

void getAllIndexTypes(com.google.gwt.user.client.rpc.AsyncCallback<Map<String,IndexTypeBean>> callback)
Retrieves all the indexType descriptions from the IS.

Parameters:
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

saveIndexType

void saveIndexType(IndexTypeBean idxType,
                   com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
Saves an indexType to the IS.

Parameters:
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework

deleteIndexType

void deleteIndexType(IndexTypeBean idxType,
                     com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
Deletes an indexType from the IS.

Parameters:
callback - - the AsyncCallback used to handle the asynchronous completion of the remote method, in accordance with the GWT RPC framework


Copyright © 2013. All Rights Reserved.