com.ibm.ram.rich.ui
Class RichClientUI

java.lang.Object
  extended by com.ibm.ram.rich.ui.RichClientUI

public class RichClientUI
extends java.lang.Object


Field Summary
static java.lang.String ACTION_CONSTANT_GROUP_RAM_ADDITIONS
          Group representing RAM's extended actions.
static java.lang.String ACTION_CONSTANT_GROUP_RAM_CORE
          Group representing RAM's core actions.
 
Method Summary
 RepositoryIdentification createRepositoryConnection(Shell shell, RepositoryIdentification toCreate)
          Asks the user to create a RAM repository connection.
 IRepositoryIdentifier createRepositoryConnection(Shell shell, java.lang.String suggestedURL)
          Asks the user to create a RAM repository connection.
static RichClientUI getInstance()
           
 ILabelProvider getRAMLabelProvider()
          Creates and returns a label provider for RAM.
 void search(SearchQuery query, RepositoryIdentification repository)
          Runs the provided query and shows results.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_CONSTANT_GROUP_RAM_CORE

public static final java.lang.String ACTION_CONSTANT_GROUP_RAM_CORE
Group representing RAM's core actions. Clients can use this group to control position of actions in their menus.

Since:
7.1.1
See Also:
Constant Field Values

ACTION_CONSTANT_GROUP_RAM_ADDITIONS

public static final java.lang.String ACTION_CONSTANT_GROUP_RAM_ADDITIONS
Group representing RAM's extended actions. Clients can use this group to control position of actions in their menus.

Since:
7.1.1
See Also:
Constant Field Values
Method Detail

getInstance

public static RichClientUI getInstance()

getRAMLabelProvider

public ILabelProvider getRAMLabelProvider()
Creates and returns a label provider for RAM.

Returns:

createRepositoryConnection

public IRepositoryIdentifier createRepositoryConnection(Shell shell,
                                                        java.lang.String suggestedURL)
Asks the user to create a RAM repository connection. A connection is returned if the creation was successful, else null is returned.

Parameters:
shell - Shell on which the user is asked to create a new connection
suggestedURL - Default RAM server URL.
Returns:

createRepositoryConnection

public RepositoryIdentification createRepositoryConnection(Shell shell,
                                                           RepositoryIdentification toCreate)
Asks the user to create a RAM repository connection. A connection is returned if the creation was successful, else null is returned.

Parameters:
shell - Shell on which the user is asked to create a new connection
serverID - Unique identifier of server.
suggestedURL - Default RAM server URL.
-
Returns:

search

public void search(SearchQuery query,
                   RepositoryIdentification repository)
            throws RAMRuntimeException
Runs the provided query and shows results. The query can be run against a single connection or against all selected repositories if none is provided.

Parameters:
query -
Throws:
RAMRuntimeException
Since:
7.1.1