com.stratelia.webactiv.util.questionContainer.model
Class QuestionContainerDetail

java.lang.Object
  com.stratelia.webactiv.util.questionContainer.model.QuestionContainerDetail

All Implemented Interfaces:

SilverpeasContent, Serializable

public class QuestionContainerDetail
extends Object
implements Serializable, SilverpeasContent

See Also:

Serialized Form

Constructor Summary

QuestionContainerDetail()

QuestionContainerDetail(QuestionContainerHeader header, Collection<Question> questions, Collection<Comment> comments, Collection<QuestionResult> votes)

Method Summary

boolean	canBeAccessedBy(UserDetail user) Is the specified user can access this container of questions?
Collection<Comment>	getComments()
String	getComponentInstanceId() Gets the unique identifier of the Silverpeas component instance that manages this content.
String	getContributionType() Gets the type of this content.
Date	getCreationDate() Gets the date at which this content was created.
UserDetail	getCreator() Gets the author that has created this content.
Collection<QuestionResult>	getCurrentUserVotes()
String	getDescription() Gets the description of this content if any.
Question	getFirstQuestion()
QuestionContainerHeader	getHeader()
String	getId() Gets the identifier of this content in the Silverpeas component providing it.
String	getJsonPosition()
Collection<Question>	getQuestions()
String	getSilverpeasContentId() Gets the unique identifier of this content among all the contents managed in the Silverpeas collaborative portal.
String	getTitle() Gets the title of this content if any.
void	setComments(Collection<Comment> comments)
void	setCurrentUserVotes(Collection<QuestionResult> votes)
void	setHeader(QuestionContainerHeader header)
void	setJsonPosition(String jsonPosition)
void	setQuestions(Collection<Question> questions)
protected void	setSilverpeasContentId(String contentId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuestionContainerDetail

public QuestionContainerDetail()

QuestionContainerDetail

public QuestionContainerDetail(QuestionContainerHeader header,
                               Collection<Question> questions,
                               Collection<Comment> comments,
                               Collection<QuestionResult> votes)

Method Detail

setHeader

public void setHeader(QuestionContainerHeader header)

Parameters:

header - the Question Container header to set

setQuestions

public void setQuestions(Collection<Question> questions)

Parameters:

questions - the collection of questions to set

setComments

public void setComments(Collection<Comment> comments)

Parameters:

comments - the collection of comments to set

setCurrentUserVotes

public void setCurrentUserVotes(Collection<QuestionResult> votes)

Parameters:

votes - the collection of QuestionResult to set

getHeader

public QuestionContainerHeader getHeader()

Returns:

the question container header

getQuestions

public Collection<Question> getQuestions()

Returns:

the collection of questions

getFirstQuestion

public Question getFirstQuestion()

Returns:

the first question

getComments

public Collection<Comment> getComments()

Returns:

the collection of comments

getCurrentUserVotes

public Collection<QuestionResult> getCurrentUserVotes()

Returns:

the collection of question result

getJsonPosition

public String getJsonPosition()

Returns:

the jsonPosition

setJsonPosition

public void setJsonPosition(String jsonPosition)

Parameters:

jsonPosition - the jsonPosition to set

getComponentInstanceId

public String getComponentInstanceId()

Description copied from interface: SilverpeasContent

Gets the unique identifier of the Silverpeas component instance that manages this content.

Specified by:

getComponentInstanceId in interface SilverpeasContent

Returns:

the unique identifier of the component instance in the Silverpeas collaborative portal.

getContributionType

public String getContributionType()

Description copied from interface: SilverpeasContent

Gets the type of this content.

Specified by:

getContributionType in interface SilverpeasContent

Returns:

the resource type. This can be Post, Message, Publication, Survey...

canBeAccessedBy

public boolean canBeAccessedBy(UserDetail user)

Is the specified user can access this container of questions?

A user can access a container if it has enough rights to access the application instance in which is managed this container.

Specified by:

canBeAccessedBy in interface SilverpeasContent

Parameters:

user - a user in Silverpeas.

Returns:

true if the user can access this container of questions, false otherwise.

getCreationDate

public Date getCreationDate()

Description copied from interface: SilverpeasContent

Gets the date at which this content was created.

Specified by:

getCreationDate in interface SilverpeasContent

Returns:

the date at which this content was created.

getCreator

public UserDetail getCreator()

Description copied from interface: SilverpeasContent

Gets the author that has created this content.

Specified by:

getCreator in interface SilverpeasContent

Returns:

the detail about the user that created this content.

getId

public String getId()

Description copied from interface: SilverpeasContent

Gets the identifier of this content in the Silverpeas component providing it. This identifier is only unique among all of the contents managed by the same component (whatever its different instances). As each type of contents in Silverpeas is provided by a single Silverpeas component, the identifier of a content is then specific to the component it belongs to. It is a way for an instance of a such component to identify uniquely the different contents it manages. So, each component can have their own policy to identify their content, whatever the way they are identified in Silverpeas.

Specified by:

getId in interface SilverpeasContent

Returns:

the identifier of this content.

getSilverpeasContentId

public String getSilverpeasContentId()

Description copied from interface: SilverpeasContent

Gets the unique identifier of this content among all the contents managed in the Silverpeas collaborative portal. It is the alone unique identifier of a content in the whole Silverpeas portal and it is refered as the Silverpeas content identifier or the silver content identifier. For each content put into the Silverpeas collaborative portal, an entry is uniquely created in the whole system so that is can be refered by transversal services and by component instances others the one that manages it. For compatibility reason, the Silverpeas content identifier of contents that are no yet taken into account in the whole system isn't defined, so an empty string is then returned.

Specified by:

getSilverpeasContentId in interface SilverpeasContent

Returns:

the unique identifier of this content in the whole Silverpeas collaborative portal. Can be empty if no such identifier is defined for the type of this content.

setSilverpeasContentId

protected void setSilverpeasContentId(String contentId)

getTitle

public String getTitle()

Description copied from interface: SilverpeasContent

Gets the title of this content if any.

Specified by:

getTitle in interface SilverpeasContent

Returns:

the resource title. Can be empty if no title was set or no title is defined for a such content.

getDescription

public String getDescription()

Description copied from interface: SilverpeasContent

Gets the description of this content if any.

Specified by:

getDescription in interface SilverpeasContent

Returns:

the resource description. Can be empty if no description was set or no description is defined for a such content.