Uses of Interface
com.ibm.carma.model.CARMAReturn

Packages that use CARMAReturn
com.ibm.carma.model   
com.ibm.carma.model.util   
com.ibm.carma.ui.dialog   
com.ibm.carma.ui.job   
 

Uses of CARMAReturn in com.ibm.carma.model
 

Classes in com.ibm.carma.model that implement CARMAReturn
 class FileReturn
          File contents stream returned from CARMA including the custom return values for the extract method as specified in the host configuration.
 

Methods in com.ibm.carma.model that return CARMAReturn
 CARMAReturn Managed.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 Managed.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 Movable.copy(org.eclipse.core.runtime.IProgressMonitor pm, ResourceContainer parent, java.lang.Object[] parameters)
          Copys the resource to another location in the CARMA system.
 CARMAReturn CARMAMember.copyFromExternal(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String remoteLocation, java.lang.Object[] parameters)
           
 CARMAReturn CARMAMember.copyToExternal(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String remoteLocation, java.lang.Object[] parameters)
           
 CARMAReturn ModelFactory.createCARMAReturn()
          Returns a new object of class 'CARMA Return'.
 CARMAReturn ModelFactory.createCARMAReturn(java.util.Map<ReturnValue,?> returnContents)
          Returns a new object of class 'CARMA Return' populated with a return contents Map
 CARMAReturn CARMAResource.delete(org.eclipse.core.runtime.IProgressMonitor pm, boolean force, java.lang.Object[] parameters)
          Removes the CARMA Resource from the CARMA content hierarchy
 CARMAReturn CARMAResource.delete(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters)
          Removes the CARMA Resource from the CARMA content hierarchy with the force option set to false
 CARMAReturn Managed.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 Movable.move(org.eclipse.core.runtime.IProgressMonitor pm, ResourceContainer parent, java.lang.Object[] parameters)
          Moves the resource to another location in the CARMA system.
 CARMAReturn CustomActionAccepter.performAction(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String actionId, java.lang.Object[] parameters)
          Issues a custom command on the content that is to be sent to the CARMA host.
 CARMAReturn Filterable.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 Filterable.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 CARMAMember.refreshVersionHistory(org.eclipse.core.runtime.IProgressMonitor pm, boolean sendNotification, java.lang.Object[] parameters)
           
 CARMAReturn CARMAMember.refreshVersionHistoryWithMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm, boolean sendNotification, java.lang.String[] keys, java.lang.Object[] parameters)
           
 CARMAReturn Filterable.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 Filterable.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.
 CARMAReturn CARMAMember.setMemberContents(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters, java.io.InputStream fileStream)
           
 CARMAReturn Managed.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.
 

Constructors in com.ibm.carma.model with parameters of type CARMAReturn
FileReturn(java.io.InputStream inputStream, CARMAReturn carmaReturn)
          Wraps an input stream to the data returned from CARMA during an extract as well as the extract custom return values.
 

Uses of CARMAReturn in com.ibm.carma.model.util
 

Methods in com.ibm.carma.model.util with parameters of type CARMAReturn
 java.lang.Object ModelSwitch.caseCARMAReturn(CARMAReturn object)
          Returns the result of interpretting the object as an instance of 'CARMA Return'.
 

Uses of CARMAReturn in com.ibm.carma.ui.dialog
 

Constructor parameters in com.ibm.carma.ui.dialog with type arguments of type CARMAReturn
CarmaReturnDialog(org.eclipse.swt.widgets.Shell parentShell, java.lang.String dialogTitle, org.eclipse.swt.graphics.Image dialogTitleImage, java.lang.String dialogMessage, java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> returns)
          Creates the custom return display dialog.
 

Uses of CARMAReturn in com.ibm.carma.ui.job
 

Methods in com.ibm.carma.ui.job that return CARMAReturn
 CARMAReturn UnlockJob.performCommand(CARMAContent resource, org.eclipse.core.runtime.IProgressMonitor monitor)
           
 CARMAReturn LockJob.performCommand(CARMAContent resource, org.eclipse.core.runtime.IProgressMonitor monitor)
           
 CARMAReturn CheckoutJob.performCommand(CARMAContent resource, org.eclipse.core.runtime.IProgressMonitor monitor)
           
 CARMAReturn CheckinJob.performCommand(CARMAContent resource, org.eclipse.core.runtime.IProgressMonitor monitor)
           
 CARMAReturn CustomActionJob.performCommand(T resource, org.eclipse.core.runtime.IProgressMonitor monitor)
          By default this method calls the generic perform command action, but can be overriden to call any method on the passed CARMA Resource
 

Methods in com.ibm.carma.ui.job with parameters of type CARMAReturn
 void AbstractCarmaJob.displayCustomReturns(CARMAContent resource, CARMAReturn returnValues)
          Opens a dialog to display the given custom returns to the user.
static Action AbstractCarmaJob.getActionFromReturns(CARMAReturn returnValues)
          Walks the return value structure and determines the action the returns come from
 

Method parameters in com.ibm.carma.ui.job with type arguments of type CARMAReturn
 void AbstractCarmaJob.displayCustomReturns(CARMAContent resource, java.util.Map<? extends CARMAContent,? extends CARMAReturn> map)
          Opens a dialog to display the given custom returns to the user.
 void AbstractCarmaJob.displayCustomReturns(CustomActionAccepter resource, java.lang.String actionId, java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> map)
          Opens a dialog to display the given custom returns to the user.
 void AbstractCarmaJob.displayCustomReturns(java.lang.String actionId, java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> map)
          Opens a dialog to display the given custom returns to the user.