|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CcClearPromptCallback
Interface for handling ClearPrompt user interaction requests.
ClearCase trigger scripts may use ClearPrompt to interactively prompt the
user for various kinds of input or responses. CM API applications that wish
to handle these ClearPrompt requests must implement this interface and
register the implementation object with the ClearCase provider via
CcProvider.registerClearPromptCallback
.
See the clearprompt manual page - cleartool man clearprompt
-
for more information.
Nested Class Summary | |
---|---|
static class |
CcClearPromptCallback.AbortException
Callback methods may throw this exception to indicate that the user wishes to abort the current ClearCase operation - the operation that caused the trigger to fire. |
static class |
CcClearPromptCallback.MsgType
ClearPrompt message type. |
static class |
CcClearPromptCallback.ProceedOrAbort
Possible responses for promptForProceed(String, ProceedOrAbort, List, MsgType) method. |
static class |
CcClearPromptCallback.YesOrNo
Possible responses for promptForYesOrNo(String, YesOrNo, List, MsgType) method. |
Method Summary | |
---|---|
String |
promptForChoice(String promptMsg,
List<String> choices)
Ask the user to select a single item from a list of choices. |
List<String> |
promptForMultiChoice(String promptMsg,
List<String> choices)
Ask the user to select zero or more items from a list of choices. |
CcClearPromptCallback.ProceedOrAbort |
promptForProceed(String promptMsg,
CcClearPromptCallback.ProceedOrAbort defaultChoice,
List<CcClearPromptCallback.ProceedOrAbort> choices,
CcClearPromptCallback.MsgType msgType)
Ask the user whether to proceed with the current ClearCase operation or abort it. |
String |
promptForText(String promptMsg,
String defaultResponse,
boolean multiLineOk,
boolean maskInput)
Prompt the user for one or more lines of text. |
CcClearPromptCallback.YesOrNo |
promptForYesOrNo(String promptMsg,
CcClearPromptCallback.YesOrNo defaultChoice,
List<CcClearPromptCallback.YesOrNo> choices,
CcClearPromptCallback.MsgType msgType)
Ask the user for a "yes" or "no" response to a question. |
Method Detail |
---|
String promptForChoice(String promptMsg, List<String> choices) throws CcClearPromptCallback.AbortException
promptMsg
- Prompt message to displaychoices
- Possible choices
CcClearPromptCallback.AbortException
- to indicate the user wants to abort the
current ClearCase operationList<String> promptForMultiChoice(String promptMsg, List<String> choices) throws CcClearPromptCallback.AbortException
promptMsg
- Prompt message to displaychoices
- Possible choices
CcClearPromptCallback.AbortException
- to indicate the user wants to abort the
current ClearCase operationCcClearPromptCallback.ProceedOrAbort promptForProceed(String promptMsg, CcClearPromptCallback.ProceedOrAbort defaultChoice, List<CcClearPromptCallback.ProceedOrAbort> choices, CcClearPromptCallback.MsgType msgType)
promptMsg
- Prompt message to displaydefaultChoice
- Default response to displaychoices
- Optional subset of responses to displaymsgType
- message type: OK, WARNING, ERROR, BOX
String promptForText(String promptMsg, String defaultResponse, boolean multiLineOk, boolean maskInput) throws CcClearPromptCallback.AbortException
promptMsg
- Prompt message to displaydefaultResponse
- Default response to displaymultiLineOk
- Allow user to enter multiple linesmaskInput
- Mask user input for password entry
CcClearPromptCallback.AbortException
- to indicate the user wants to abort the
current ClearCase operationCcClearPromptCallback.YesOrNo promptForYesOrNo(String promptMsg, CcClearPromptCallback.YesOrNo defaultChoice, List<CcClearPromptCallback.YesOrNo> choices, CcClearPromptCallback.MsgType msgType)
promptMsg
- Prompt message to displaydefaultChoice
- Default response to displaychoices
- Optional subset of responses to displaymsgType
- message type: OK, WARNING, ERROR, BOX
|
Generated Fri 24-May-2013 12:47 AM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |