Package com.xwiki.ideas.rest

Interface IdeasResource

@Unstable
public interface IdeasResource

Since:

1.14

Version:

$Id: 9d98d18a9f4bbcbd1ac2afe37bc416a732e50703 $

Method Summary

Modifier and Type	Method	Description
Idea	get(String xwikiName, String spaceName, String pageName)
Idea	removeVote(String xwikiName, String spaceName, String pageName)	Removes the vote of the current user from the page containing the desired idea.
Idea	vote(String xwikiName, String spaceName, String pageName, String value)	Casts the vote of the current user to the page containing an idea.

Method Detail

get

Idea get(String xwikiName,
         String spaceName,
         String pageName)
  throws org.xwiki.rest.XWikiRestException

Parameters:

xwikiName - The name of the wiki in which the page resides

spaceName - The spaces associated with the page

pageName - The name of the page

Returns:

A response containing a serialized version of a Idea in case it exists or an appropriate response code otherwise.

Throws:

org.xwiki.rest.XWikiRestException - if the URL is malformed

vote

Idea vote(String xwikiName,
          String spaceName,
          String pageName,
          String value)
   throws org.xwiki.rest.XWikiRestException

Casts the vote of the current user to the page containing an idea.

Parameters:

xwikiName - The name of the wiki in which the page resides

spaceName - The spaces associated with the page

pageName - The name of the page

value - The value of the vote, usually true or false, to vote for or against the Idea

Returns:

A response containing a serialized version of a Idea in case of success or an appropriate response code otherwise.

Throws:

org.xwiki.rest.XWikiRestException - when the document is missing or lacks an Ideas poll

removeVote

Idea removeVote(String xwikiName,
                String spaceName,
                String pageName)
         throws org.xwiki.rest.XWikiRestException

Removes the vote of the current user from the page containing the desired idea.

Parameters:

xwikiName - The name of the wiki in which the page resides

spaceName - The spaces associated with the page

pageName - The name of the page

Returns:

A response containing a serialized version of a Idea in case of success or an appropriate response code otherwise.

Throws:

org.xwiki.rest.XWikiRestException - when the document is missing or lacks an Ideas poll