votorola.s.wap

Class PollspaceWAP

java.lang.Object

Call

PollspaceWAP

@ThreadRestricted(value="constructor")
public final class PollspaceWAP
extends Call

A web API for listing compiled polls, which are defined as those with counts reported through vocount. Calls to this interface are conventionally prefixed by 'ps' (wCall=psPollspace). If you choose a different prefix, then adjust the parameter names below accordingly. An example request is:

http://reluk.ca:8080/v/wap?wCall=psPollspace&wPretty

The response includes the following components. These are shown in JSON format with explanatory comments:

 {
    "ps": [ // or other prefix, per wCall query parameter
       // Compiled polls in natural order:
       {
          "name": "POLL NAME 1",
          "displayTitle": "DISPLAY TITLE", // if any
          "issueType": "ISSUE TYPE"
       },
       {
          "name": "POLL NAME 2",
          "issueType": "ISSUE TYPE"
       }
       // and so on, up to 500
    ]
 }

See Also:

vocount

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALL_TYPE The name to use in the wCall query parameter, which is "Pollspace".
static int	MAX_RESPONSE_SIZE The maximum number of polls returned per response.

Constructor Summary

Constructors

Constructor and Description
PollspaceWAP(String prefix, Requesting req, ResponseConfiguration resConfig) Constructs a PollspaceWAP.

Method Summary

Methods

Modifier and Type	Method and Description
void	respond(Responding res) Responds to the call.

Methods inherited from class Call

init, prefix, req

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CALL_TYPE

public static final String CALL_TYPE

The name to use in the wCall query parameter, which is "Pollspace". For example: wCall=psPollspace.

See Also:

Constant Field Values

MAX_RESPONSE_SIZE

public static final int MAX_RESPONSE_SIZE

The maximum number of polls returned per response. No paging mechanism is provided yet, so polls beyond this number are currently inaccessible.

See Also:

Constant Field Values

Constructor Detail

PollspaceWAP

public PollspaceWAP(String prefix,
            Requesting req,
            ResponseConfiguration resConfig)
             throws HTTPRequestException

Constructs a PollspaceWAP.

Throws:

HTTPRequestException

See Also:

Call.prefix(), Call.req()

Method Detail

respond

public void respond(Responding res)
             throws IOException

Description copied from class: Call

Responds to the call.

Specified by:

respond in class Call

Throws:

IOException