|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Poll
A poll can be attached to any object in the system or can exist at the global level.
Additionally, polls can exist in a certain time range. For example, one can create a poll and have it be active in 2 weeks for 1 month. Inactive polls can also be displayed and can be later permanently deleted from the system.
PollManager
Field Summary | |
---|---|
static long |
ALLOW_ANONYMOUS_VOTE_MODIFICATION
Mode to allow guests to change their vote after casting the vote. |
static long |
ALLOW_USER_VOTE_MODIFICATION
Mode to allow users to change their vote after casting the vote. |
static long |
MULTIPLE_SELECTIONS_ALLOWED
Mode to allow users to select multiple options in a poll. |
Method Summary | |
---|---|
void |
addAnonymousVote(int index,
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 index,
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 index)
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 index)
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 index)
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 index)
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. |
Field Detail |
---|
static final long ALLOW_USER_VOTE_MODIFICATION
static final long ALLOW_ANONYMOUS_VOTE_MODIFICATION
static final long MULTIPLE_SELECTIONS_ALLOWED
Method Detail |
---|
User getUser()
int getObjectType()
long getObjectID()
long getID()
java.lang.String getName()
void setName(java.lang.String name) throws UnauthorizedException
name
- the new name of the poll.
UnauthorizedException
- if the user does not have permissions to administer the poll.java.lang.String getDescription()
void setDescription(java.lang.String description) throws UnauthorizedException
description
- the description of the poll.
UnauthorizedException
- if the user does not have permissions to administer the poll.boolean isModeEnabled(long mode)
void setMode(long mode, boolean enabled) throws UnauthorizedException
mode
- a valid mode
UnauthorizedException
- if the user does not have permissions to administer the poll.java.util.Date getCreationDate()
java.util.Date getModificationDate()
java.util.Date getStartDate()
void setStartDate(java.util.Date startDate) throws UnauthorizedException
startDate
- the date voting for the poll should start.
UnauthorizedException
- if the user does not have permissions to administer the poll.java.util.Date getEndDate()
void setEndDate(java.util.Date endDate) throws UnauthorizedException
endDate
- the date the poll should end.
UnauthorizedException
- if the user does not have permissions to administer the poll.java.util.Date getExpirationDate()
void setExpirationDate(java.util.Date expireDate) throws UnauthorizedException
expireDate
- the date the poll should expire.
UnauthorizedException
- if the user does not have permissions to administer the poll.int getOptionCount()
java.lang.String getOption(int index)
index
- the index of the option to return the text for.
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1void setOption(int index, java.lang.String value) throws UnauthorizedException
index
- the index of the option to set the text for.value
- the new text for the option.
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1
UnauthorizedException
- if the user does not have permissions to administer the poll.void setOptionIndex(int currentIndex, int newIndex) throws UnauthorizedException
currentIndex
- the current index of the option.newIndex
- the new index of the option.
java.lang.IndexOutOfBoundsException
- if 0 > oldIndex/newIndex > getOptionCount() - 1
UnauthorizedException
- if the user does not have permissions to administer the poll.void addOption(java.lang.String value) throws UnauthorizedException
value
- the text for the new option.
UnauthorizedException
- if the user does not have permissions to administer the poll.void deleteOption(int index) throws UnauthorizedException
index
-
UnauthorizedException
- if the user does not have permissions to administer the poll.int getVoteCount() throws PollException
PollException
- reserved for future changes.int getVoteCount(int index) throws PollException
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1
PollException
- reserved for future changes.int getUserVoteCount() throws PollException
PollException
- reserved for future changes.int getUserVoteCount(int index) throws PollException
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1
PollException
- reserved for future changes.int getAnonymousVoteCount() throws PollException
PollException
- reserved for future changes.int getAnonymousVoteCount(int index) throws PollException
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1
PollException
- reserved for future changes.java.util.Iterator getUserVotes() throws PollException
PollException
- reserved for future changes.java.util.Iterator getUserVotes(int index) throws PollException
index
- the index to return the voting users for.
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1
PollException
- reserved for future changes.java.util.Iterator getAnonymousVotes() throws PollException
PollException
- reserved for future changes.java.util.Iterator getAnonymousVotes(int index) throws PollException
index
- the index to return the voting guests for.
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1
PollException
- reserved for future changes.boolean hasUserVoted(User user)
user
- the user to check to see if they've voted already.
boolean hasAnonymousVoted(java.lang.String uniqueID)
uniqueID
- the uniqueID of the guest to check to see if they've voted already.
void addUserVote(int index, User user) throws PollException, UnauthorizedException
index
- the index of the option that the user is voting foruser
- the user making the vote
PollException
- if the user has previously voted in the poll (2 second leeway is
provided for posting multiple votes if that mode is enabled) or the poll is not active.
UnauthorizedException
- if the user does not have permission to vote.
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1void addAnonymousVote(int index, java.lang.String uniqueID) throws PollException, UnauthorizedException
index
- the index of the option that the guest is voting foruniqueID
- a uniqueID for the guest. We suggest either using a session ID or the remote
IP of the guest voting.
PollException
- if the guest has previously voted in the poll (2 second leeway is
provided for posting multiple votes if that mode is enabled) or the poll is not active.
UnauthorizedException
- if the guest does not have permission to vote.
java.lang.IndexOutOfBoundsException
- if 0 > index > getOptionCount() - 1void changeUserVote(int prevOptionIndex, int newOptionIndex, User user) throws PollException, UnauthorizedException
prevOptionIndex
- the index of the option to change the vote from.newOptionIndex
- the index of the option to change the vote to.
PollException
- if the poll is not active, the user did not vote for the
prevOptionIndex or vote modification is not enabled for users.
UnauthorizedException
- if the user does not have permission to vote.
java.lang.IndexOutOfBoundsException
- if 0 > prevOptionIndex/newOptionIndex > getOptionCount() - 1void changeAnonymousVote(int prevOptionIndex, int newOptionIndex, java.lang.String uniqueID) throws PollException, UnauthorizedException
prevOptionIndex
- the index of the option to change the vote from.newOptionIndex
- the index of the option to change the vote to.uniqueID
- a uniqueID for the guest.
PollException
- if the poll is not active, the guest did not vote for the
prevOptionIndex or vote modification is not enabled for guests.
UnauthorizedException
- if the guest does not have permission to vote.
java.lang.IndexOutOfBoundsException
- if 0 > prevOptionIndex/newOptionIndex > getOptionCount() - 1void removeUserVote(int prevOptionIndex, User user) throws PollException, UnauthorizedException
prevOptionIndex
- the index of the option to remove the vote from.
PollException
- if the poll is not active, the user did not vote for the
prevOptionIndex or vote modification is not enabled for users.
UnauthorizedException
- if the user does not have permission to vote.
java.lang.IndexOutOfBoundsException
- if 0 > prevOptionIndex > getOptionCount() - 1void removeAnonymousVote(int prevOptionIndex, java.lang.String uniqueID) throws PollException, UnauthorizedException
prevOptionIndex
- the index of the option to remove the vote from.uniqueID
- a uniqueID for the guest.
PollException
- if the poll is not active, the guest did not vote for the
prevOptionIndex or vote modification is not enabled for guests.
UnauthorizedException
- if the guest does not have permission to vote.
java.lang.IndexOutOfBoundsException
- if 0 > prevOptionIndex > getOptionCount() - 1java.util.List getUserVotes(User user)
user
- the user to return the indexes of options the user has voted for.
java.util.List getAnonymousVotes(java.lang.String uniqueID)
uniqueID
- a uniqueID for the guest.
boolean isAuthorized(long permissionType)
A list of possible permissions can be found in the ForumPermissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.
permissionType
- permissionType a permission type.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |