com.ibm.carma.model
Interface RepositoryManager

All Superinterfaces:
CustomActionAccepter, org.eclipse.emf.ecore.EObject, Filterable, org.eclipse.core.runtime.IAdaptable, org.eclipse.emf.common.notify.Notifier, TransportConnectionListener

public interface RepositoryManager
extends Filterable, CustomActionAccepter, TransportConnectionListener

A representation of the model object 'Repository Manager'. A represenation of a Repository manager type. For example:

The following features are supported:

See Also:
ModelPackage.getRepositoryManager()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface com.ibm.carma.model.Filterable
WILDCARD
 
Method Summary
 void connect(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters)
          Loads and connects to the repository manager, activating the repository manager connection.
 void disconnect(org.eclipse.core.runtime.IProgressMonitor pm)
          Shuts down the connection to the host that CARMA is using to execute commands Unloads and disconnects from the Repository access manager, marking the connection as inactive
 org.eclipse.emf.common.util.EList getActions()
          Returns the value of the 'Actions' containment reference list.
 CARMA getCARMA()
          Returns the value of the 'CARMA' container reference.
 org.eclipse.emf.common.util.EList getCustomActions()
          Returns the value of the 'Custom Actions' containment reference list.
 java.lang.String getDescription()
          Returns the value of the 'Description' attribute.
 org.eclipse.emf.common.util.EList getFields()
          Returns the value of the 'Fields' containment reference list.
 java.util.Date getLastConfigurationRefreshTime()
          Returns the value of the 'Last Configuration Refresh Time' attribute.
 java.util.Date getLastRefreshTime()
          Returns the value of the 'Last Refresh Time' attribute.
 java.lang.String getLevel()
          Returns the value of the 'Level' attribute.
 java.lang.String getManagerId()
          Returns the value of the 'Manager Id' attribute.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 org.eclipse.emf.common.util.EList getRepositoryInstances()
          Returns the value of the 'Repository Instances' containment reference list.
 java.lang.String getVersion()
          Returns the value of the 'Version' attribute.
 boolean isConfigurationValid()
          Returns the value of the 'Configuration Valid' attribute.
 boolean isConnected()
          Returns the value of the 'Connected' attribute.
 boolean isSetActions()
          Returns whether the value of the 'Actions' containment reference list is set.
 boolean isSetFields()
          Returns whether the value of the 'Fields' containment reference list is set.
 boolean isSetRepositoryInstances()
          Returns whether the value of the 'Repository Instances' containment reference list is set.
 void refreshConfiguration(org.eclipse.core.runtime.IProgressMonitor pm, boolean sendNotification)
          Refreshes the custom action and field configuration for the Repository Manager.
 
Methods inherited from interface com.ibm.carma.model.Filterable
getFilters, isFilterReady, refresh, refresh, refreshWithAllMemberInfo, refreshWithMemberInfo, removeFilter, resolveFilter
 
Methods inherited from interface com.ibm.carma.model.CustomActionAccepter
findActionFor, markActionUnsupported, performAction
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface com.ibm.carma.model.TransportConnectionListener
connectionStateChanged
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getManagerId

java.lang.String getManagerId()
Returns the value of the 'Manager Id' attribute. Unique identifier of the Repository manager

Returns:
the value of the 'Manager Id' attribute.
See Also:
ModelPackage.getRepositoryManager_ManagerId()

getName

java.lang.String getName()
Returns the value of the 'Name' attribute. Displayable name of the Repository Manager

Returns:
the value of the 'Name' attribute.
See Also:
ModelPackage.getRepositoryManager_Name()

getVersion

java.lang.String getVersion()
Returns the value of the 'Version' attribute. SCM repository version

Returns:
the value of the 'Version' attribute.
See Also:
ModelPackage.getRepositoryManager_Version()

getLevel

java.lang.String getLevel()
Returns the value of the 'Level' attribute. Version of the RAM on the host

Returns:
the value of the 'Level' attribute.
See Also:
ModelPackage.getRepositoryManager_Level()

getDescription

java.lang.String getDescription()
Returns the value of the 'Description' attribute. Repository Manager description

Returns:
the value of the 'Description' attribute.
See Also:
ModelPackage.getRepositoryManager_Description()

getLastRefreshTime

java.util.Date getLastRefreshTime()
Returns the value of the 'Last Refresh Time' attribute. Last time the Repository Manager was synchronized with the server.

Returns:
the value of the 'Last Refresh Time' attribute.
See Also:
ModelPackage.getRepositoryManager_LastRefreshTime()

getRepositoryInstances

org.eclipse.emf.common.util.EList getRepositoryInstances()
                                                         throws NotSynchronizedException
Returns the value of the 'Repository Instances' containment reference list. The list contents are of type RepositoryInstance. It is bidirectional and its opposite is 'Repository Manager'. The repository instances (projects) that exist within the defined Repository Manager.

Returns:
the value of the 'Repository Instances' containment reference list.
Throws:
NotSynchronizedException - Exeception is thrown when the a refresh operation is required because the Repository Instance List has not been initialized.
See Also:
isSetRepositoryInstances(), ModelPackage.getRepositoryManager_RepositoryInstances(), RepositoryInstance.getRepositoryManager()

isSetRepositoryInstances

boolean isSetRepositoryInstances()
Returns whether the value of the 'Repository Instances' containment reference list is set. Returns true if the Repository Instance list has been initialized

Returns:
whether the value of the 'Repository Instances' containment reference list is set.
See Also:
getRepositoryInstances()

getActions

org.eclipse.emf.common.util.EList getActions()
                                             throws NotSynchronizedException
Returns the value of the 'Actions' containment reference list. The list contents are of type Action. List of action descriptions for default and custom actions defined for the repository manager

Returns:
the value of the 'Actions' containment reference list.
Throws:
NotSynchronizedException - Exeception is thrown when the a connect operation is required because the Actions List has not been initialized.
See Also:
isSetActions(), ModelPackage.getRepositoryManager_Actions()

isSetActions

boolean isSetActions()
Returns whether the value of the 'Actions' containment reference list is set. Returns true if the Actions list has been initialized

Returns:
whether the value of the 'Actions' containment reference list is set.
See Also:
getActions()

getFields

org.eclipse.emf.common.util.EList getFields()
                                            throws NotSynchronizedException
Returns the value of the 'Fields' containment reference list. The list contents are of type Field. List of fields used to describe CARMA resources in display content

Returns:
the value of the 'Fields' containment reference list.
Throws:
NotSynchronizedException - Exeception is thrown when the a connect operation is required because the Fields List has not been initialized.
See Also:
isSetFields(), ModelPackage.getRepositoryManager_Fields()

isSetFields

boolean isSetFields()
Returns whether the value of the 'Fields' containment reference list is set. Returns true if the Fields list has been initialized

Returns:
whether the value of the 'Fields' containment reference list is set.
See Also:
getFields()

connect

void connect(org.eclipse.core.runtime.IProgressMonitor pm,
             java.lang.Object[] parameters)
             throws org.eclipse.core.runtime.CoreException,
                    NotConnectedException
Loads and connects to the repository manager, activating the repository manager connection. The connect action specification can be located using the CustomActionAccepter.findActionFor(String) method and inspecting the action object returned. The parameter array is expected to consist of object values of the type defined by the action parameter list in the order specified by the parameter list.

The parameters array should:

Loads and connects to the repository manager, activating the repository manager connection. The list of actions, fields, and repository managers are also initialized with content retireved from the host

Parameters:
pm - progress monitor for the operation
parameters - the set of parameters required for the method to execute properly
Throws:
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
See Also:
ActionIdentifier.CONNECT_RAM

disconnect

void disconnect(org.eclipse.core.runtime.IProgressMonitor pm)
                throws org.eclipse.core.runtime.CoreException
Shuts down the connection to the host that CARMA is using to execute commands Unloads and disconnects from the Repository access manager, marking the connection as inactive

Parameters:
pm - progress monitor for the operation
Throws:
org.eclipse.core.runtime.CoreException - An error occured during execution of the command

refreshConfiguration

void refreshConfiguration(org.eclipse.core.runtime.IProgressMonitor pm,
                          boolean sendNotification)
                          throws org.eclipse.core.runtime.CoreException,
                                 NotConnectedException
Refreshes the custom action and field configuration for the Repository Manager. After completion of this method the getActions() and getFields() accessors should have the most recent information as determined by the host.

Parameters:
pm - progress monitor for the operation
sendNotification - set to true if notification messages should be issued from changes made during the refresh operation
Throws:
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.

isConnected

boolean isConnected()
Returns the value of the 'Connected' attribute. The default value is "false". Set to true when the Repository manager is actively connected to the server.

Returns:
the value of the 'Connected' attribute.
See Also:
ModelPackage.getRepositoryManager_Connected()

getCustomActions

org.eclipse.emf.common.util.EList getCustomActions()
                                                   throws NotSynchronizedException
Returns the value of the 'Custom Actions' containment reference list. The list contents are of type Action. Returns the "custom" actions associated with the repository manager. The action is known to be a "custom" action if the Action.isCustom() method returns true.

Returns:
the value of the 'Custom Actions' containment reference list.
Throws:
NotSynchronizedException
See Also:
ModelPackage.getRepositoryManager_CustomActions()

getLastConfigurationRefreshTime

java.util.Date getLastConfigurationRefreshTime()
Returns the value of the 'Last Configuration Refresh Time' attribute. Timestamp of the last time that the configuration for this RAM has been gathered from the host.

Returns:
the value of the 'Last Configuration Refresh Time' attribute.
See Also:
ModelPackage.getRepositoryManager_LastConfigurationRefreshTime()

isConfigurationValid

boolean isConfigurationValid()
Returns the value of the 'Configuration Valid' attribute. The default value is "false". Flag to indicate that the configuration is valid for the RAM. If the configuration is invalid, then it should be refreshed.

Returns:
the value of the 'Configuration Valid' attribute.
See Also:
ModelPackage.getRepositoryManager_ConfigurationValid()

getCARMA

CARMA getCARMA()
Returns the value of the 'CARMA' container reference. It is bidirectional and its opposite is 'Repository Managers'. CARMA object managing the connection used by the repository manager

Returns:
the value of the 'CARMA' container reference.
See Also:
ModelPackage.getRepositoryManager_CARMA(), CARMA.getRepositoryManagers()