Poll Type

Poll webervices object.

Type Template

<...>
    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <commentStatus>xs:int</commentStatus>
    <containerObjectID>xs:long</containerObjectID>
    <containerObjectType>xs:int</containerObjectType>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <endDate>xs:dateTime</endDate>
    <expirationDate>xs:dateTime</expirationDate>
    <mode>xs:long</mode>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <optionCount>xs:int</optionCount>
    <!-- List of ... -->
    <options>xs:string</options>
    <startDate>xs:dateTime</startDate>
    <user>
        <!-- Contents of User -->
    <user>
    <voteCount>xs:int</voteCount>
<...>

Note: Element descriptions are split into information that's relevant when you're creating an instance of this type and information relevant when you're receiving an instance of it. Occasionally these will differ.

Elements

Element Description
commentStatus
Setting
Getting
Returns the comment status of this poll which may be any one of the following:
  • 1 (COMMENTS_NONE) -- no comments allowed
  • 2 (COMMENTS_OPEN) -- comments are permitted
  • 3 (COMMENTS_CLOSED) -- comments were permitted but are not allowed now
Defaults to 2 (COMMENTS_OPEN) .
containerObjectID
Setting
Getting
Returns the object ID of the container that 'contains' the poll.
containerObjectType
Setting
Getting
Returns the object type of the container that 'contains' the poll. The container type returned wiill be a value in JiveConstants (e.g. JiveConstants.COMMUNITY).
creationDate
Setting
Getting
Returns the date the poll was created.
description
Setting
Sets the description of the poll.
Getting
Returns a brief description of the poll.
endDate
Setting
Sets the date the poll should end.
Getting
Returns the date voting for the poll should end.
expirationDate
Setting
Sets the date the poll should expire. This date must be on or after the end date. This date is automatically set to the end date by default.
Getting
Returns the date the poll should expire. The expire date is different from the end date in that users will be able to see the poll but not vote between the end date and the expire date.
ID
Setting
Set the unique id of this object.
Getting
mode
Setting
Getting
modificationDate
Setting
Getting
Returns the date the poll was last modified. The last modified date only applies to the poll itself, it does not take into account votes for options in the poll.
name
Setting
Sets the name of the poll. If the name passed in is null, an IllegalArguementException will be thrown.
Getting
Returns the name of the poll.
objectType
Setting
Sets the object type of the jive object.
Getting
optionCount
Setting
Getting
Returns the number of options available in the poll.
options
Setting
Getting
startDate
Setting
Sets the date voting for the poll should start.
Getting
Returns the date voting for the poll is set to start.
user
Setting
Getting
Returns the user who created the poll or null if the poll was created anonymously.
voteCount
Setting
Getting
Returns a count of all votes (both guest and user votes) for all options in the poll.