|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface of an object that can serve as a "source" for the view and form objects manipulated by an GenericEditForm.
The primary implementation is GenericViewSource.
Method Summary | |
WavesetResult |
checkinView()
Save the changes made to a view, and release any locks that might be held. |
void |
clearErrors()
Clear the error list. |
void |
clearView()
Remove the information saved by saveView(). |
java.util.List |
getErrors()
Get a list of error messages accumulated by the view source. |
Form |
getForm()
Return the form for this view. |
java.util.Map |
getOptions()
Get all view options. |
GenericObject |
getView()
Returns the view. |
boolean |
hasCachedView()
Returns true if the view source is currently maintaining a cached view. |
boolean |
hasValidView()
Returns true if the view source is still maintaining a valid view. |
boolean |
isAlwaysRefresh()
|
void |
refreshView()
Refresh the view to reflect changes that may have been made. |
void |
saveView()
Save the current contents of the view in such a way that the view can be restored efficiently by a different instance of the view source. |
void |
setAlwaysRefresh(boolean b)
When true, the view will always be refreshed and will not be cached in the HttpSession. |
void |
setOption(java.lang.String name,
java.lang.Object value)
Set a view option. |
void |
setOptions(java.util.Map options)
Set all view options. |
void |
setRequestState(RequestState rs)
Sets the request state for this view source. |
void |
setSessionAttribute(java.lang.String s)
If this view source saves state on the HttpSession, this is the attribute it should use rather than the default. |
void |
setViewId(java.lang.String s)
Sets the view identifier. |
void |
unlockView()
Release any locks that might be held for the current view, but do not check it in. |
Method Detail |
public void setRequestState(RequestState rs)
public void setViewId(java.lang.String s)
public void setOption(java.lang.String name, java.lang.Object value)
public java.util.Map getOptions()
public void setOptions(java.util.Map options)
public void setAlwaysRefresh(boolean b)
public boolean isAlwaysRefresh()
public void setSessionAttribute(java.lang.String s)
public boolean hasCachedView()
public boolean hasValidView()
public GenericObject getView() throws WavesetException
If this is a view of an existing object, the object will normally be locked in the underlying storage manager so you should remember to call unlockView() or checkinView() later.
WavesetException
public Form getForm() throws WavesetException
WavesetException
public void refreshView() throws WavesetException
WavesetException
public WavesetResult checkinView() throws WavesetException
WavesetException
public void unlockView() throws WavesetException
WavesetException
public void saveView() throws WavesetException
Normally, this will serialize the view and store it on the HttpSession. The intent is that getView() can discover this and restore the view without having to use a file or database.
WavesetException
public void clearView()
public java.util.List getErrors()
public void clearErrors()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |