JDeveloper SCM API

oracle.ide.scm
Interface SCMOperation

All Known Implementing Classes:
SCMFileOperation, SCMNoFileOperation, SCMToggleOperation

public interface SCMOperation

Generic interface to all client operation providers. Operations represent all the information necessary to correctly handle the presentation of SCM client actions to the user, and execute a command through a shell runner or server connection. This is the most important abstraction for the client, in defining exactly how a single available client command should both appear and behave, and the constraints on its usage.

Do not implement this class directly. This is the common superclass of all adapted operations, and as such is the primary interface type, but does not completely define a useful operation. Instead, extend one of the adapter interfaces in the 'op' package. The adapters partially implement and introduce further virtual definitions in order to generalize for utility.


Method Summary
 SCMControlItem getControlItem()
          Retrieves an object wrapper for data pertaining to the environment controls for this operation.
 boolean isEnabled(boolean control, SCMContext context)
          Asks whether this operation can be enabled depending on general client state.
 boolean isNodeRemovalCheckEnabled()
          Flag indicating whether the operation runtime should check for removed files after this operation and update the navigator.
 

Method Detail

isNodeRemovalCheckEnabled

public boolean isNodeRemovalCheckEnabled()
Flag indicating whether the operation runtime should check for removed files after this operation and update the navigator. If your operation may remove files on the filesystem, you will want to return true from this method. Otherwise, returning false will result in better performance.

Returns:
true if the operation runtime should check for removed files after running this operation.

getControlItem

public SCMControlItem getControlItem()
Retrieves an object wrapper for data pertaining to the environment controls for this operation.

Returns:
the operation's control item definition.

isEnabled

public boolean isEnabled(boolean control,
                         SCMContext context)
Asks whether this operation can be enabled depending on general client state. An indication of whether source control is currently operative is given to assist the decision.

Parameters:
control - source control enabled state indicator.
context - the IDE's current context.
Returns:
a verdict on whether the operation is permitted.

Copyright © 2002 Oracle Corporation

 

Copyright ©1997, 2003, Oracle. All rights reserved.