ca.bc.gov.webade.http
Class DefaultHtmlPageWriter

java.lang.Object
  extended byca.bc.gov.webade.http.DefaultHtmlPageWriter

public final class DefaultHtmlPageWriter
extends java.lang.Object

Author:
jross

Constructor Summary
DefaultHtmlPageWriter()
           
 
Method Summary
static java.lang.String writeApplicationDisabledPage(boolean errorOnDisabledCheck)
          Writes the default application disabled page to a String a returns it.
static java.lang.String writeApplicationDisabledPage(java.lang.String appDisabledMessage, boolean errorOnDisabledCheck)
          Writes the default application disabled page to a String a returns it.
static java.lang.String writeInitializationErrorPage()
          Writes the application initialization error page to a String a returns it.
static java.lang.String writeUserAgreementPage(java.lang.String agreementId, java.lang.String agreementText, java.lang.String path, java.lang.String params)
          Writes the user agreement form page to a String a returns it.
static java.lang.String writeUserAgreementPage(User user, java.lang.String agreementId, java.lang.String agreementText, java.lang.String path, java.lang.String params)
          Deprecated.  
static java.lang.String writeUserOrganizationPage(User user, java.lang.String byOrgParam, java.lang.String path, java.lang.String params)
          Deprecated.  
static java.lang.String writeUserOrganizationPage(WebADEUserPermissions user, java.lang.String byOrgParam, java.lang.String path, java.lang.String params, Organization defaultOrg)
          Writes the user default organization form page to a String a returns it.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultHtmlPageWriter

public DefaultHtmlPageWriter()
Method Detail

writeInitializationErrorPage

public static final java.lang.String writeInitializationErrorPage()
Writes the application initialization error page to a String a returns it.

Returns:
The application initialization error page.

writeApplicationDisabledPage

public static final java.lang.String writeApplicationDisabledPage(boolean errorOnDisabledCheck)
Writes the default application disabled page to a String a returns it.

Parameters:
errorOnDisabledCheck - A flag indicating whether an error occured while checking the application's disabled flag.
Returns:
The user default application disabled page.

writeApplicationDisabledPage

public static final java.lang.String writeApplicationDisabledPage(java.lang.String appDisabledMessage,
                                                                  boolean errorOnDisabledCheck)
Writes the default application disabled page to a String a returns it.

Parameters:
appDisabledMessage - The message to display to the user if the application has been disabled.
errorOnDisabledCheck - A flag indicating whether an error occured while checking the application's disabled flag.
Returns:
The user default application disabled page.

writeUserOrganizationPage

public static final java.lang.String writeUserOrganizationPage(User user,
                                                               java.lang.String byOrgParam,
                                                               java.lang.String path,
                                                               java.lang.String params)
                                                        throws java.io.UnsupportedEncodingException
Deprecated.  

Writes the user default organization form page to a String a returns it.

Parameters:
user - The user to select an organization for.
byOrgParam - The org param that indicates what set of organizations to allow the user to select from.
path - The path of the interrupted request.
params - The request params of the interrupted request.
Returns:
The user default organization form page.
Throws:
java.io.UnsupportedEncodingException

writeUserOrganizationPage

public static final java.lang.String writeUserOrganizationPage(WebADEUserPermissions user,
                                                               java.lang.String byOrgParam,
                                                               java.lang.String path,
                                                               java.lang.String params,
                                                               Organization defaultOrg)
                                                        throws java.io.UnsupportedEncodingException
Writes the user default organization form page to a String a returns it.

Parameters:
user - The user to select an organization for.
byOrgParam - The org param that indicates what set of organizations to allow the user to select from.
path - The path of the interrupted request.
params - The request params of the interrupted request.
defaultOrg - The user's default organization in the WebADE datastore, or null if none is set.
Returns:
The user default organization form page.
Throws:
java.io.UnsupportedEncodingException

writeUserAgreementPage

public static final java.lang.String writeUserAgreementPage(User user,
                                                            java.lang.String agreementId,
                                                            java.lang.String agreementText,
                                                            java.lang.String path,
                                                            java.lang.String params)
Deprecated.  

Writes the user agreement form page to a String a returns it.

Parameters:
user - The user to select an organization for.
agreementId - The target agreement id.
agreementText - The target agreement text.
path - The path of the interrupted request.
params - The request params of the interrupted request.
Returns:
The user agreement form page.

writeUserAgreementPage

public static final java.lang.String writeUserAgreementPage(java.lang.String agreementId,
                                                            java.lang.String agreementText,
                                                            java.lang.String path,
                                                            java.lang.String params)
Writes the user agreement form page to a String a returns it.

Parameters:
agreementId - The target agreement id.
agreementText - The target agreement text.
path - The path of the interrupted request.
params - The request params of the interrupted request.
Returns:
The user agreement form page.