b4j.core

Interface LongDescription

All Known Implementing Classes:

DefaultIssue.DefaultLongDescription

public interface LongDescription

Interface for a long description entry within a bug record. This object is used to store information about long description texts.

Author:

Ralph Schuster

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachment(long id) Creates and adds an attachment to this bug record.
void	clearAttachments() Removes all attachments.
int	getAttachmentCount() Returns the number of attachments.
Iterator<Attachment>	getAttachmentIterator() Returns all attachments.
Issue	getBugzillaBug() Returns the Bugzilla bug report this entry belongs to.
String	getId() Returns the description ID.
Date	getLastUpdate() Returns the date of last update.
String	getTheText() Returns the actual text.
String	getUpdateAuthor() Returns the author of the last update.
Date	getWhen() Returns the time of creation of this entry.
String	getWho() Returns the author of this text.
boolean	removeAttachment(Attachment o) Removes an attachment.
void	setId(String id) Sets the description ID
void	setLastUpdate(Date lastUpdate) Sets the date of last update.
void	setTheText(String theText) Sets the text of the description.
void	setUpdateAuthor(String updateAuthor) Sets the last update's author.
void	setWhen(Date when) Sets the time of creation.
void	setWho(String who) Sets the author of this text

Method Detail

getId

String getId()

Returns the description ID.

Returns:

the description ID

setId

void setId(String id)

Sets the description ID

Parameters:

id - - the ID to set

getBugzillaBug

Issue getBugzillaBug()

Returns the Bugzilla bug report this entry belongs to.

Returns:

the bug record of this long description.

getWho

String getWho()

Returns the author of this text.

Returns:

the editor

setWho

void setWho(String who)

Sets the author of this text

Parameters:

who - - the author to set

getWhen

Date getWhen()

Returns the time of creation of this entry.

Returns:

the time of creation

setWhen

void setWhen(Date when)

Sets the time of creation.

Parameters:

when - - the timestamp to set

getTheText

String getTheText()

Returns the actual text.

Returns:

the text

setTheText

void setTheText(String theText)

Sets the text of the description.

Parameters:

theText - - the text to set

getLastUpdate

Date getLastUpdate()

Returns the date of last update.

Returns:

date of last update.

setLastUpdate

void setLastUpdate(Date lastUpdate)

Sets the date of last update.

Parameters:

lastUpdate - date to be set

getUpdateAuthor

String getUpdateAuthor()

Returns the author of the last update.

Returns:

name of author

setUpdateAuthor

void setUpdateAuthor(String updateAuthor)

Sets the last update's author.

Parameters:

updateAuthor - author to be set

addAttachment

void addAttachment(long id)

Creates and adds an attachment to this bug record.

Parameters:

the - attachment id referenced

clearAttachments

void clearAttachments()

Removes all attachments.

getAttachmentIterator

Iterator<Attachment> getAttachmentIterator()

Returns all attachments.

Returns:

iterator on all attachments.

removeAttachment

boolean removeAttachment(Attachment o)

Removes an attachment.

Parameters:

o - - the attachment to remove

Returns:

true if attachment was found and removed

getAttachmentCount

int getAttachmentCount()

Returns the number of attachments.

Returns:

number of attachments