com.versionone.om

Class Attachment

java.lang.Object

com.versionone.om.Entity

com.versionone.om.Attachment

public class Attachment
extends Entity

Represents an attachment in the VersionOne system.

Field Summary

Fields inherited from class com.versionone.om.Entity

ASSET_STATE_VALUE, ASSET_VALUE, CHANGE_DATE_UTC, CONTENT_TYPE_VALUE, CONTENT_VALUE, CREATE_DATE_UTC, DELETE_OPERATION, DESCRIPTION_VALUE, FILENAME_VALUE, NAME_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDelete()
void	delete() Deletes the attachment.
BaseAsset	getAsset()
String	getContentType()
String	getContentURL()
String	getDescription()
String	getFilename()
String	getName()
IListValueProperty	getType()
String	getURL()
void	readFrom(InputStream input) Read the attachment's content from the input stream.
void	setAsset(BaseAsset asset)
void	setContentType(String contentType)
void	setDescription(String description)
void	setFilename(String filename)
void	setName(String name)
void	writeTo(OutputStream output) Write this attachment's content to the output stream.

Methods inherited from class com.versionone.om.Entity

equals, get, getChangeComment, getChangeDate, getChangedBy, getCreateComment, getCreateDate, getCreatedBy, getID, getInstance, hashCode, save, save, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getURL

public String getURL()

Returns:

URL to VersionOne Detail Page for this Attachment.

getContentURL

public String getContentURL()

Returns:

VersionOne URL where the contents of this attachment may be downloaded from.

getAsset

public BaseAsset getAsset()

Returns:

Asset this attachment is related to.

setAsset

public void setAsset(BaseAsset asset)

Parameters:

asset - this attachment is related to.

getDescription

public String getDescription()

Returns:

Description of this attachment.

setDescription

public void setDescription(String description)

Parameters:

description - of this attachment.

getContentType

public String getContentType()

Returns:

Content Type of this attachment.

setContentType

public void setContentType(String contentType)

Parameters:

contentType - of this attachment.

getFilename

public String getFilename()

Returns:

Filename of this attachment.

setFilename

public void setFilename(String filename)

Parameters:

filename - Filename of this attachment.

getName

public String getName()

Returns:

Name of this attachment.

setName

public void setName(String name)

Parameters:

name - Name of this attachment.

getType

public IListValueProperty getType()

Returns:

Type of this attachment.

writeTo

public void writeTo(OutputStream output)
             throws ApplicationUnavailableException

Write this attachment's content to the output stream.

Parameters:

output - Stream to write the content to.

Throws:

ApplicationUnavailableException - if coping fails.

readFrom

public void readFrom(InputStream input)
              throws ApplicationUnavailableException,
                     AttachmentLengthExceededException

Read the attachment's content from the input stream. Set the ContentType and Filename properties before calling this method.

Parameters:

input - Stream to read the content from.

Throws:

ApplicationUnavailableException - if appears any problem with connection to service.

AttachmentLengthExceededException - if attachment is too long.

canDelete

public boolean canDelete()

Returns:

True if the attachment can be deleted.

delete

public void delete()

Deletes the attachment.

Throws:

UnsupportedOperationException - The item is an invalid state for the Operation.