Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface PollResponse

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface PollResponse
extends CollaborationObject, PersistentBaseObject

A class that implements the PollResponse interface represents a poll participant. The data persisted for a poll response includes the ID of the responding member, the member's poll response (as an index into the array of possible responses), optional member comments, and the date the member responded to the poll question.

See Also:
Poll

Field Summary
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static java.lang.String MAXIMUMVALIDRESPONSES_SYMNAME
          Value of "MaximumValidResponse"; Content Engine property.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
          Value of "MembershipManagedSecurity"; Content Engine property.
static java.lang.String PARENT_SYMNAME
          Value of "CollaborationParent"; Content Engine property.
static java.lang.String POLLRESPONSE_SYMNAME
          Value of "PollResponse"; Content Engine property.
static java.lang.String POLLRESPONSECOMMENTS_SYMNAME
          Value of "PollResponseComments"; Content Engine property.
static java.lang.String[] PROPERTIES
          String array of persistent properties.
static java.lang.String RESPONDERID_SYMNAME
          Value of "MemberID"; Content Engine property.
static java.lang.String RESPONSEDATE_SYMNAME
          Value of "ResponseDate"; Content Engine property.
static java.lang.String SECURITYOWNERID_SYMNAME
          Value of "SecurityOwnerID"; Content Engine property.
static java.lang.String TEAMSPACE_SYMNAME
          Value of "TeamspaceID"; Content Engine property.
 
Method Summary
 java.lang.String getComments()
          Returns member comments.
 Poll getParent()
          Returns the parent Poll object.
 SubjectInfo getResponder()
          Returns a SubjectInfo object representing the responding member.
 java.util.Date getResponseDate()
          Returns the date the member responded to the poll.
 java.lang.Integer getResponseIndex()
          Returns an integer index value that represents the member's response to the poll.
 Teamspace getTeamspace()
          Returns the target Teamspace object.
 void updateResponse(java.lang.Integer responseIndex, java.lang.String comments)
          Updates a member's response.
 
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject
getSymbolicName, getType
 
Methods inherited from interface com.filenet.bso.api.collaboration.PersistentBaseObject
getBaseObject, getID, getObjectStore, getProperties, isMembershipManagedSecurity, isOwner, refresh, setProperties
 

Field Detail

TEAMSPACE_SYMNAME

public static final java.lang.String TEAMSPACE_SYMNAME
Value of "TeamspaceID"; Content Engine property.

RESPONSEDATE_SYMNAME

public static final java.lang.String RESPONSEDATE_SYMNAME
Value of "ResponseDate"; Content Engine property.

POLLRESPONSE_SYMNAME

public static final java.lang.String POLLRESPONSE_SYMNAME
Value of "PollResponse"; Content Engine property.

POLLRESPONSECOMMENTS_SYMNAME

public static final java.lang.String POLLRESPONSECOMMENTS_SYMNAME
Value of "PollResponseComments"; Content Engine property.

RESPONDERID_SYMNAME

public static final java.lang.String RESPONDERID_SYMNAME
Value of "MemberID"; Content Engine property.

PARENT_SYMNAME

public static final java.lang.String PARENT_SYMNAME
Value of "CollaborationParent"; Content Engine property.

MAXIMUMVALIDRESPONSES_SYMNAME

public static final java.lang.String MAXIMUMVALIDRESPONSES_SYMNAME
Value of "MaximumValidResponse"; Content Engine property.

MEMBERSHIPMANAGEDSECURITY_SYMNAME

public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
Value of "MembershipManagedSecurity"; Content Engine property.

SECURITYOWNERID_SYMNAME

public static final java.lang.String SECURITYOWNERID_SYMNAME
Value of "SecurityOwnerID"; Content Engine property.

COLLABORATION_TYPE_SYMNAME

public static final java.lang.String COLLABORATION_TYPE_SYMNAME
Value of "CollaborationType"; Content Engine property.

PROPERTIES

public static final java.lang.String[] PROPERTIES
String array of persistent properties.
Method Detail

getTeamspace

public Teamspace getTeamspace()
Returns the target Teamspace object.

Returns:
A Teamspace object.

getResponder

public SubjectInfo getResponder()
Returns a SubjectInfo object representing the responding member.

Returns:
A SubjectInfo object.

getResponseDate

public java.util.Date getResponseDate()
Returns the date the member responded to the poll.

Returns:
A Date value.

getResponseIndex

public java.lang.Integer getResponseIndex()
Returns an integer index value that represents the member's response to the poll. The index value is an index into the array of possible responses in the parent Poll object.

Returns:
An Integer value. May be null (if the member has not responded).

getComments

public java.lang.String getComments()
Returns member comments.

Returns:
A String value.

getParent

public Poll getParent()
Returns the parent Poll object.

Returns:
A Poll object.

updateResponse

public void updateResponse(java.lang.Integer responseIndex,
                           java.lang.String comments)
                    throws PollClosedException,
                           NonTeamspaceMemberException
Updates a member's response.

Parameters:
responseIndex - Index to the member's response. May be null.

comments - Member comments. May be null.

Throws:
PollClosedException - if the poll is closed and updates are not allowed.
NonTeamspaceMemberException - if an update is attempted by a non-teamspace member.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.