DisplaySurveySaveScreenEvent (opinio plugin api)

java.lang.Object
- com.objectplanet.survey.event.Event
- - com.objectplanet.survey.event.events.SurveyEvent
  - - com.objectplanet.survey.event.events.DisplaySurveySaveScreenEvent

```
public class DisplaySurveySaveScreenEvent
extends SurveyEvent
```
Represents an event that is fired before the survey save screen is displayed. This event can be used to modify or replace the survey save screen.

Author:

Torgeir Lund, Eivind Pedersen

Created:

19 November 2008

Nested Class Summary
- Nested classes/interfaces inherited from class com.objectplanet.survey.event.Event
  Event.NonVetoable

Constructor Summary

Constructors
Constructor and Description

DisplaySurveySaveScreenEvent(IEventListener source)
Creates a new DisplaySurveySaveScreenEvent.

Constructors
Constructor and Description
`DisplaySurveySaveScreenEvent(IEventListener source)` Creates a new DisplaySurveySaveScreenEvent.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.HashMap`	`getResources()` Gets the Resources object.
`long`	`getRespondentId()` Gets the respondentId attribute of the DisplaySurveySaveScreenEvent object
`java.lang.String`	`getSaveScreenContent()` Gets the survey save screen content, which will be presented to the respondent.
`void`	`setResources(java.util.HashMap resources)` Sets the resources Object.
`void`	`setRespondentId(long respondentId)` Sets the respondentId attribute of the DisplaySurveySaveScreenEvent object
`void`	`setSaveScreenContent(java.lang.String surveySaveScreenContent)` Sets the content of the screen that will be displayed when a survey is saved by the respondent.

Methods inherited from class com.objectplanet.survey.event.events.SurveyEvent
getSurveyId, setSurveyId

Methods inherited from class com.objectplanet.survey.event.Event
getSource, isVetoed, paramString, toString, veto

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DisplaySurveySaveScreenEvent
```
public DisplaySurveySaveScreenEvent(IEventListener source)
```
    Creates a new DisplaySurveySaveScreenEvent.
    
    Parameters:
    
    source - The event source
- Method Detail
  - setRespondentId
```
public void setRespondentId(long respondentId)
```
    Sets the respondentId attribute of the DisplaySurveySaveScreenEvent object
    
    Parameters:
    
    respondentId - The new respondentId value
  - getRespondentId
```
public long getRespondentId()
```
    Gets the respondentId attribute of the DisplaySurveySaveScreenEvent object
    
    Returns:
    
    The respondentId value
  - setSaveScreenContent
```
public void setSaveScreenContent(java.lang.String surveySaveScreenContent)
```
    Sets the content of the screen that will be displayed when a survey is saved by the respondent. No HTML "start" tags such as <body> or <head> should be used. This content will replace the default screen that prompts for the e-mail address to send the return link to.
    
    Parameters:
    
    surveySaveScreenContent - The new surveySaveScreenContent value
  - getSaveScreenContent
```
public java.lang.String getSaveScreenContent()
```
    Gets the survey save screen content, which will be presented to the respondent.
    
    Returns:
    
    The survey save screen content.
  - setResources
```
public void setResources(java.util.HashMap resources)
```
    Sets the resources Object.
    
    Parameters:
    
    data.getRespondentId() - The new respondentId value
  - getResources
```
public java.util.HashMap getResources()
```
    Gets the Resources object. This will contain the HttpServletRequest object, and must be retrieved like this:
    
    HttpServletRequest request = (HttpServletRequest) preSurveyPageEvent.getResources().get("HttpRequest");
    
    Returns:
    
    The respondentId value

Class DisplaySurveySaveScreenEvent

Nested Class Summary

Nested classes/interfaces inherited from class com.objectplanet.survey.event.Event

Constructor Summary

Method Summary

Methods inherited from class com.objectplanet.survey.event.events.SurveyEvent

Methods inherited from class com.objectplanet.survey.event.Event

Methods inherited from class java.lang.Object

Constructor Detail

DisplaySurveySaveScreenEvent

Method Detail

setRespondentId

getRespondentId

setSaveScreenContent

getSaveScreenContent

setResources

getResources