com.atlassian.confluence.api.service.content

Interface AttachmentService.AttachmentFinder

All Superinterfaces:

SingleFetcher<Content>

Enclosing interface:

AttachmentService

public static interface AttachmentService.AttachmentFinder
extends SingleFetcher<Content>

A finder for locating attachments. In general calls to withX() apply restrictions on the attachments to be returned by fetchX() methods

Method Summary

Modifier and Type	Method and Description
PageResponse<Content>	fetchMany(PageRequest request) Fetch the attachments from the datastore that match the restrictions applied with the withX methods.
AttachmentService.AttachmentFinder	withContainerId(ContentId parentId) Restrict the attachments returned to those with the given parent.
AttachmentService.AttachmentFinder	withFilename(String filename) Restrict the attachments fetched to those with the given filename.
SingleFetcher<Content>	withId(ContentId attachmentId) Restrict the attachment returned by the fetch methods to those with the given attachmentId
AttachmentService.AttachmentFinder	withMediaType(String type) Restrict the attachments fetched to those with the given file type, these file types should match the string representation of a type in javax.ws.rs.core.MediaType

Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher

fetchOne, fetchOneOrNull

Method Detail

withId

SingleFetcher<Content> withId(ContentId attachmentId)

Restrict the attachment returned by the fetch methods to those with the given attachmentId

Parameters:

attachmentId - - the id of the attachment to look up

Returns:

a SingleFetcher that will return an attachment that has the given ID if it exists

withContainerId

AttachmentService.AttachmentFinder withContainerId(ContentId parentId)

Restrict the attachments returned to those with the given parent. Unless the attachment is being looked up by ID via the withId method, this method is compulsory.

Parameters:

parentId - - the id of a Content container that contains the attachments to be found

Returns:

this AttachmentFinder with the restriction applied

withFilename

AttachmentService.AttachmentFinder withFilename(String filename)

Restrict the attachments fetched to those with the given filename.

Parameters:

filename - - the filename to match

Returns:

this AttachmentFinder with the restriction applied

withMediaType

AttachmentService.AttachmentFinder withMediaType(String type)

Restrict the attachments fetched to those with the given file type, these file types should match the string representation of a type in javax.ws.rs.core.MediaType

Parameters:

type - - the media to match

Returns:

this AttachmentFinder with the restriction applied

fetchMany

PageResponse<Content> fetchMany(PageRequest request)

Fetch the attachments from the datastore that match the restrictions applied with the withX methods.

Parameters:

request - - a pageRequest to use to paginate the response, this will be limited if it exceeds system limits

Returns:

a pageResponse of Content that matches the given restrictions