CSPollContent (GOSS iCM API)

java.lang.Object
- gi.controlsite.objects.CSItemContent
- - gi.controlsite.objects.CSPollContent

All Implemented Interfaces:

java.io.Serializable
```
public class CSPollContent
extends CSItemContent
```
Class used to store the content of a CSPoll object.

See Also:

CSPoll, CSPollMultiple, CSPollContentAnswer, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CSPollContent()
Creates an empty CSPollContent object.

Constructors
Constructor and Description
`CSPollContent()` Creates an empty `CSPollContent` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Determines whether the data contained in this `CSPollContent` object is the same as that contained within the one supplied.
`java.util.ArrayList`	`getAnswers()` Gets the answers that are available for this poll.
`boolean`	`getArchive()` Indicates whether the poll can be archived or not.
`int`	`getAuthor()` Gets the poll's author.
`boolean`	`getDisplay()` Indicates whether the poll can be displayed on the website or not.
`java.util.Date`	`getEndDate()` Gets the poll's end date.
`int`	`getGroupID()` Get the ID of the immediate parent poll group.
`java.lang.String`	`getGroupName()` Get the name of the immediate parent poll group.
`java.lang.String`	`getName()` Gets the name of the poll.
`int`	`getPollID()` Gets the ID of the poll.
`java.lang.String`	`getQuestion()` Gets the poll's question.
`java.util.Date`	`getStartDate()` Gets the poll's start date.
`int`	`getTotalVotes()` Gets the total number of poll votes.
`java.lang.String`	`getType()` Gets the poll's type.
`int`	`getVotes(java.lang.String strTag)` Gets the number of votes for a particular answer.
`void`	`setAnswers(java.util.ArrayList arrAnswers)` Sets the answers available for the poll.
`void`	`setArchive(boolean bArchive)` Specifies whether the poll can be archived or not.
`void`	`setAuthor(int nAuthor)` Sets the author of the poll.
`void`	`setDisplay(boolean bDisplay)` Specifies whether the poll can be displayed on the website or not.
`void`	`setEndDate(java.util.Date objDate)` Sets the poll's end date, the date upon which the poll is to become inactive.
`void`	`setGroupID(int nGroupID)` Set the ID of the immediate parent poll group.
`void`	`setGroupName(java.lang.String strGroupName)` Set the Name of the immediate parent poll group.
`void`	`setName(java.lang.String strName)` Sets the name of the poll.
`void`	`setPollID(int nPollID)` Sets the ID of the poll.
`void`	`setQuestion(java.lang.String strQuestion)` Sets the poll's question text.
`void`	`setStartDate(java.util.Date objDate)` Sets the poll's start date, the date upon which the poll is to become active.
`void`	`setTotalVotes(int nTotalVotes)` Sets the total number of votes for the poll.
`void`	`setType(java.lang.String strType)` Sets the type of poll.
`void`	`setVotes(java.lang.String strTag, int nVotes)` Sets the number of votes for a specific poll answer.
`java.lang.String`	`toString()` Outputs the contents of this `CSPollContent` object to a `String` object in a user-friendly format.

Methods inherited from class gi.controlsite.objects.CSItemContent
clone, getID, setID, unset

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CSPollContent
```
public CSPollContent()
```
    Creates an empty CSPollContent object.
- Method Detail
  - setPollID
```
public void setPollID(int nPollID)
```
    Sets the ID of the poll.
    
    Parameters:
    
    nPollID - the numeric identifier of the poll
  - getPollID
```
public int getPollID()
```
    Gets the ID of the poll.
    
    Returns:
    
    The numeric identifier of the poll
  - setName
```
public void setName(java.lang.String strName)
```
    Sets the name of the poll.
    
    Parameters:
    
    strName - The poll's name
  - getName
```
public java.lang.String getName()
```
    Gets the name of the poll.
    
    Returns:
    
    The poll's name
  - setAuthor
```
public void setAuthor(int nAuthor)
```
    Sets the author of the poll.
    
    Parameters:
    
    nAuthor - The numeric identifier of the poll's author. This should be the ID of one of the users set up via iCM security.
  - getAuthor
```
public int getAuthor()
```
    Gets the poll's author.
    
    Returns:
    
    The numeric identifier of the poll's author.
  - setDisplay
```
public void setDisplay(boolean bDisplay)
```
    Specifies whether the poll can be displayed on the website or not. If Display is set to false, the poll is not to be displayed on the website.
    
    Parameters:
    
    bDisplay - true if the poll can be displayed, false otherwise.
  - getDisplay
```
public boolean getDisplay()
```
    Indicates whether the poll can be displayed on the website or not.
    
    Returns:
    
    true if the poll can be displayed, false otherwise.
  - setArchive
```
public void setArchive(boolean bArchive)
```
    Specifies whether the poll can be archived or not. If Archive is set to true, the poll can be archived.
    
    Parameters:
    
    bArchive - true if the poll can be archived, false otherwise.
  - getArchive
```
public boolean getArchive()
```
    Indicates whether the poll can be archived or not.
    
    Returns:
    
    true if the poll can be archived, false otherwise.
  - setQuestion
```
public void setQuestion(java.lang.String strQuestion)
```
    Sets the poll's question text.
    
    Parameters:
    
    strQuestion - The question to be asked by the poll
  - getQuestion
```
public java.lang.String getQuestion()
```
    Gets the poll's question.
    
    Returns:
    
    The question being asked by the poll
  - setStartDate
```
public void setStartDate(java.util.Date objDate)
```
    Sets the poll's start date, the date upon which the poll is to become active.
    
    Parameters:
    
    objDate - The poll's start date
  - getStartDate
```
public java.util.Date getStartDate()
```
    Gets the poll's start date.
    
    Returns:
    
    The poll's start date
  - setEndDate
```
public void setEndDate(java.util.Date objDate)
```
    Sets the poll's end date, the date upon which the poll is to become inactive.
    
    Parameters:
    
    objDate - The poll's end date
  - getEndDate
```
public java.util.Date getEndDate()
```
    Gets the poll's end date.
    
    Returns:
    
    The poll's end date
  - setType
```
public void setType(java.lang.String strType)
```
    Sets the type of poll. Defined poll types are :
    - TYPE_YESNO - A simple Yes/No poll
    - TYPE_MULTIPLE - A multiple choice poll
    Parameters:
    
    strType - The poll type
  - getType
```
public java.lang.String getType()
```
    Gets the poll's type.
    
    Returns:
    
    The poll's type i.e. TYPE_YESNO or TYPE_MULTIPLE
  - setTotalVotes
```
public void setTotalVotes(int nTotalVotes)
```
    Sets the total number of votes for the poll.
    
    Parameters:
    
    nTotalVotes - The total number of votes
  - getTotalVotes
```
public int getTotalVotes()
```
    Gets the total number of poll votes.
    
    Returns:
    
    The total number of votes for the poll.
  - setVotes
```
public void setVotes(java.lang.String strTag,
                     int nVotes)
```
    Sets the number of votes for a specific poll answer.
    
    Parameters:
    
    strTag - The tag that identifies the answer
    
    nVotes - The number of votes for the specified answer
  - getVotes
```
public int getVotes(java.lang.String strTag)
```
    Gets the number of votes for a particular answer.
    
    Parameters:
    
    strTag - The tag that identifies the answer
    
    Returns:
    
    The number of votes for the specified answer.
  - setAnswers
```
public void setAnswers(java.util.ArrayList arrAnswers)
```
    Sets the answers available for the poll. Each element within the ArrayList must be a valid CSPollContentAnswer object.
    
    Parameters:
    
    arrAnswers - An ArrayList of CSPollContentAnswer objects
  - getAnswers
```
public java.util.ArrayList getAnswers()
```
    Gets the answers that are available for this poll. Each element within the returned ArrayList will be a CSPollContentAnswer object.
    
    Returns:
    
    An ArrayList of CSPollContentAnswer objects
  - setGroupID
```
public void setGroupID(int nGroupID)
```
    Set the ID of the immediate parent poll group.
    
    Parameters:
    
    nGroupID - the ID of the parent poll group.
  - getGroupID
```
public int getGroupID()
```
    Get the ID of the immediate parent poll group.
    
    Returns:
    
    the ID of the parent poll group.
  - setGroupName
```
public void setGroupName(java.lang.String strGroupName)
```
    Set the Name of the immediate parent poll group.
    
    Parameters:
    
    strGroupName - the name of the parent poll group.
  - getGroupName
```
public java.lang.String getGroupName()
```
    Get the name of the immediate parent poll group.
    
    Returns:
    
    the name of the parent poll group.
  - toString
```
public java.lang.String toString()
```
    Outputs the contents of this CSPollContent object to a String object in a user-friendly format.
    
    Overrides:
    
    toString in class CSItemContent
    
    Returns:
    
    The String containing the user-friendly output
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Determines whether the data contained in this CSPollContent object is the same as that contained within the one supplied. Note that the key data used for searching is not tested for equality.
    
    Overrides:
    
    equals in class CSItemContent
    
    Parameters:
    
    obj - The CSPollContent object to be tested for equality
    
    Returns:
    
    true if the data matches, false otherwise.

Class CSPollContent

Constructor Summary

Method Summary

Methods inherited from class gi.controlsite.objects.CSItemContent

Methods inherited from class java.lang.Object

Constructor Detail

CSPollContent

Method Detail

setPollID

getPollID

setName

getName

setAuthor

getAuthor

setDisplay

getDisplay

setArchive

getArchive

setQuestion

getQuestion

setStartDate

getStartDate

setEndDate

getEndDate

setType

getType

setTotalVotes

getTotalVotes

setVotes

getVotes

setAnswers

getAnswers

setGroupID

getGroupID

setGroupName

getGroupName

toString

equals