PollProxy (Jive Forums API (5.5.8) Developer Javadocs)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Jive Forums API (5.5.8) Developer Javadocs

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jivesoftware.forum.proxy
Class PollProxy

java.lang.Object
  com.jivesoftware.forum.proxy.PollProxy

All Implemented Interfaces:: Poll

public class PollProxy
extends java.lang.Object
implements Poll
extends java.lang.Object
implements Poll

A protection proxy for Polls. A proxy has a set of permissions that are specified at creation time of the proxy. Subsequently, those permissions are use to restrict access to protected methods. If a user does not have the right to execute a particular method, an UnauthorizedException is thrown.

See Also:: Poll, Permissions, UnauthorizedException

Field Summary

Fields inherited from interface com.jivesoftware.base.Poll
`ALLOW_ANONYMOUS_VOTE_MODIFICATION, ALLOW_USER_VOTE_MODIFICATION, MULTIPLE_SELECTIONS_ALLOWED`

Constructor Summary
`PollProxy(Poll poll, Permissions permissions)` Creates a new PollProxy object.

Method Summary
`void`	`addAnonymousVote(int optionIndex, java.lang.String uniqueID)` Add a guest vote for an option in the poll.
`void`	`addOption(java.lang.String value)` Add a new option to the poll.
`void`	`addUserVote(int optionIndex, User user)` Add a user vote for an option in the poll.
`void`	`changeAnonymousVote(int prevOptionIndex, int newOptionIndex, java.lang.String uniqueID)` Change a guest vote.
`void`	`changeUserVote(int prevOptionIndex, int newOptionIndex, User user)` Change a user vote.
`void`	`deleteOption(int index)` Remove an option from the poll.
`int`	`getAnonymousVoteCount()` Returns a count of all guests user votes for all options in the poll.
`int`	`getAnonymousVoteCount(int index)` Returns a count of all user votes for the specified option in the poll.
`java.util.Iterator`	`getAnonymousVotes()` Returns an Iterator of uniqueID's for guests who have voted for the option at the given index.
`java.util.Iterator`	`getAnonymousVotes(int optionIndex)` Returns an Iterator of uniqueID's for guests who have voted for the option at the given index.
`java.util.List`	`getAnonymousVotes(java.lang.String uniqueID)` Returns a list of option indexes corresponding to the anonymous votes, or an empty array if the user has not voted.
`java.util.Date`	`getCreationDate()` Returns the date the poll was created.
`java.lang.String`	`getDescription()` Returns a brief description of the poll.
`java.util.Date`	`getEndDate()` Returns the date voting for the poll should end.
`java.util.Date`	`getExpirationDate()` Returns the date the poll should expire.
`long`	`getID()` Returns the unique ID of the poll.
`java.util.Date`	`getModificationDate()` Returns the date the poll was last modified.
`java.lang.String`	`getName()` Returns the name of the poll.
`long`	`getObjectID()` Returns the object ID of the container that 'contains' the poll.
`int`	`getObjectType()` Returns the object type of the container that 'contains' the poll.
`java.lang.String`	`getOption(int index)` Returns the text of the option at the specified index.
`int`	`getOptionCount()` Returns the number of options available in the poll.
`java.util.Date`	`getStartDate()` Returns the date voting for the poll is set to start.
`User`	`getUser()` Returns the user who created the poll or `null` if the poll was created anonymously.
`int`	`getUserVoteCount()` Returns a count of all user votes for all options in the poll.
`int`	`getUserVoteCount(int optionIndex)` Returns a count of all user votes for the specified option in the poll.
`java.util.Iterator`	`getUserVotes()` Returns an Iterator of User objects for users who have voted for any options in the poll.
`java.util.Iterator`	`getUserVotes(int optionIndex)` Returns an Iterator of User objects for users who have voted for the option at the given index.
`java.util.List`	`getUserVotes(User user)` Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.
`int`	`getVoteCount()` Returns a count of all votes (both guest and user votes) for all options in the poll.
`int`	`getVoteCount(int optionIndex)` Returns a count of all votes (both guest and user votes) for the specified option in the poll.
`boolean`	`hasAnonymousVoted(java.lang.String uniqueID)` Returns true if the guest associated with the uniqueID has previously voted in the poll, false otherwise.
`boolean`	`hasUserVoted(User user)` Returns true if the user specified has previously voted in the poll, false otherwise.
`boolean`	`isAuthorized(long permissionType)` Returns true if the handle on the object has the permission specified.
`boolean`	`isModeEnabled(long mode)` Returns true if the mode specified is enabled for the poll, false otherwise.
`void`	`removeAnonymousVote(int prevOptionIndex, java.lang.String uniqueID)` Remove a guest vote.
`void`	`removeUserVote(int prevOptionIndex, User user)` Remove a user vote.
`void`	`setDescription(java.lang.String description)` Sets the description of the poll.
`void`	`setEndDate(java.util.Date endDate)` Sets the date the poll should end.
`void`	`setExpirationDate(java.util.Date expireDate)` Sets the date the poll should expire.
`void`	`setMode(long mode, boolean enabled)` Sets a mode to be enabled or disabled for the poll.
`void`	`setName(java.lang.String name)` Sets the name of the poll.
`void`	`setOption(int index, java.lang.String value)` Sets the text of the option at the specified index.
`void`	`setOptionIndex(int currentIndex, int newIndex)` Moves the option's index.
`void`	`setStartDate(java.util.Date startDate)` Sets the date voting for the poll should start.
`java.lang.String`	`toString()`

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

Constructor Detail

PollProxy

public PollProxy(Poll poll,
                 Permissions permissions)

Creates a new PollProxy object.

Parameters:: poll - the poll to protect by proxy; permissions - the permissions to use with this proxy

Method Detail