|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
public interface ICARMAResourceReference
Interface for associating CARMA resources with other items in the workbench.
This interface is not finalized and subject to change
| 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. |
CustomActionAccepter |
getCustomActionAccepter()
|
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 |
RepositoryManager |
getRepositoryManager()
Retrieves the RepositoryManager 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 |
setCarmaResource(RepositoryManager rm)
Set the Repository Manager |
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 |
|---|
static final java.lang.String COPYRIGHT
| Method Detail |
|---|
java.lang.String getCARMAID()
throws org.eclipse.core.runtime.CoreException
ID associated with the reference
org.eclipse.core.runtime.CoreException - Id could not be retreived
java.lang.String getRepositoryManagerName()
throws org.eclipse.core.runtime.CoreException
ID associated with the reference
org.eclipse.core.runtime.CoreException - Id could not be retreived
java.lang.String getRepositoryInstanceID()
throws org.eclipse.core.runtime.CoreException
ID associated with the reference
org.eclipse.core.runtime.CoreException - Id could not be retreived
java.lang.String getRemoteResourceID()
throws org.eclipse.core.runtime.CoreException
ID associated with the reference
org.eclipse.core.runtime.CoreException - Id could not be retreived
CARMAResource getCarmaResource()
throws org.eclipse.core.runtime.CoreException,
NotSynchronizedException
null should be returned
if no resource is associated. If the reference is associated with a RepositoryManager
instead of a CARMA resource, this could return null while isAssociated()
still returns true.
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.
RepositoryManager getRepositoryManager()
throws org.eclipse.core.runtime.CoreException,
NotSynchronizedException
NotSynchronizedException
org.eclipse.core.runtime.CoreException
CustomActionAccepter getCustomActionAccepter()
throws org.eclipse.core.runtime.CoreException,
NotSynchronizedException
org.eclipse.core.runtime.CoreException
NotSynchronizedException
void setCarmaResource(CARMAResource resource)
throws org.eclipse.core.runtime.CoreException
resource - the resource to associate
org.eclipse.core.runtime.CoreException - the resource could not be associated
void setCarmaResource(RepositoryManager rm)
throws org.eclipse.core.runtime.CoreException
rm - the RepositoryManager to associate
org.eclipse.core.runtime.CoreException - the RepositoryManager could not be associatedICARMAResourceReference getInstanceReference()
java.util.Collection<ICARMAResourceReference> getChildren()
ICARMANavigableICARMANavigable.isContainer() method returns false.
getChildren in interface ICARMANavigable
void manage(org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
monitor - monitor for the operation
org.eclipse.core.runtime.CoreException - the management operation could not be completed
void unmanage(org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
monitor - monitor for the operation
org.eclipse.core.runtime.CoreException - the un-manage operation could not be completedboolean isManaged()
boolean isAssociated()
void decorate(org.eclipse.jface.viewers.IDecoration decoration)
decoration - decoration to apply to the resource
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||