org.xwiki.rest.resources
Class BaseAttachmentsResource

java.lang.Object
  org.xwiki.rest.XWikiResource
      org.xwiki.rest.resources.BaseAttachmentsResource

All Implemented Interfaces:

org.xwiki.component.phase.Initializable, XWikiRestComponent

Direct Known Subclasses:

SpaceAttachmentsResource, WikiAttachmentsResource

public class BaseAttachmentsResource
extends XWikiResource

Version:

$Id: BaseAttachmentsResource.java 21281 2009-06-13 19:22:09Z sdumitriu $

Nested Class Summary

Nested classes/interfaces inherited from class org.xwiki.rest.XWikiResource

XWikiResource.DocumentInfo

Field Summary

Fields inherited from class org.xwiki.rest.XWikiResource

componentManager, logger, objectFactory, queryManager, uriInfo, xwiki, xwikiApi, xwikiContext, xwikiUser

Constructor Summary

BaseAttachmentsResource()

Method Summary

Attachments

getAttachments(java.lang.String wikiName, java.lang.String name, java.lang.String page, java.lang.String space, java.lang.String author, java.lang.String types, java.lang.Integer start, java.lang.Integer number) Retrieves the attachments by filtering them.

Methods inherited from class org.xwiki.rest.XWikiResource

getDocumentInfo, getUriTemplate, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAttachmentsResource

public BaseAttachmentsResource()

Method Detail

getAttachments

public Attachments getAttachments(java.lang.String wikiName,
                                  java.lang.String name,
                                  java.lang.String page,
                                  java.lang.String space,
                                  java.lang.String author,
                                  java.lang.String types,
                                  java.lang.Integer start,
                                  java.lang.Integer number)
                           throws org.xwiki.query.QueryException

Retrieves the attachments by filtering them.

Parameters:

wikiName - The virtual wiki.

name - Name filter (include only attachments that matches this name)

page - Page filter (include only attachments are attached to a page matches this string)

space - Space filter (include only attachments are attached to a page in a space matching this string)

author - Author filter (include only attachments from an author who matches this string)

types - A comma separated list of string that will be matched against the actual mime type of the attachments.

start -

number -

Returns:

The list of the retrieved attachments.

Throws:

org.xwiki.query.QueryException