|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ObjectWizardStep
Represents one step in a set of steps required to create a new MetadataObject, modify an existing one, delete an existing one or perform an nonvisible operation on one. Each step maintains a reference to the wizard that created it. The wizard, in turn, maintains a reference to the MetadataObject instance it is working on, the operation that is being performed on it, and the MetadataConnection being used to communicate with the EIS. Each step is intended to make progress towards accomplishing the single operation indicated for its parent ObjectWizard. Each step defines actions the user may take to complete this step of the operation. Every step should define a cancel operation to backout of the operation.
The intended flow is:
createProperties()
applyProperties(PropertyGroup)
canContinue()
canFinish()
Method Summary | |
---|---|
void |
applyProperties(PropertyGroup properties)
Apply the properties that have been passed in. |
boolean |
canContinue()
Returns a boolean indicating that the current object wizard step is complete and you can proceed to the next step. |
boolean |
canFinish()
Returns a boolean indicating that the object wizard has completed its operation and any actions that can be performed are optional. |
PropertyGroup |
createProperties()
Creates a new instance of the property group representing any properties needed at this step in the wizard. |
Action[] |
getActions()
Deprecated. since 1.1 - use canFinish() or canContinue() |
String |
getDescription()
Gets the description of the object wizard step. |
String |
getDisplayName()
Gets the display name for the object wizard step. |
ObjectWizardStep |
getNextStep()
Gets the next step. |
ObjectWizard |
getObjectWizard()
Get the ObjectWizard that is the host for this step. |
ObjectWizardStep |
getPreviousStep()
Gets the previous step. |
ObjectWizardStatus |
getStatus()
Deprecated. since 1.1 |
Method Detail |
---|
ObjectWizard getObjectWizard()
null
must never be returned.ObjectWizardStatus getStatus()
null
must never be returned.ObjectWizardStep getPreviousStep()
null
only if this is the first step.Action[] getActions()
It is recommended that the order in which the actions are returned be consistent. This will allow the tool to provide a consistent user experience as the user steps through the wizard.
If there are validation errors, the user may be returned to the same screen with error messages that are part of the properties of the step. These properties must be read only and will be displayed on the wizard.
null
.Action
PropertyGroup createProperties()
null
.applyProperties(PropertyGroup)
void applyProperties(PropertyGroup properties)
properties
- A null
must never be passed in.Action.isDisabled()
String getDescription()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
.ResourceBundle
,
MessageFormat
String getDisplayName()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
.ResourceBundle
,
MessageFormat
boolean canFinish()
This method must be called after applyProperties(PropertyGroup)
and
before getActions()
.
boolean canContinue()
This method must be called after applyProperties(PropertyGroup)
and
before getActions()
.
ObjectWizardStep getNextStep()
null
only if this is the last step.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |