Collaboration API Documentation

com.filenet.bso.api.collaboration.data
Class PollInfo

java.lang.Object
  |
  +--com.filenet.bso.api.collaboration.data.PollInfo
All Implemented Interfaces:
java.io.Serializable

public class PollInfo
extends java.lang.Object
implements java.io.Serializable

The PollInfo class is a collection of data used to create a teamspace poll.

See Also:
Serialized Form

Constructor Summary
PollInfo()
           
 
Method Summary
 java.util.Date getClosingDate()
          Returns the poll's closing date.
 java.lang.String getOwnerID()
          Returns the ID of the member who created the poll.
 java.lang.String[] getParticipants()
          Returns an array of String objects that define the poll participants.
 java.lang.String[] getPossibleResponses()
          Returns a String array of possible responses to the poll.
 java.lang.Integer getPriority()
          Returns the priority for the poll.
 java.lang.String getQuestion()
          Returns the poll question.
 java.lang.Boolean getResponsesHiddenFlag()
          Returns the responses hidden flag.
 void setClosingDate(java.util.Date closingDate)
          Set a closing date for the poll.
 void setOwnerID(java.lang.String ownerID)
           
 void setParticipants(java.lang.String[] participants)
          Set poll participants.
 void setPossibleResponses(java.lang.String[] responses)
          Set the possible responses to the poll question.
 void setPriority(int value)
          Set the poll priority.
 void setQuestion(java.lang.String question)
          Set the poll question.
 void setResponsesHiddenFlag(boolean flag)
          Set the show poll responses flag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PollInfo

public PollInfo()
Method Detail

getOwnerID

public java.lang.String getOwnerID()
Returns the ID of the member who created the poll.

Returns:
A String containing the creator-owner member ID.

getPossibleResponses

public java.lang.String[] getPossibleResponses()
Returns a String array of possible responses to the poll.

Returns:
A String array.

getQuestion

public java.lang.String getQuestion()
Returns the poll question.

Returns:
A String containing the poll question.

getClosingDate

public java.util.Date getClosingDate()
Returns the poll's closing date.

Returns:
A Date object that specifies the poll's closing date.

getPriority

public java.lang.Integer getPriority()
Returns the priority for the poll. If not set, returns Poll.POLLPRIORITY_NORMAL.

Returns:
An Integer object that specifies the poll priority.

getResponsesHiddenFlag

public java.lang.Boolean getResponsesHiddenFlag()
Returns the responses hidden flag. If false, all participants in a poll may see the results; otherwise, only the creator of the poll may see the results.

Returns:
A Boolean value that specifies whether participants may see poll results.

getParticipants

public java.lang.String[] getParticipants()
Returns an array of String objects that define the poll participants.

Returns:
An array of String objects.

setOwnerID

public void setOwnerID(java.lang.String ownerID)
Parameters:
ownerID - The LDAP SID of the member granted creator-owner rights for the poll.

setPossibleResponses

public void setPossibleResponses(java.lang.String[] responses)
Set the possible responses to the poll question.

setPriority

public void setPriority(int value)
Set the poll priority. Values may be Poll.POLLPRIORITY_HIGH, Poll.POLLPRIORITY_NORMAL or Poll.POLLPRIORITY_LOW.

setQuestion

public void setQuestion(java.lang.String question)
Set the poll question.

setResponsesHiddenFlag

public void setResponsesHiddenFlag(boolean flag)
Set the show poll responses flag.

setClosingDate

public void setClosingDate(java.util.Date closingDate)
Set a closing date for the poll.

setParticipants

public void setParticipants(java.lang.String[] participants)
Set poll participants.

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.