com.atlassian.confluence.plugins.rest.entities
Class AttachmentEntity

java.lang.Object
  extended by com.atlassian.confluence.plugins.rest.entities.SearchResultEntity
      extended by com.atlassian.confluence.plugins.rest.entities.AttachmentEntity

public class AttachmentEntity
extends SearchResultEntity


Field Summary
 
Fields inherited from class com.atlassian.confluence.plugins.rest.entities.SearchResultEntity
id
 
Constructor Summary
AttachmentEntity()
           
 
Method Summary
 void addLink(com.atlassian.plugins.rest.common.Link link)
          Add a link to the list
 String getComment()
          Comment for the attachment.
 String getContentType()
          MIME type for the attached file, as reported by the browser when uploaded.
 DateEntity getCreatedDate()
          Date this attachment was created.
 String getFileExtension()
          Returns the file extension of the attachment.
 String getFileName()
          Name of the file.
 long getFileSize()
          Filesize in bytes.
 String getIconClass()
           
 DateEntity getLastModifiedDate()
          Date this attachment was last modified.
 List<com.atlassian.plugins.rest.common.Link> getLinks()
          Links to this attachment, should always contain "self".
 String getNiceFileSize()
          Human readable representation of the filesize such as 16k
 String getNiceType()
          A nice type representation of the mime type such as "image" or "pdf"
 String getOwnerId()
          Id of the owner of this attachment.
 String getParentTitle()
          Title of the parent of this attachment.
 SpaceEntity getSpace()
          Space where this attachment (and it's parent page if any) resides.
 int getThumbnailHeight()
           
 com.atlassian.plugins.rest.common.Link getThumbnailLink()
          Link to a thumbnail representation of this attachment, only applicable to images.
 int getThumbnailWidth()
           
 String getTitle()
          Title of the attachment.
 String getType()
           
 int getVersion()
          Version number for the attachment.
 String getWikiLink()
          Link to this attachment in wiki format.
 void setComment(String comment)
          Comment for the attachment.
 void setContentType(String contentType)
          MIME type for the attached file, as reported by the browser when uploaded.
 void setCreatedDate(DateEntity createdDate)
          Date this attachment was created.
 void setFileName(String fileName)
          Name of the file.
 void setFileSize(long fileSize)
          Filesize in bytes.
 void setIconClass(String iconClass)
           
 void setLastModifiedDate(DateEntity lastModifiedDate)
          Date this attachment was last modified.
 void setNiceFileSize(String niceFileSize)
          Human readable representation of the filesize such as 16k
 void setNiceType(String niceType)
          A nice type representation of the mime type such as "image" or "pdf"
 void setOwnerId(String ownerId)
          Id of the owner of this attachment.
 void setParentTitle(String parentTitle)
          Title of the parent of this attachment.
 void setSpace(SpaceEntity space)
          Space where this attachment (and it's parent page if any) resides.
 void setThumbnailHeight(int thumbnailHeight)
           
 void setThumbnailLink(com.atlassian.plugins.rest.common.Link thumbnailLink)
          Link to a thumbnail representation of this attachment, only applicable to images.
 void setThumbnailWidth(int thumbnailWidth)
           
 void setTitle(String title)
          Title of the attachment.
 void setVersion(int version)
          Version number for the attachment.
 void setWikiLink(String wikiLink)
          Link to this attachment in wiki format.
 
Methods inherited from class com.atlassian.confluence.plugins.rest.entities.SearchResultEntity
getId, getIdLong, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttachmentEntity

public AttachmentEntity()
Method Detail

getType

public String getType()
Returns:
the type

getOwnerId

public String getOwnerId()
Id of the owner of this attachment.

Returns:
the ownerId

setOwnerId

public void setOwnerId(String ownerId)
Id of the owner of this attachment.

Parameters:
ownerId - the ownerId to set

getParentTitle

public String getParentTitle()
Title of the parent of this attachment.

Returns:
the parentTitle

setParentTitle

public void setParentTitle(String parentTitle)
Title of the parent of this attachment.

Parameters:
parentTitle - the title to set

getFileName

public String getFileName()
Name of the file.

Returns:
the fileName

getContentType

public String getContentType()
MIME type for the attached file, as reported by the browser when uploaded.

Returns:
the contentType

setContentType

public void setContentType(String contentType)
MIME type for the attached file, as reported by the browser when uploaded.

Parameters:
contentType - the contentType to set

getFileSize

public long getFileSize()
Filesize in bytes.

Returns:
the fileSize

setFileSize

public void setFileSize(long fileSize)
Filesize in bytes.

Parameters:
fileSize - the fileSize to set

getNiceFileSize

public String getNiceFileSize()
Human readable representation of the filesize such as 16k

Returns:
the niceFileSize

setNiceFileSize

public void setNiceFileSize(String niceFileSize)
Human readable representation of the filesize such as 16k

Parameters:
niceFileSize - the niceFileSize to set

getComment

public String getComment()
Comment for the attachment.

Returns:
the comment

setComment

public void setComment(String comment)
Comment for the attachment.

Parameters:
comment - the comment to set

getVersion

public int getVersion()
Version number for the attachment.

Returns:
the version

setVersion

public void setVersion(int version)
Version number for the attachment.

Parameters:
version - the version to set

setNiceType

public void setNiceType(String niceType)
A nice type representation of the mime type such as "image" or "pdf"

Parameters:
niceType - the niceType to set

getNiceType

public String getNiceType()
A nice type representation of the mime type such as "image" or "pdf"

Returns:
the niceType

getTitle

public String getTitle()
Title of the attachment.

Returns:
the title

setTitle

public void setTitle(String title)
Title of the attachment.

Parameters:
title - the title to set

getThumbnailLink

public com.atlassian.plugins.rest.common.Link getThumbnailLink()
Link to a thumbnail representation of this attachment, only applicable to images.

Returns:
the thumbnailLink

setThumbnailLink

public void setThumbnailLink(com.atlassian.plugins.rest.common.Link thumbnailLink)
Link to a thumbnail representation of this attachment, only applicable to images.

Parameters:
thumbnailLink - the thumbnailLink to set

getThumbnailWidth

public int getThumbnailWidth()

setThumbnailWidth

public void setThumbnailWidth(int thumbnailWidth)

getThumbnailHeight

public int getThumbnailHeight()

setThumbnailHeight

public void setThumbnailHeight(int thumbnailHeight)

getWikiLink

public String getWikiLink()
Link to this attachment in wiki format.

Returns:
the wikiLink

setWikiLink

public void setWikiLink(String wikiLink)
Link to this attachment in wiki format.

Parameters:
wikiLink - the wikiLink to set

getSpace

public SpaceEntity getSpace()
Space where this attachment (and it's parent page if any) resides.

Returns:
the space

setSpace

public void setSpace(SpaceEntity space)
Space where this attachment (and it's parent page if any) resides.

Parameters:
space - the space to set

getLastModifiedDate

public DateEntity getLastModifiedDate()
Date this attachment was last modified.

Returns:
the lastModifiedDate

setLastModifiedDate

public void setLastModifiedDate(DateEntity lastModifiedDate)
Date this attachment was last modified.

Parameters:
lastModifiedDate - the lastModifiedDate to set

getCreatedDate

public DateEntity getCreatedDate()
Date this attachment was created.

Returns:
the createdDate

setCreatedDate

public void setCreatedDate(DateEntity createdDate)
Date this attachment was created.

Parameters:
createdDate - the createdDate to set

setFileName

public void setFileName(String fileName)
Name of the file. Also sets the title to the fileName.

Parameters:
fileName - the fileName to set

addLink

public void addLink(com.atlassian.plugins.rest.common.Link link)
Add a link to the list

Parameters:
link -

getLinks

public List<com.atlassian.plugins.rest.common.Link> getLinks()
Links to this attachment, should always contain "self".

Returns:
the links

getIconClass

public String getIconClass()

setIconClass

public void setIconClass(String iconClass)

getFileExtension

public String getFileExtension()
Returns the file extension of the attachment. If there is no extension, an empty string is returned.

Returns:
the file extension of the attachment in lower case


Copyright © 2003-2013 Atlassian. All Rights Reserved.