|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is the public interface of report instances towards the outside world. You obtain
access to these Reports using the services of a block implementing ReportManager
.
Method Summary | |
void |
generateColumns(org.xml.sax.ContentHandler contentHandler)
|
void |
generateOrderByChoices(org.xml.sax.ContentHandler contentHandler)
|
void |
generateQbe(org.xml.sax.ContentHandler contentHandler)
|
void |
generateSaxForOutput(org.xml.sax.ContentHandler resultHandler,
int chunkOffset,
int chunkLength)
|
void |
generateSaxForStep(org.xml.sax.ContentHandler contentHandler,
java.lang.String stepName)
Generates SAX events containing all information needed to display a form for completing the interaction of a step. |
void |
generateUrl(org.xml.sax.ContentHandler contentHandler)
Generates some XML containing a /reports URL with all necessary parameters to recreate the report to its current state. |
java.lang.String |
getCurrentStepName()
|
java.lang.String |
getId()
|
ReportState |
getState()
Returns an object containing all user-specified state of the report. |
void |
release()
|
void |
resetColumns()
|
void |
resetFromStep(java.lang.String stepName)
Resets all report state starting from (and including) the step whose name is giving as a parameter. |
void |
resetQbe()
|
void |
restoreState(ReportState reportState)
Applies the state from the given reportState back to this report. |
void |
setCustomOrderBy(java.util.Map values,
ResourceHandle resourceHandle)
Defines custom orderby settings. |
void |
setOrderBy(java.lang.String orderById)
Sets the current orderby configuration to a default defined in the report definition. |
void |
setQbeOrientation(java.lang.String orientation)
|
void |
submitColumns(java.util.Map values)
|
boolean |
submitQbe(java.util.Map values)
|
boolean |
submitStep(java.lang.String stepName,
java.util.Map values)
Submit (user input) values to fill the parameters and conditions in this step. |
Method Detail |
public java.lang.String getId()
public boolean submitStep(java.lang.String stepName, java.util.Map values) throws UnknownStepNameException, WrongStateException, ExecuteException, UserEntryStoreException
generateSaxForStep(org.xml.sax.ContentHandler, java.lang.String)
should be called to get
a list of all parameters and conditions with their validation errors.
If the report was already in a further state (i.e. some of the next steps were already completed, or the report was already in the output state), then all the state from this step on will be reset.
values
- a Map containing string keys and values
UnknownStepNameException
WrongStateException
ExecuteException
UserEntryStoreException
public void resetFromStep(java.lang.String stepName) throws UnknownStepNameException, WrongStateException, ExecuteException, UserEntryStoreException
submitStep(java.lang.String, java.util.Map)
.
UnknownStepNameException
WrongStateException
ExecuteException
UserEntryStoreException
public void generateSaxForStep(org.xml.sax.ContentHandler contentHandler, java.lang.String stepName) throws UnknownStepNameException, org.xml.sax.SAXException, java.lang.Exception
getCurrentStepName()
.
UnknownStepNameException
org.xml.sax.SAXException
java.lang.Exception
public void generateSaxForOutput(org.xml.sax.ContentHandler resultHandler, int chunkOffset, int chunkLength) throws java.lang.Exception
java.lang.Exception
public void setOrderBy(java.lang.String orderById) throws UnknownOrderByIdException, WrongStateException, ExecuteException, UnsupportedFeatureException, UserEntryStoreException
orderById
- the id of the orderby as defined in the report definition
UnknownOrderByIdException
- when the given orderById is invalid.
WrongStateException
ExecuteException
UnsupportedFeatureException
UserEntryStoreException
public void setCustomOrderBy(java.util.Map values, ResourceHandle resourceHandle) throws WrongStateException, ExecuteException, UnsupportedFeatureException, UserEntryStoreException
values
- map containing keys like orderby.1, orderby.2, and so on with as value the
column name on which to be sorted (as it should appear in the sql query).
WrongStateException
ExecuteException
UnsupportedFeatureException
UserEntryStoreException
public void generateOrderByChoices(org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException, UnsupportedFeatureException, WrongStateException, ExecuteException, UserEntryStoreException
org.xml.sax.SAXException
UnsupportedFeatureException
WrongStateException
ExecuteException
UserEntryStoreException
public java.lang.String getCurrentStepName() throws ExecuteException, UserEntryStoreException
ExecuteException
UserEntryStoreException
public void generateQbe(org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException, UnsupportedFeatureException, ExecuteException, WrongStateException, java.lang.Exception
org.xml.sax.SAXException
UnsupportedFeatureException
ExecuteException
WrongStateException
java.lang.Exception
public boolean submitQbe(java.util.Map values) throws WrongStateException, ExecuteException, UnsupportedFeatureException, UserEntryStoreException
WrongStateException
ExecuteException
UnsupportedFeatureException
UserEntryStoreException
public void resetQbe() throws WrongStateException, ExecuteException, UnsupportedFeatureException, UserEntryStoreException
WrongStateException
ExecuteException
UnsupportedFeatureException
UserEntryStoreException
public void setQbeOrientation(java.lang.String orientation) throws WrongStateException, ExecuteException, UnsupportedFeatureException, UserEntryStoreException
WrongStateException
ExecuteException
UnsupportedFeatureException
UserEntryStoreException
public void generateColumns(org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException, UnsupportedFeatureException
org.xml.sax.SAXException
UnsupportedFeatureException
public void generateUrl(org.xml.sax.ContentHandler contentHandler) throws java.lang.Exception
java.lang.Exception
public void submitColumns(java.util.Map values) throws ExecuteException, WrongStateException, UnsupportedFeatureException, UserEntryStoreException
ExecuteException
WrongStateException
UnsupportedFeatureException
UserEntryStoreException
public void resetColumns() throws ExecuteException, WrongStateException, UnsupportedFeatureException, UserEntryStoreException
ExecuteException
WrongStateException
UnsupportedFeatureException
UserEntryStoreException
public ReportState getState() throws java.lang.Exception
This method should only be called on reports for which the flow has been sucessfully completed.
java.lang.Exception
public void restoreState(ReportState reportState) throws LoadReportStateException
This method should only be called on newly created report instances, on which no other submit* method is called yet.
LoadReportStateException
public void release()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |