Added JavaDoc to GetStagedEventsAction class

This commit is contained in:
Benjamin Barth committed 2016-06-27 16:05:34 +02:00
1 parent fcc49baf45
commit 2ffc4972a4
1 file changed
+12
@@ -11,12 +11,24 @@ import com.sap.sse.gwt.dispatch.shared.caching.IsClientCacheable;
import com.sap.sse.gwt.dispatch.shared.commands.ListResult;
import com.sap.sse.gwt.dispatch.shared.exceptions.DispatchException;
/**
* <p>
* {@link SailingAction} implementation to load a list of stage events to be shown on mobile start page.
* </p>
*/
public class GetStagedEventsAction implements SailingAction<ListResult<EventStageDTO>>, IsClientCacheable {
private boolean useTeaserImage;
protected GetStagedEventsAction() {
}
/**
* Creates a {@link GetStagedEventsAction} instance, where the use of stage or teaser images can be specified.
*
* @param useTeaserImage
* <code>true</code> to use a lower resolution teaser image for the event, <code>false</code> to use a
* high resolution stage image. Can be useful to safe data traffic on mobile connections.
*/
public GetStagedEventsAction(boolean useTeaserImage) {
this.useTeaserImage = useTeaserImage;
}