oracle.jdeveloper.vcs.generic

Interface VCSActionInfo

public interface VCSActionInfo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDialogHint() Gets the hint text of the dialog accompanying the action.
java.lang.String	getDialogTitle() Gets the title text of the dialog accompanying the action.
java.util.Collection	getFilteredSelection(Context context) Filters the Context selection based on the declared URLFilters and VCSStatusFilters referenced by this action.
java.lang.String	getHelpTopicId() Gets the help topic of the dialog accompanying the action.
VCSCommandStyle	getStyle() Gets the VCSCommandStyle representing the style of the action.
java.lang.Boolean	getToggleStatus() Gets the toggle status for the action.
VCSCommandType	getType() Gets the VCSCommandType representing the style of the action.
boolean	isChangeListAction() Determines whether or not this action is referenced for use from a ChangeList containing view.
boolean	requirementsSatisfied(Context context) Evaluates whether or not the ActionRequirements referenced by the action are satisfied for the given context.

Method Detail

getStyle

VCSCommandStyle getStyle()

Gets the VCSCommandStyle representing the style of the action.

Returns:

a VCSCommandStyle representing the style of the action.

getType

VCSCommandType getType()

Gets the VCSCommandType representing the style of the action.

Returns:

a VCSCommandType representing the style of the action.

getToggleStatus

java.lang.Boolean getToggleStatus()

Gets the toggle status for the action.

Returns:

Boolean.TRUE when this is a toggle action and its states is set to enabled by default Boolean.FALSE when this is a toggle action and its states is set to disabled by default null when this is not a toggle action

getDialogTitle

java.lang.String getDialogTitle()

Gets the title text of the dialog accompanying the action.

getDialogHint

java.lang.String getDialogHint()

Gets the hint text of the dialog accompanying the action.

getHelpTopicId

java.lang.String getHelpTopicId()

Gets the help topic of the dialog accompanying the action.

isChangeListAction

boolean isChangeListAction()

Determines whether or not this action is referenced for use from a ChangeList containing view.

Returns:

true if this action is referenced by a change list containing view, false otherwise.

requirementsSatisfied

boolean requirementsSatisfied(Context context)
                       throws java.lang.Exception

Evaluates whether or not the ActionRequirements referenced by the action are satisfied for the given context. Any errors encountered during evaluation will be reported via the Logger of the containing VCSProfile.

Parameters:

context - the Context.

Returns:

true iff all ActionRequirements referenced by the action are satisfied, false otherwise.

Throws:

java.lang.Exception

getFilteredSelection

java.util.Collection getFilteredSelection(Context context)
                                   throws java.lang.Exception

Filters the Context selection based on the declared URLFilters and VCSStatusFilters referenced by this action.

Parameters:

context - the Context.

Returns:

a java.util.Collection representing the filtered selection.

Throws:

java.lang.Exception