| Method Summary |
|
| public void | addCreateListener(ICreateListener listener)
Adds a listener. |
| public void | addDeleteListener(IDeleteListener listener)
Adds a listener. |
| public void | addDisplayOnlyField(String fieldName)
This will mark a field as 'DisplayOnly'. |
| abstract protected void | addScreens(List screens)
The Component should provide an implementation for this method to provide the screen information. |
| public void | addUpdateListener(IUpdateListener listener)
Adds a listener. |
| public void | create()
This will invoke the doCreate() method to create a new domain object. |
| public void | delete(boolean performDirtyReadCheck)
This will invoke the doDelete() method to delete the domain object. |
| public MaintComponent2.Screen | determineAndSetNextScreen()
This sets the currentScreenCounter to point to the next screen. |
| public MaintComponent2.Screen | determineAndSetPreviousScreen()
This sets the currentScreenCounter to point to the previous screen. |
| public MaintComponent2.Screen | determineCurrentScreen()
Getter for the current Screen. |
| public static URL | determineDefaultValuesUrl(Class componentClass)
A helper routine to return the URL for the properties file containing default values for a component.
The properties file is assumed to be in the base package of the component with the name ComponentDefaultValues.properties'.
This method will try to locate the file on the filesystem.
This allows the application to pick up any changes to the file.
However, if the file is part of a jar, then it'll be loaded by the classloader.
A null will be returned if no file is found.
Parameters:
componentClass - The component class. |
| public FormKey | determineFormKey()
Getter for the current screen's FormKey. |
| public MaintComponent2.Screen | determineNextScreen()
Getter for the next Screen. |
| public MaintComponent2.Screen | determinePreviousScreen()
Getter for the previous Screen. |
| public FormKey | display()
Based on the mode and input parameters, this will either delete the domain object, or initialize the screen for updates, or bring up a blank screen.
throws:
ApplicationExceptions - Indicates some functional error.
throws:
FrameworkException - Indicates some system error. |
| abstract protected void | doCreate()
The Component should provide an implementation for this method to create a domain object. |
| abstract protected void | doDelete(boolean performDirtyReadCheck)
The Component should provide an implementation for this method to delete the domain object. |
| abstract protected void | doPrevalidateCreate()
The Component should provide an implementation for this method to perform prevalidations before creating a domain object. |
| abstract protected void | doPrevalidateUpdate(boolean performDirtyReadCheck)
The Component should provide an implementation for this method to perform prevalidations before updating a domain object. |
| abstract protected void | doRetrieve()
The Component should provide an implementation for this method to retrieve the domain object. |
| abstract protected void | doUpdate(boolean performDirtyReadCheck)
The Component should provide an implementation for this method to update the domain object. |
| protected Collection | getCreateListeners()
Returns a Collection of ICreateListener objects. |
| public int | getCurrentScreenCounter()
Getter for property currentScreenCounter. |
| protected Collection | getDeleteListeners()
Returns a Collection of IDeleteListener objects. |
| protected HeaderDto | getHeaderDto()
Returns the HeaderDto. |
| public int | getMode()
Getter for property mode. |
| public MaintComponent2.Screen[] | getScreens()
Getter for the Screens. |
| protected Collection | getUpdateListeners()
Returns a Collection of IUpdateListener objects. |
| protected void | initDropDownCodes()
The Component should override this method to retrieve the set of codes for dropdowns in a screen, if any are required. |
| protected void | initializeData()
This method is invoked by the display() method when the component is run in the CREATE_MODE. |
| protected void | invokeCreateListeners()
Invokes the createDone() method of the registered ICreateListener objects in the same thread. |
| protected void | invokeCreateListeners(EventObject eventObject)
Invokes the createDone() method of the registered ICreateListener objects in the same thread. |
| protected void | invokeDeleteListeners()
Invokes the deleteDone() method of the registered IDeleteListener objects in the same thread. |
| protected void | invokeDeleteListeners(EventObject eventObject)
Invokes the deleteDone() method of the registered IDeleteListener objects in the same thread. |
| protected void | invokeUpdateListeners()
Invokes the updateDone() method of the registered IUpdateListener objects in the same thread. |
| protected void | invokeUpdateListeners(EventObject eventObject)
Invokes the updateDone() method of the registered IUpdateListener objects in the same thread. |
| public boolean | isCreateMode()
Returns true if this is create mode. |
| public boolean | isDeleteMode()
Returns true if this is delete mode. |
| public boolean | isDisplayOnlyField(String fieldName)
Returns a true if a field has been marked as 'DisplayOnly'.
Parameters:
fieldName - The field to be checked. |
| public boolean | isRefreshData()
Getter for property refreshData. |
| public boolean | isUpdateMode()
Returns true if this is update mode. |
| public void | prevalidateCreate()
This will invoke the doPrevalidateCreate() method to perform prevalidations before creating a domain object. |
| public void | prevalidateUpdate(boolean performDirtyReadCheck)
This will invoke the doPrevalidateUpdate() method to perform prevalidations before updating a domain object. |
| public void | quit()
This clears the internal collection of listeners. |
| public boolean | removeCreateListener(ICreateListener listener)
Removes a listener.
Parameters:
listener - the listener. |
| public boolean | removeDeleteListener(IDeleteListener listener)
Removes a listener.
Parameters:
listener - the listener. |
| public boolean | removeUpdateListener(IUpdateListener listener)
Removes a listener.
Parameters:
listener - the listener. |
| public void | retrieve()
This will invoke the doRetrieve() method to retrieve the domain object. |
| public void | setCurrentScreenCounter(int currentScreenCounter)
Setter for property currentScreenCounter. |
| public void | setMode(int mode)
Setter for property mode. |
| protected void | setRefreshData(boolean refreshData)
Setter for property refreshData. |
| protected void | uncacheWidgetModels()
Clears the WidgetCache, removing all the WidgetModels. |
| public void | update(boolean performDirtyReadCheck)
This will invoke the doUpdate() method to update the domain object. |
