org.gcube.portlets.admin.forwardindexportlet.gwt.client.interfaces

Interface ManagementServiceAsync

public interface ManagementServiceAsync

An asynchronous interface for the ManagementService following GWT RPC design

Method Summary

Methods

Modifier and Type	Method and Description
void	createIndex(String indexID, String collectionID, String[] keyNames, String[] indexTypeIDs, 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<ForwardIndexTypeBean>> 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) A method to get all collection beans of collections gathered from DIS (real collections) along with all collection beans of collectionIDs indices are stated to belong to (in their collectionID property) but which do not exist in reality (fake collections)
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, String collectionID, com.google.gwt.user.client.rpc.AsyncCallback<Boolean> callback)
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)

A method to get all collection beans of collections gathered from DIS (real collections) along with all collection beans of collectionIDs indices are stated to belong to (in their collectionID property) but which do not exist in reality (fake collections)

Parameters:

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

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<ForwardIndexTypeBean>> 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

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 indexID,
               String collectionID,
               String[] keyNames,
               String[] indexTypeIDs,
               String RIEPR,
               com.google.gwt.user.client.rpc.AsyncCallback<String> callback)

Creates a new Index for a specified collection

Parameters:

indexID - - The ID of the Index to be created. Null if an ID should be asigned automatically.

collectionID - - the CollectionID of the Collection the Index should belong to

keyNames - - the names of the keys of the Index to create

indexTypeIDs - - the IndexTypes of the keys of the Index to create

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,
               String collectionID,
               com.google.gwt.user.client.rpc.AsyncCallback<Boolean> 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

updateIndex

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

query

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