|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.proxy.PollProxy
public class PollProxy
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.
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 |
---|
public PollProxy(Poll poll, Permissions permissions)
poll
- the poll to protect by proxypermissions
- the permissions to use with this proxyMethod Detail |
---|
public User getUser()
Poll
getUser
in interface Poll
public int getObjectType()
Poll
getObjectType
in interface Poll
public long getObjectID()
Poll
getObjectID
in interface Poll
public long getID()
Poll
getID
in interface Poll
public java.lang.String getName()
Poll
getName
in interface Poll
public void setName(java.lang.String name) throws UnauthorizedException
Poll
setName
in interface Poll
name
- the new name of the poll.
UnauthorizedException
- if the user does not have permissions to administer the poll.public java.lang.String getDescription()
Poll
getDescription
in interface Poll
public void setDescription(java.lang.String description) throws UnauthorizedException
Poll
setDescription
in interface Poll
description
- the description of the poll.
UnauthorizedException
- if the user does not have permissions to administer the poll.public boolean isModeEnabled(long mode)
Poll
isModeEnabled
in interface Poll
public void setMode(long mode, boolean enabled) throws UnauthorizedException
Poll
setMode
in interface Poll
mode
- a valid mode
UnauthorizedException
- if the user does not have permissions to administer the poll.public java.util.Date getCreationDate()
Poll
getCreationDate
in interface Poll
public java.util.Date getModificationDate()
Poll
getModificationDate
in interface Poll
public java.util.Date getStartDate()
Poll
getStartDate
in interface Poll
public void setStartDate(java.util.Date startDate) throws UnauthorizedException
Poll
setStartDate
in interface Poll
startDate
- the date voting for the poll should start.
UnauthorizedException
- if the user does not have permissions to administer the poll.public java.util.Date getEndDate()
Poll
getEndDate
in interface Poll
public void setEndDate(java.util.Date endDate) throws UnauthorizedException
Poll
setEndDate
in interface Poll
endDate
- the date the poll should end.
UnauthorizedException
- if the user does not have permissions to administer the poll.public java.util.Date getExpirationDate()
Poll
getExpirationDate
in interface Poll
public void setExpirationDate(java.util.Date expireDate) throws UnauthorizedException
Poll
setExpirationDate
in interface Poll
expireDate
- the date the poll should expire.
UnauthorizedException
- if the user does not have permissions to administer the poll.public int getOptionCount()
Poll
getOptionCount
in interface Poll
public java.lang.String getOption(int index)
Poll
getOption
in interface Poll
index
- the index of the option to return the text for.
public void setOption(int index, java.lang.String value) throws UnauthorizedException
Poll
setOption
in interface Poll
index
- the index of the option to set the text for.value
- the new text for the option.
UnauthorizedException
- if the user does not have permissions to administer the poll.public void setOptionIndex(int currentIndex, int newIndex) throws UnauthorizedException
Poll
setOptionIndex
in interface Poll
currentIndex
- the current index of the option.newIndex
- the new index of the option.
UnauthorizedException
- if the user does not have permissions to administer the poll.public void addOption(java.lang.String value) throws UnauthorizedException
Poll
addOption
in interface Poll
value
- the text for the new option.
UnauthorizedException
- if the user does not have permissions to administer the poll.public void deleteOption(int index) throws UnauthorizedException
Poll
deleteOption
in interface Poll
UnauthorizedException
- if the user does not have permissions to administer the poll.public int getVoteCount() throws PollException
Poll
getVoteCount
in interface Poll
PollException
- reserved for future changes.public int getVoteCount(int optionIndex) throws PollException
Poll
getVoteCount
in interface Poll
PollException
- reserved for future changes.public int getUserVoteCount() throws PollException
Poll
getUserVoteCount
in interface Poll
PollException
- reserved for future changes.public int getUserVoteCount(int optionIndex) throws PollException
Poll
getUserVoteCount
in interface Poll
PollException
- reserved for future changes.public int getAnonymousVoteCount() throws PollException
Poll
getAnonymousVoteCount
in interface Poll
PollException
- reserved for future changes.public int getAnonymousVoteCount(int index) throws PollException
Poll
getAnonymousVoteCount
in interface Poll
PollException
- reserved for future changes.public java.util.Iterator getUserVotes() throws PollException
Poll
getUserVotes
in interface Poll
PollException
- reserved for future changes.public java.util.Iterator getUserVotes(int optionIndex) throws PollException
Poll
getUserVotes
in interface Poll
optionIndex
- the index to return the voting users for.
PollException
- reserved for future changes.public java.util.Iterator getAnonymousVotes() throws PollException
Poll
getAnonymousVotes
in interface Poll
PollException
- reserved for future changes.public java.util.Iterator getAnonymousVotes(int optionIndex) throws PollException
Poll
getAnonymousVotes
in interface Poll
optionIndex
- the index to return the voting guests for.
PollException
- reserved for future changes.public boolean hasUserVoted(User user)
Poll
hasUserVoted
in interface Poll
user
- the user to check to see if they've voted already.
public boolean hasAnonymousVoted(java.lang.String uniqueID)
Poll
hasAnonymousVoted
in interface Poll
uniqueID
- the uniqueID of the guest to check to see if they've voted already.
public void addUserVote(int optionIndex, User user) throws PollException, UnauthorizedException
Poll
addUserVote
in interface Poll
optionIndex
- 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.public void addAnonymousVote(int optionIndex, java.lang.String uniqueID) throws PollException, UnauthorizedException
Poll
addAnonymousVote
in interface Poll
optionIndex
- 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.public void changeUserVote(int prevOptionIndex, int newOptionIndex, User user) throws PollException, UnauthorizedException
Poll
changeUserVote
in interface Poll
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.public void changeAnonymousVote(int prevOptionIndex, int newOptionIndex, java.lang.String uniqueID) throws PollException, UnauthorizedException
Poll
changeAnonymousVote
in interface Poll
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.public void removeUserVote(int prevOptionIndex, User user) throws PollException, UnauthorizedException
Poll
removeUserVote
in interface Poll
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.public void removeAnonymousVote(int prevOptionIndex, java.lang.String uniqueID) throws PollException, UnauthorizedException
Poll
removeAnonymousVote
in interface Poll
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.public java.util.List getUserVotes(User user)
Poll
getUserVotes
in interface Poll
user
- the user to return the indexes of options the user has voted for.
public java.util.List getAnonymousVotes(java.lang.String uniqueID)
Poll
getAnonymousVotes
in interface Poll
uniqueID
- a uniqueID for the guest.
public boolean isAuthorized(long permissionType)
Poll
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.
isAuthorized
in interface Poll
permissionType
- permissionType a permission type.
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |