|
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 |
public interface PollManager
Provides a manager to create, retrieve and delete polls.
Polls can exist at the system (global) level or can be attached to any object.
Poll
Method Summary | |
---|---|
Poll |
createPoll(int objectType,
long objectID,
User user,
java.lang.String name)
Create a new Poll. |
void |
deletePoll(Poll poll)
Deletes a poll. |
int |
getActivePollCount()
Returns a count of all active polls in the system. |
int |
getActivePollCount(int objectType,
long objectID)
Returns a count of all active polls of a given type and object ID. |
java.util.Iterator |
getActivePolls()
Returns an iterator of active polls in the system. |
java.util.Iterator |
getActivePolls(int objectType,
long objectID)
Returns an iterator of active polls associated with the object specified by the objectType and objectID. |
int |
getLivePollCount()
Returns a count of all live polls in the system. |
int |
getLivePollCount(int objectType,
long objectID)
Returns a count of all live polls of a given type and object ID. |
java.util.Iterator |
getLivePolls()
Returns an iterator of live polls in the system. |
java.util.Iterator |
getLivePolls(int objectType,
long objectID)
Returns an iterator of live polls associated with the object specified by the objectType and objectID. |
Poll |
getPoll(long pollID)
Returns the Poll specified by the poll ID. |
int |
getPollCount()
Returns a count of all polls, both active and inactive. |
int |
getPollCount(int objectType,
long objectID)
Returns an count of polls, both active and inactive, associated with the object specified by the objectType and objectID. |
java.util.Iterator |
getPolls()
Returns an iterator of all polls, both active and inactive. |
java.util.Iterator |
getPolls(int objectType,
long objectID)
Returns an iterator of polls, both active and inactive, associated with the object specified by the objectType and objectID. |
Method Detail |
---|
Poll createPoll(int objectType, long objectID, User user, java.lang.String name) throws UnauthorizedException
JiveConstants
class, and the objectID should be
a valid ID for the given object type.
objectType
- the object type of the object the poll is associated with.objectID
- the objectID of the object the poll is associated with.user
- the user creating the poll or null if is an anonymous user.name
- the name of the new poll.
UnauthorizedException
- if no permissions to create a poll.void deletePoll(Poll poll) throws UnauthorizedException, PollException
poll
- the poll to delete
UnauthorizedException
- if no permissions to delete the poll.
PollException
int getPollCount()
java.util.Iterator getPolls()
int getPollCount(int objectType, long objectID) throws UnauthorizedException
objectType
- the object type of the object the poll is associated with.objectID
- the objectID of the object the poll is associated with.
UnauthorizedException
- if no permissions to view polls for the specified
objectType and objectID.java.util.Iterator getPolls(int objectType, long objectID) throws UnauthorizedException
objectType
- the object type of the object the poll is associated with.objectID
- the objectID of the object the poll is associated with.
UnauthorizedException
- if no permissions to view polls for the specified
objectType and objectID.java.util.Iterator getActivePolls()
int getActivePollCount()
java.util.Iterator getActivePolls(int objectType, long objectID) throws UnauthorizedException
objectType
- the object type of the object the poll is associated with.objectID
- the objectID of the object the poll is associated with.
UnauthorizedException
- if no permissions to view polls for the specified
objectType and objectID.int getActivePollCount(int objectType, long objectID)
objectType
- the type of object we're looking at (defined in the
JiveConstants
class.objectID
- the ID of the object we're looking at.
java.util.Iterator getLivePolls()
int getLivePollCount()
java.util.Iterator getLivePolls(int objectType, long objectID) throws UnauthorizedException
objectType
- the object type of the object the poll is associated with.objectID
- the objectID of the object the poll is associated with.
UnauthorizedException
- if no permissions to view polls for the specified
objectType and objectID.int getLivePollCount(int objectType, long objectID) throws UnauthorizedException
objectType
- the type of object we're looking at (defined in the
JiveConstants
class.objectID
- the ID of the object we're looking at.
UnauthorizedException
Poll getPoll(long pollID) throws UnauthorizedException, NotFoundException
pollID
- the id of the poll to return.
UnauthorizedException
- if no permissions to view the poll.
NotFoundException
- if the poll of the given ID was not found.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |