com.communote.plugins.api.rest.v24.resource.timelineuser

Class GetCollectionTimelineUserParameter

java.lang.Object

com.communote.plugins.api.rest.v24.resource.timelineuser.GetCollectionTimelineUserParameter

public class GetCollectionTimelineUserParameter
extends Object

This class it the parameter class for the TimelineUser resource. It covers all the parameter and attributes of the HTTP GETCOLLECTION method.

Constructor Summary

Constructors

Constructor and Description
GetCollectionTimelineUserParameter() Default Constuctor necessary for json parsing
GetCollectionTimelineUserParameter(javax.ws.rs.core.MultivaluedMap<String,String> valueMap) This constructor parses all incoming parameter of a request into the class structure
GetCollectionTimelineUserParameter(String representation)

Method Summary

Modifier and Type	Method and Description
String	getAlias() Returns the Alias.
Integer	getCheckAtLeastMoreResults() Returns the CheckAtLeastMoreResults.
Long	getF_discussionId() Returns the F_discussionId.
Date	getF_endDate() Returns the F_endDate.
String	getF_fullTextSearchString() Returns the F_fullTextSearchString.
Boolean	getF_includeComments() Returns the F_includeComments.
Long	getF_noteId() Returns the F_noteId.
String	getF_noteSearchString() Returns the F_noteSearchString.
Long	getF_parentNoteId() Returns the F_parentNoteId.
String	getF_propertyFilter() Returns the F_propertyFilter.
Long	getF_retrieveOnlyNotesAfterDate() Returns the F_retrieveOnlyNotesAfterDate.
Long	getF_retrieveOnlyNotesAfterId() Returns the F_retrieveOnlyNotesAfterId.
Long	getF_retrieveOnlyNotesBeforeDate() Returns the F_retrieveOnlyNotesBeforeDate.
Long	getF_retrieveOnlyNotesBeforeId() Returns the F_retrieveOnlyNotesBeforeId.
Boolean	getF_showDirectMessages() Returns the F_showDirectMessages.
Boolean	getF_showDiscussionParticipation() Returns the F_showDiscussionParticipation.
Boolean	getF_showFavorites() Returns the F_showFavorites.
Boolean	getF_showFollowedItems() Returns the F_showFollowedItems.
Boolean	getF_showNotesForMe() Returns the F_showNotesForMe.
Boolean	getF_showOnlyDiscussions() Returns the F_showOnlyDiscussions.
Boolean	getF_showOnlyRootNotes() Returns the F_showOnlyRootNotes.
Date	getF_startDate() Returns the F_startDate.
Long[]	getF_tagIds() Returns the F_tagIds.
String	getF_tagPrefix() Returns the F_tagPrefix.
Long	getF_targetTopicId() Returns the F_targetTopicId.
EF_topicAccess	getF_topicAccess() Returns the constant F_topicAccess.
String[]	getF_topicAliases() Returns the F_topicAliases.
Long[]	getF_topicIds() Returns the F_topicIds.
Long[]	getF_topicIdsToExclude() Returns the F_topicIdsToExclude.
Boolean	getF_topicRelated() Returns the F_topicRelated.
String[]	getF_userAliases() Returns the F_userAliases.
Long[]	getF_userIds() Returns the F_userIds.
String	getF_userSearchString() Returns the F_userSearchString.
String	getFirstName() Returns the FirstName.
String	getLastName() Returns the LastName.
Integer	getMaxCount() Returns the MaxCount.
Integer	getOffset() Returns the Offset.
Long	getUserId() Returns the UserId.
void	handleUnknownProperties(String key, Object value) Log unknown properties to loglevel warn.
void	setAlias(String alias) Sets Alias.
void	setCheckAtLeastMoreResults(Integer checkAtLeastMoreResults) Sets CheckAtLeastMoreResults.
void	setF_discussionId(Long f_discussionId) Sets F_discussionId.
void	setF_endDate(Date f_endDate) Sets F_endDate.
void	setF_fullTextSearchString(String f_fullTextSearchString) Sets F_fullTextSearchString.
void	setF_includeComments(Boolean f_includeComments) Sets F_includeComments.
void	setF_noteId(Long f_noteId) Sets F_noteId.
void	setF_noteSearchString(String f_noteSearchString) Sets F_noteSearchString.
void	setF_parentNoteId(Long f_parentNoteId) Sets F_parentNoteId.
void	setF_propertyFilter(String f_propertyFilter) Sets F_propertyFilter.
void	setF_retrieveOnlyNotesAfterDate(Long f_retrieveOnlyNotesAfterDate) Sets F_retrieveOnlyNotesAfterDate.
void	setF_retrieveOnlyNotesAfterId(Long f_retrieveOnlyNotesAfterId) Sets F_retrieveOnlyNotesAfterId.
void	setF_retrieveOnlyNotesBeforeDate(Long f_retrieveOnlyNotesBeforeDate) Sets F_retrieveOnlyNotesBeforeDate.
void	setF_retrieveOnlyNotesBeforeId(Long f_retrieveOnlyNotesBeforeId) Sets F_retrieveOnlyNotesBeforeId.
void	setF_showDirectMessages(Boolean f_showDirectMessages) Sets F_showDirectMessages.
void	setF_showDiscussionParticipation(Boolean f_showDiscussionParticipation) Sets F_showDiscussionParticipation.
void	setF_showFavorites(Boolean f_showFavorites) Sets F_showFavorites.
void	setF_showFollowedItems(Boolean f_showFollowedItems) Sets F_showFollowedItems.
void	setF_showNotesForMe(Boolean f_showNotesForMe) Sets F_showNotesForMe.
void	setF_showOnlyDiscussions(Boolean f_showOnlyDiscussions) Sets F_showOnlyDiscussions.
void	setF_showOnlyRootNotes(Boolean f_showOnlyRootNotes) Sets F_showOnlyRootNotes.
void	setF_startDate(Date f_startDate) Sets F_startDate.
void	setF_tagIds(Long[] f_tagIds) Sets F_tagIds.
void	setF_tagPrefix(String f_tagPrefix) Sets F_tagPrefix.
void	setF_targetTopicId(Long f_targetTopicId) Sets F_targetTopicId.
void	setF_topicAccess(EF_topicAccess f_topicAccess) Sets the constant F_topicAccess.
void	setF_topicAliases(String[] f_topicAliases) Sets F_topicAliases.
void	setF_topicIds(Long[] f_topicIds) Sets F_topicIds.
void	setF_topicIdsToExclude(Long[] f_topicIdsToExclude) Sets F_topicIdsToExclude.
void	setF_topicRelated(Boolean f_topicRelated) Sets F_topicRelated.
void	setF_userAliases(String[] f_userAliases) Sets F_userAliases.
void	setF_userIds(Long[] f_userIds) Sets F_userIds.
void	setF_userSearchString(String f_userSearchString) Sets F_userSearchString.
void	setFirstName(String firstName) Sets FirstName.
void	setLastName(String lastName) Sets LastName.
void	setMaxCount(Integer maxCount) Sets MaxCount.
void	setOffset(Integer offset) Sets Offset.
void	setUserId(Long userId) Sets UserId.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCollectionTimelineUserParameter

public GetCollectionTimelineUserParameter()

Default Constuctor necessary for json parsing

GetCollectionTimelineUserParameter

public GetCollectionTimelineUserParameter(javax.ws.rs.core.MultivaluedMap<String,String> valueMap)
                                   throws RestApiIllegalRequestParameterException

This constructor parses all incoming parameter of a request into the class structure

Throws:

RestApiIllegalRequestParameterException

GetCollectionTimelineUserParameter

public GetCollectionTimelineUserParameter(String representation)
                                   throws org.codehaus.jackson.JsonParseException,
                                          org.codehaus.jackson.map.JsonMappingException,
                                          IOException

Throws:

org.codehaus.jackson.JsonParseException

org.codehaus.jackson.map.JsonMappingException

IOException

Method Detail

setUserId

public void setUserId(Long userId)

Sets UserId.

Parameters:

userId -

getUserId

public Long getUserId()

Returns the UserId.

Returns:

the UserId

setAlias

public void setAlias(String alias)

Sets Alias.

Parameters:

alias -

getAlias

public String getAlias()

Returns the Alias.

Returns:

the Alias

setLastName

public void setLastName(String lastName)

Sets LastName.

Parameters:

lastName -

getLastName

public String getLastName()

Returns the LastName.

Returns:

the LastName

setFirstName

public void setFirstName(String firstName)

Sets FirstName.

Parameters:

firstName -

getFirstName

public String getFirstName()

Returns the FirstName.

Returns:

the FirstName

setOffset

public void setOffset(Integer offset)

Sets Offset.

Parameters:

offset -

getOffset

public Integer getOffset()

Returns the Offset.

Returns:

the Offset

setMaxCount

public void setMaxCount(Integer maxCount)

Sets MaxCount.

Parameters:

maxCount -

getMaxCount

public Integer getMaxCount()

Returns the MaxCount.

Returns:

the MaxCount

setCheckAtLeastMoreResults

public void setCheckAtLeastMoreResults(Integer checkAtLeastMoreResults)

Sets CheckAtLeastMoreResults.

Parameters:

checkAtLeastMoreResults -

getCheckAtLeastMoreResults

public Integer getCheckAtLeastMoreResults()

Returns the CheckAtLeastMoreResults.

Returns:

the CheckAtLeastMoreResults

setF_discussionId

public void setF_discussionId(Long f_discussionId)

Sets F_discussionId.

Parameters:

f_discussionId -

getF_discussionId

public Long getF_discussionId()

Returns the F_discussionId.

Returns:

the F_discussionId

setF_showFollowedItems

public void setF_showFollowedItems(Boolean f_showFollowedItems)

Sets F_showFollowedItems.

Parameters:

f_showFollowedItems -

getF_showFollowedItems

public Boolean getF_showFollowedItems()

Returns the F_showFollowedItems.

Returns:

the F_showFollowedItems

setF_showNotesForMe

public void setF_showNotesForMe(Boolean f_showNotesForMe)

Sets F_showNotesForMe.

Parameters:

f_showNotesForMe -

getF_showNotesForMe

public Boolean getF_showNotesForMe()

Returns the F_showNotesForMe.

Returns:

the F_showNotesForMe

setF_topicIds

public void setF_topicIds(Long[] f_topicIds)

Sets F_topicIds.

Parameters:

f_topicIds -

getF_topicIds

public Long[] getF_topicIds()

Returns the F_topicIds.

Returns:

the F_topicIds

setF_topicAliases

public void setF_topicAliases(String[] f_topicAliases)

Sets F_topicAliases.

Parameters:

f_topicAliases -

getF_topicAliases

public String[] getF_topicAliases()

Returns the F_topicAliases.

Returns:

the F_topicAliases

setF_topicIdsToExclude

public void setF_topicIdsToExclude(Long[] f_topicIdsToExclude)

Sets F_topicIdsToExclude.

Parameters:

f_topicIdsToExclude -

getF_topicIdsToExclude

public Long[] getF_topicIdsToExclude()

Returns the F_topicIdsToExclude.

Returns:

the F_topicIdsToExclude

setF_tagIds

public void setF_tagIds(Long[] f_tagIds)

Sets F_tagIds.

Parameters:

f_tagIds -

getF_tagIds

public Long[] getF_tagIds()

Returns the F_tagIds.

Returns:

the F_tagIds

setF_tagPrefix

public void setF_tagPrefix(String f_tagPrefix)

Sets F_tagPrefix.

Parameters:

f_tagPrefix -

getF_tagPrefix

public String getF_tagPrefix()

Returns the F_tagPrefix.

Returns:

the F_tagPrefix

setF_userIds

public void setF_userIds(Long[] f_userIds)

Sets F_userIds.

Parameters:

f_userIds -

getF_userIds

public Long[] getF_userIds()

Returns the F_userIds.

Returns:

the F_userIds

setF_userAliases

public void setF_userAliases(String[] f_userAliases)

Sets F_userAliases.

Parameters:

f_userAliases -

getF_userAliases

public String[] getF_userAliases()

Returns the F_userAliases.

Returns:

the F_userAliases

setF_startDate

public void setF_startDate(Date f_startDate)

Sets F_startDate.

Parameters:

f_startDate -

getF_startDate

public Date getF_startDate()

Returns the F_startDate.

Returns:

the F_startDate

setF_endDate

public void setF_endDate(Date f_endDate)

Sets F_endDate.

Parameters:

f_endDate -

getF_endDate

public Date getF_endDate()

Returns the F_endDate.

Returns:

the F_endDate

setF_userSearchString

public void setF_userSearchString(String f_userSearchString)

Sets F_userSearchString.

Parameters:

f_userSearchString -

getF_userSearchString

public String getF_userSearchString()

Returns the F_userSearchString.

Returns:

the F_userSearchString

setF_noteSearchString

public void setF_noteSearchString(String f_noteSearchString)

Sets F_noteSearchString.

Parameters:

f_noteSearchString -

getF_noteSearchString

public String getF_noteSearchString()

Returns the F_noteSearchString.

Returns:

the F_noteSearchString

setF_fullTextSearchString

public void setF_fullTextSearchString(String f_fullTextSearchString)

Sets F_fullTextSearchString.

Parameters:

f_fullTextSearchString -

getF_fullTextSearchString

public String getF_fullTextSearchString()

Returns the F_fullTextSearchString.

Returns:

the F_fullTextSearchString

setF_parentNoteId

public void setF_parentNoteId(Long f_parentNoteId)

Sets F_parentNoteId.

Parameters:

f_parentNoteId -

getF_parentNoteId

public Long getF_parentNoteId()

Returns the F_parentNoteId.

Returns:

the F_parentNoteId

setF_showDirectMessages

public void setF_showDirectMessages(Boolean f_showDirectMessages)

Sets F_showDirectMessages.

Parameters:

f_showDirectMessages -

getF_showDirectMessages

public Boolean getF_showDirectMessages()

Returns the F_showDirectMessages.

Returns:

the F_showDirectMessages

setF_showFavorites

public void setF_showFavorites(Boolean f_showFavorites)

Sets F_showFavorites.

Parameters:

f_showFavorites -

getF_showFavorites

public Boolean getF_showFavorites()

Returns the F_showFavorites.

Returns:

the F_showFavorites

setF_includeComments

public void setF_includeComments(Boolean f_includeComments)

Sets F_includeComments.

Parameters:

f_includeComments -

getF_includeComments

public Boolean getF_includeComments()

Returns the F_includeComments.

Returns:

the F_includeComments

setF_propertyFilter

public void setF_propertyFilter(String f_propertyFilter)

Sets F_propertyFilter.

Parameters:

f_propertyFilter -

getF_propertyFilter

public String getF_propertyFilter()

Returns the F_propertyFilter.

Returns:

the F_propertyFilter

setF_topicAccess

public void setF_topicAccess(EF_topicAccess f_topicAccess)

Sets the constant F_topicAccess.

Parameters:

the - constant f_topicAccess

getF_topicAccess

public EF_topicAccess getF_topicAccess()

Returns the constant F_topicAccess.

Returns:

the constant F_topicAccess

setF_showOnlyDiscussions

public void setF_showOnlyDiscussions(Boolean f_showOnlyDiscussions)

Sets F_showOnlyDiscussions.

Parameters:

f_showOnlyDiscussions -

getF_showOnlyDiscussions

public Boolean getF_showOnlyDiscussions()

Returns the F_showOnlyDiscussions.

Returns:

the F_showOnlyDiscussions

setF_showOnlyRootNotes

public void setF_showOnlyRootNotes(Boolean f_showOnlyRootNotes)

Sets F_showOnlyRootNotes.

Parameters:

f_showOnlyRootNotes -

getF_showOnlyRootNotes

public Boolean getF_showOnlyRootNotes()

Returns the F_showOnlyRootNotes.

Returns:

the F_showOnlyRootNotes

setF_showDiscussionParticipation

public void setF_showDiscussionParticipation(Boolean f_showDiscussionParticipation)

Sets F_showDiscussionParticipation.

Parameters:

f_showDiscussionParticipation -

getF_showDiscussionParticipation

public Boolean getF_showDiscussionParticipation()

Returns the F_showDiscussionParticipation.

Returns:

the F_showDiscussionParticipation

setF_targetTopicId

public void setF_targetTopicId(Long f_targetTopicId)

Sets F_targetTopicId.

Parameters:

f_targetTopicId -

getF_targetTopicId

public Long getF_targetTopicId()

Returns the F_targetTopicId.

Returns:

the F_targetTopicId

setF_noteId

public void setF_noteId(Long f_noteId)

Sets F_noteId.

Parameters:

f_noteId -

getF_noteId

public Long getF_noteId()

Returns the F_noteId.

Returns:

the F_noteId

setF_topicRelated

public void setF_topicRelated(Boolean f_topicRelated)

Sets F_topicRelated.

Parameters:

f_topicRelated -

getF_topicRelated

public Boolean getF_topicRelated()

Returns the F_topicRelated.

Returns:

the F_topicRelated

setF_retrieveOnlyNotesBeforeId

public void setF_retrieveOnlyNotesBeforeId(Long f_retrieveOnlyNotesBeforeId)

Sets F_retrieveOnlyNotesBeforeId.

Parameters:

f_retrieveOnlyNotesBeforeId -

getF_retrieveOnlyNotesBeforeId

public Long getF_retrieveOnlyNotesBeforeId()

Returns the F_retrieveOnlyNotesBeforeId.

Returns:

the F_retrieveOnlyNotesBeforeId

setF_retrieveOnlyNotesBeforeDate

public void setF_retrieveOnlyNotesBeforeDate(Long f_retrieveOnlyNotesBeforeDate)

Sets F_retrieveOnlyNotesBeforeDate.

Parameters:

f_retrieveOnlyNotesBeforeDate -

getF_retrieveOnlyNotesBeforeDate

public Long getF_retrieveOnlyNotesBeforeDate()

Returns the F_retrieveOnlyNotesBeforeDate.

Returns:

the F_retrieveOnlyNotesBeforeDate

setF_retrieveOnlyNotesAfterId

public void setF_retrieveOnlyNotesAfterId(Long f_retrieveOnlyNotesAfterId)

Sets F_retrieveOnlyNotesAfterId.

Parameters:

f_retrieveOnlyNotesAfterId -

getF_retrieveOnlyNotesAfterId

public Long getF_retrieveOnlyNotesAfterId()

Returns the F_retrieveOnlyNotesAfterId.

Returns:

the F_retrieveOnlyNotesAfterId

setF_retrieveOnlyNotesAfterDate

public void setF_retrieveOnlyNotesAfterDate(Long f_retrieveOnlyNotesAfterDate)

Sets F_retrieveOnlyNotesAfterDate.

Parameters:

f_retrieveOnlyNotesAfterDate -

getF_retrieveOnlyNotesAfterDate

public Long getF_retrieveOnlyNotesAfterDate()

Returns the F_retrieveOnlyNotesAfterDate.

Returns:

the F_retrieveOnlyNotesAfterDate

handleUnknownProperties

public void handleUnknownProperties(String key,
                                    Object value)

Log unknown properties to loglevel warn.