com.ibm.carma.model
Interface Managed

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
CARMAContainer, CARMAContent, CARMAMember, CARMAMemberVersion

public interface Managed
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Managed'. A resource in the CARMA system that provides managed access to the resource

See Also:
ModelPackage.getManaged()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 CARMAReturn checkin(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters)
          Marks the resource as checked-in, making the resource readable for all users The checkin action specification can be located using the CustomActionAccepter.findActionFor(String) method and inspecting the action object returned.
 CARMAReturn checkout(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters)
          Marks the resource as checked-out, marking the resource as read-only for all users but the user that checked-out the file The checkin action specification can be located using the CustomActionAccepter.findActionFor(String) method and inspecting the action object returned.
 CARMAReturn lock(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters)
          Locks the resource, marking the resource as read-only for all users but the locking user The lock action specification can be located using the CustomActionAccepter.findActionFor(String) method and inspecting the action object returned.
 CARMAReturn unlock(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters)
          Unlocks the resource, marking the resource as readable for all users The unlock action specification can be located using the CustomActionAccepter.findActionFor(String) method and inspecting the action object returned.
 
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
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

lock

CARMAReturn lock(org.eclipse.core.runtime.IProgressMonitor pm,
                 java.lang.Object[] parameters)
                 throws org.eclipse.core.runtime.CoreException,
                        UnsupportedCARMAOperationException,
                        NotConnectedException
Locks the resource, marking the resource as read-only for all users but the locking user The lock 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:

Locks the resource, marking the resource as read-only for all users but the locking user

Parameters:
pm - progress monitor for the 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
See Also:
ActionIdentifier.LOCK

unlock

CARMAReturn unlock(org.eclipse.core.runtime.IProgressMonitor pm,
                   java.lang.Object[] parameters)
                   throws org.eclipse.core.runtime.CoreException,
                          UnsupportedCARMAOperationException,
                          NotConnectedException
Unlocks the resource, marking the resource as readable for all users The unlock 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:

unlocks the resource, marking the resource as readable for all users

Parameters:
pm - progress monitor for the 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
See Also:
ActionIdentifier.UNLOCK

checkin

CARMAReturn checkin(org.eclipse.core.runtime.IProgressMonitor pm,
                    java.lang.Object[] parameters)
                    throws org.eclipse.core.runtime.CoreException,
                           UnsupportedCARMAOperationException,
                           NotConnectedException
Marks the resource as checked-in, making the resource readable for all users The checkin 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:

Marks the resource as checked-in, making the resource readable for all users

Parameters:
pm - progress monitor for the 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
See Also:
ActionIdentifier.CHECK_IN

checkout

CARMAReturn checkout(org.eclipse.core.runtime.IProgressMonitor pm,
                     java.lang.Object[] parameters)
                     throws org.eclipse.core.runtime.CoreException,
                            UnsupportedCARMAOperationException,
                            NotConnectedException
Marks the resource as checked-out, marking the resource as read-only for all users but the user that checked-out the file The checkin 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:

Marks the resource as checked-out, marking the resource as read-only for all users but the user that checked-out the file

Parameters:
pm - progress monitor for the 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
See Also:
ActionIdentifier.CHECK_OUT