com.ibm.carma.model
Interface Filterable

All Superinterfaces:
CustomActionAccepter, org.eclipse.emf.ecore.EObject, org.eclipse.core.runtime.IAdaptable, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
CARMAContainer, RepositoryInstance, RepositoryManager, ResourceContainer

public interface Filterable
extends CustomActionAccepter

A representation of the model object 'Filterable'. Resource which contains host-filterable child content

The following features are supported:

Since:
7.0
See Also:
ModelPackage.getFilterable()

Field Summary
static java.lang.String copyright
           
static java.lang.String WILDCARD
          The default filter string for the refresh operation
 
Method Summary
 org.eclipse.emf.common.util.EList getFilters()
          Returns the value of the 'Filters' attribute list.
 boolean isFilterReady(java.lang.String filter)
          Returns a value of true when the given filter string exists and cached
 CARMAReturn refresh(org.eclipse.core.runtime.IProgressMonitor pm, int depth, boolean sendNotification, java.lang.Object[] parameters)
          Refreshes/updates the cached copy of the content information from the host The refresh action specification can be located using the CustomActionAccepter.findActionFor(String) method and inspecting the action object returned.
 CARMAReturn refresh(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String filter, int depth, boolean sendNotification, java.lang.Object[] parameters)
          Refreshes/updates the cached copy of the content information from the host using the given filter string.
 CARMAReturn refreshWithAllMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String filter, int depth, boolean sendNotification, java.lang.Object[] parameters)
          Refreshes/updates the cached copy of the content information from the host using the given filter string.
 CARMAReturn refreshWithMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String filter, int depth, boolean sendNotification, java.lang.String[] keys, java.lang.Object[] parameters)
          Refreshes/updates the cached copy of the content information from the host using the given filter string.
 void removeFilter(java.lang.String filter)
          Removes the given filter content from the cached list of children content.
 org.eclipse.emf.common.util.EList resolveFilter(java.lang.String filter)
          Retrieve the cached copy of the child content associated with the given filter string.
 
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
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values

WILDCARD

static final java.lang.String WILDCARD
The default filter string for the refresh operation

See Also:
Constant Field Values
Method Detail

getFilters

org.eclipse.emf.common.util.EList getFilters()
Returns the value of the 'Filters' attribute list. The list contents are of type String. List of valid and resolved filter strings

Returns:
the value of the 'Filters' attribute list.
See Also:
ModelPackage.getFilterable_Filters()

refresh

CARMAReturn refresh(org.eclipse.core.runtime.IProgressMonitor pm,
                    int depth,
                    boolean sendNotification,
                    java.lang.Object[] parameters)
                    throws org.eclipse.core.runtime.CoreException,
                           NotConnectedException,
                           UnsupportedCARMAOperationException
Refreshes/updates the cached copy of the content information from the host The refresh 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:

The refresh operation will iterate down the hierarchy to the depth specified performing a refresh on every item in the CARMA hierachy. A depth of "-1" represents an infinitely deep refresh where the refresh operation will continue until a CARMA member is reached.

Refresh the cached copy of the child information using the wildcard [*] string.

Parameters:
pm - progress monitor for the operation
depth - the depth that the refresh operation should execute to in the hierarchy.
sendNotification - set to true if notification messages should be issued from changes made during the refresh operation
parameters - the set of parameters required for the method to execute properly
Returns:
the custom return response from the method execution
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.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the host

refresh

CARMAReturn refresh(org.eclipse.core.runtime.IProgressMonitor pm,
                    java.lang.String filter,
                    int depth,
                    boolean sendNotification,
                    java.lang.Object[] parameters)
                    throws org.eclipse.core.runtime.CoreException,
                           NotConnectedException,
                           UnsupportedCARMAOperationException
Refreshes/updates the cached copy of the content information from the host using the given filter string. The refresh 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:

The refresh operation will iterate down the hierarchy to the depth specified performing a refresh on every item in the CARMA hierachy. A depth of "-1" represents an infinitely deep refresh where the refresh operation will continue until a CARMA member is reached.

Refresh the cached copy of the child information using the given filter string.

Parameters:
pm - progress monitor for the operation
filter - the filter argument to pass to the RAM during refresh
depth - the depth that the refresh operation should execute to in the hierarchy.
sendNotification - set to true if notification messages should be issued from changes made during the refresh operation
parameters - the set of parameters required for the method to execute properly
Returns:
the custom return response from the method execution
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.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the host

refreshWithMemberInfo

CARMAReturn refreshWithMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
                                  java.lang.String filter,
                                  int depth,
                                  boolean sendNotification,
                                  java.lang.String[] keys,
                                  java.lang.Object[] parameters)
                                  throws org.eclipse.core.runtime.CoreException,
                                         NotConnectedException,
                                         UnsupportedCARMAOperationException
Refreshes/updates the cached copy of the content information from the host using the given filter string. The method will also retrieve the set of member info keys as defined in the keys parameter. The refresh 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:

The refresh operation will iterate down the hierarchy to the depth specified performing a refresh on every item in the CARMA hierarchy. A depth of "-1" represents an infinitely deep refresh where the refresh operation will continue until a CARMA member is reached.

Refresh the cached copy of the Repository Container information. This includes the list of child members and containers and the member info value for the specified key. The member info will be updated and stored in the member info map.

Parameters:
pm - progress monitor for the operation
filter - the filter argument to pass to the RAM during refresh
depth - the depth that the refresh operation should execute to in the hierarchy.
sendNotification - set to true if notification messages should be issued from changes made during the refresh operation
keys - the list of member info keys to obtain while performing the navigation refresh
parameters - the set of parameters required for the method to execute properly
Returns:
the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the host

refreshWithAllMemberInfo

CARMAReturn refreshWithAllMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
                                     java.lang.String filter,
                                     int depth,
                                     boolean sendNotification,
                                     java.lang.Object[] parameters)
                                     throws org.eclipse.core.runtime.CoreException,
                                            NotConnectedException,
                                            UnsupportedCARMAOperationException
Refreshes/updates the cached copy of the content information from the host using the given filter string. The method will also retrieve the set of all member info keys [as returned by getAllMemberInfo on the RAM]. The refresh 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:

The refresh operation will iterate down the hierarchy to the depth specified performing a refresh on every item in the CARMA hierarchy. A depth of "-1" represents an infinitely deep refresh where the refresh operation will continue until a CARMA member is reached.

Refresh the cached copy of the Repository Container information. This includes the list of child members and containers and the all member info values/keys. The member info will be updated and stored in the member info map.

Parameters:
pm - progress monitor for the operation
filter - the filter argument to pass to the RAM during refresh
depth - the depth that the refresh operation should execute to in the hierarchy.
sendNotification - set to true if notification messages should be issued from changes made during the refresh operation
parameters - the set of parameters required for the method to execute properly
Returns:
the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the host

resolveFilter

org.eclipse.emf.common.util.EList resolveFilter(java.lang.String filter)
                                                throws NotSynchronizedException
Retrieve the cached copy of the child content associated with the given filter string.

Throws:
NotSynchronizedException

isFilterReady

boolean isFilterReady(java.lang.String filter)
Returns a value of true when the given filter string exists and cached


removeFilter

void removeFilter(java.lang.String filter)
Removes the given filter content from the cached list of children content. After this operation completes the filter will not be available from the resolveFilter method and should throw a NotSynchronizedException.