Package com.xwiki.pdfviewer.macro

Class PDFFile

java.lang.Object

com.xwiki.pdfviewer.macro.PDFFile

public class PDFFile
extends Object

Represents the resources for a given attachment.

Since:

2.6

Version:

$Id$

Constructor Summary

Constructors

Constructor	Description
PDFFile()	Empty constructor.
PDFFile(org.xwiki.model.reference.AttachmentReference attachmentReference, String url, boolean hasViewRights)	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	areViewRightsDelegated()	Return the delegated view rights.
Optional<org.xwiki.model.reference.AttachmentReference>	getAttachmentReference()	Get PDF file reference.
String	getURL()	Get the file download url.
boolean	hasViewRights()	Check if the view rights are given.
void	setAttachmentReference(org.xwiki.model.reference.AttachmentReference attachmentReference)	See getAttachmentReference().
void	setDelegatedViewRights(boolean delegatedViewRights)	See areViewRightsDelegated().
void	setHasViewRights(boolean hasViewRights)	See hasViewRights().
void	setUrl(String url)	See getURL().

Methods inherited from class java.lang.Object

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

Constructor Details

PDFFile

public PDFFile()

Empty constructor.

PDFFile

public PDFFile(org.xwiki.model.reference.AttachmentReference attachmentReference,
 String url,
 boolean hasViewRights)

Default constructor.

Parameters:

attachmentReference - the AttachmentReference of the PDF file.

url - file download url.

hasViewRights - true if the view rights are given, or false otherwise.

Method Details

setHasViewRights

public void setHasViewRights(boolean hasViewRights)

See hasViewRights().

Parameters:

hasViewRights - true if the view rights are given, or false otherwise

hasViewRights

public boolean hasViewRights()

Check if the view rights are given.

Returns:

true if the view rights are given, or false otherwise

getURL

public String getURL()

Get the file download url.

Returns:

the file download url.

getAttachmentReference

public Optional<org.xwiki.model.reference.AttachmentReference> getAttachmentReference()

Get PDF file reference.

Returns:

an Optional AttachmentReference, if the PDF file is attached to a wiki page.

setAttachmentReference

public void setAttachmentReference(org.xwiki.model.reference.AttachmentReference attachmentReference)

See getAttachmentReference().

Parameters:

attachmentReference - the attachment reference.

areViewRightsDelegated

public boolean areViewRightsDelegated()

Return the delegated view rights.

Returns:

true if the view rights have been delegated and false otherwise.

setDelegatedViewRights

public void setDelegatedViewRights(boolean delegatedViewRights)

See areViewRightsDelegated().

Parameters:

delegatedViewRights - the given view rights.

setUrl

public void setUrl(String url)

See getURL().

Parameters:

url - the url to the attachment.