com.ibm.carma.ui.mapper
Interface ICARMAResourceReference

All Superinterfaces:
ICARMANavigable

public interface ICARMAResourceReference
extends ICARMANavigable

Interface for associating CARMA resources with other items in the workbench.

This interface is not finalized and subject to change

Since:
7.0

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void decorate(org.eclipse.jface.viewers.IDecoration decoration)
          Decorates the reference object with the provided decoration
 java.lang.String getCARMAID()
          Returns the CARMA connection ID associated with the reference
 CARMAResource getCarmaResource()
          Retrieves the CARMA resource associated with the reference.
 java.util.Collection<ICARMAResourceReference> getChildren()
          Retrieves the children of the current navigable item.
 ICARMAResourceReference getInstanceReference()
           
 java.lang.String getRemoteResourceID()
          Returns the resource ID associated with the reference
 java.lang.String getRepositoryInstanceID()
          Returns the Repository Instance ID associated with the reference
 java.lang.String getRepositoryManagerName()
          Returns the repository manager ID associated with the reference
 boolean isAssociated()
           
 boolean isManaged()
          Returns true if the reference is under the control of the CARMA Team provider, false otherwise.
 void manage(org.eclipse.core.runtime.IProgressMonitor monitor)
          Marks the reference object as managed by the CARMA Team provider.
 void setCarmaResource(CARMAResource resource)
          Set the CARMA resource to associate with the reference
 void unmanage(org.eclipse.core.runtime.IProgressMonitor monitor)
          Un-marks the reference object as managed by the CARMA Team provider if the reference is currently managed.
 
Methods inherited from interface com.ibm.carma.ui.mapper.ICARMANavigable
accept, create, getLocalResource, getLocalResourceName, isContainer, isMember
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getCARMAID

java.lang.String getCARMAID()
                            throws org.eclipse.core.runtime.CoreException
Returns the CARMA connection ID associated with the reference

Returns:
the associated CARMA connection ID
Throws:
org.eclipse.core.runtime.CoreException - Id could not be retreived

getRepositoryManagerName

java.lang.String getRepositoryManagerName()
                                          throws org.eclipse.core.runtime.CoreException
Returns the repository manager ID associated with the reference

Returns:
the associated RAM ID
Throws:
org.eclipse.core.runtime.CoreException - Id could not be retreived

getRepositoryInstanceID

java.lang.String getRepositoryInstanceID()
                                         throws org.eclipse.core.runtime.CoreException
Returns the Repository Instance ID associated with the reference

Returns:
the associated RI member ID
Throws:
org.eclipse.core.runtime.CoreException - Id could not be retreived

getRemoteResourceID

java.lang.String getRemoteResourceID()
                                     throws org.eclipse.core.runtime.CoreException
Returns the resource ID associated with the reference

Returns:
the associated resource ID
Throws:
org.eclipse.core.runtime.CoreException - Id could not be retreived

getCarmaResource

CARMAResource getCarmaResource()
                               throws org.eclipse.core.runtime.CoreException,
                                      NotSynchronizedException
Retrieves the CARMA resource associated with the reference. The resource should be discovered in the hierarchy if possible. A return of null should be returned if no resource is associated.

Returns:
associated resource
Throws:
org.eclipse.core.runtime.CoreException - The resource could not be retrieved
NotSynchronizedException - The retrieval encountered an area of the CARMA hierarchy which is not initialized.

setCarmaResource

void setCarmaResource(CARMAResource resource)
                      throws org.eclipse.core.runtime.CoreException
Set the CARMA resource to associate with the reference

Parameters:
resource - the resource to associate
Throws:
org.eclipse.core.runtime.CoreException - the resource could not be associated

getInstanceReference

ICARMAResourceReference getInstanceReference()
Returns:
Reference to the RI of the associated resource

getChildren

java.util.Collection<ICARMAResourceReference> getChildren()
Description copied from interface: ICARMANavigable
Retrieves the children of the current navigable item. The method may return null if the ICARMANavigable.isContainer() method returns false.

Specified by:
getChildren in interface ICARMANavigable
Returns:
children of the navigable container

manage

void manage(org.eclipse.core.runtime.IProgressMonitor monitor)
            throws org.eclipse.core.runtime.CoreException
Marks the reference object as managed by the CARMA Team provider. This operation can be ignored if the reference is currently marked as managed.

Parameters:
monitor - monitor for the operation
Throws:
org.eclipse.core.runtime.CoreException - the management operation could not be completed

unmanage

void unmanage(org.eclipse.core.runtime.IProgressMonitor monitor)
              throws org.eclipse.core.runtime.CoreException
Un-marks the reference object as managed by the CARMA Team provider if the reference is currently managed. This operation can be ignored if the reference is not currently managed.

Parameters:
monitor - monitor for the operation
Throws:
org.eclipse.core.runtime.CoreException - the un-manage operation could not be completed

isManaged

boolean isManaged()
Returns true if the reference is under the control of the CARMA Team provider, false otherwise.

Returns:
management state of the resource

isAssociated

boolean isAssociated()

decorate

void decorate(org.eclipse.jface.viewers.IDecoration decoration)
Decorates the reference object with the provided decoration

Parameters:
decoration - decoration to apply to the resource