ERPendingAttachment Class Reference

Collaboration diagram for ERPendingAttachment:

List of all members.

Public Member Functions

String configurationName ()

ERPendingAttachment (File uploadedFile, String recommendedFilePath, String mimeType, int width, int height, String configurationName, String ownerID)

ERPendingAttachment (File uploadedFile, String recommendedFilePath, String mimeType, String configurationName, String ownerID)

ERPendingAttachment (File uploadedFile, String recommendedFilePath, String mimeType)

ERPendingAttachment (File uploadedFile, String recommendedFilePath)

ERPendingAttachment (File uploadedFile)

int height ()

boolean isPendingDelete ()

String mimeType ()

String ownerID ()

String recommendedFileName ()

String recommendedFilePath ()

void setConfigurationName (String configurationName)

void setHeight (int height)

void setMimeType (String mimeType)

void setOwnerID (String ownerID)

void setPendingDelete (boolean pendingDelete)

void setRecommendedFilePath (String recommendedFilePath)

void setUploadedFile (File uploadedFile)

void setWidth (int width)

String toString ()

File uploadedFile ()

int width ()

Private Attributes

String _configurationName

int _height

String _mimeType

String _ownerID

boolean _pendingDelete

String _recommendedFilePath

File _uploadedFile

int _width

Detailed Description

ERPendingAttachment is just a convenience wrapper for tracking uploaded file state for later passing into an attachment processor.

Author:: mschrag

Constructor & Destructor Documentation

ERPendingAttachment ( File uploadedFile )

Constructs an ERPendingAttachment.

Parameters:

uploadedFile

the uploaded temporary file (which will be deleted at the end)

ERPendingAttachment	(	File	uploadedFile,
		String	recommendedFilePath
	)

Constructs an ERPendingAttachment.

Parameters:

	uploadedFile	the uploaded temporary file (which will be deleted at the end)
	recommendedFilePath	the path recommended by the user during import

ERPendingAttachment	(	File	uploadedFile,
		String	recommendedFilePath,
		String	mimeType
	)

Constructs an ERPendingAttachment.

Parameters:

	uploadedFile	the uploaded temporary file (which will be deleted at the end)
	recommendedFilePath	the path recommended by the user during import
	mimeType	the mimeType to use (null = guess based on file extension)

ERPendingAttachment	(	File	uploadedFile,
		String	recommendedFilePath,
		String	mimeType,
		String	configurationName,
		String	ownerID
	)

Constructs an ERPendingAttachment.

Parameters:

	uploadedFile	the uploaded temporary file (which will be deleted at the end)
	recommendedFilePath	the path recommended by the user during import
	mimeType	the mimeType to use (null = guess based on file extension)
	configurationName	the name of the configuration settings to use for this processor (see top level docs)
	ownerID	an arbitrary string that represents the ID of the "owner" of this thumbnail (Person.primaryKey, for instance)

ERPendingAttachment	(	File	uploadedFile,
		String	recommendedFilePath,
		String	mimeType,
		int	width,
		int	height,
		String	configurationName,
		String	ownerID
	)

Constructs an ERPendingAttachment.

Parameters:

	uploadedFile	the uploaded temporary file (which will be deleted at the end)
	recommendedFilePath	the path recommended by the user during import
	mimeType	the mimeType to use (null = guess based on file extension)
	width	the desired width of the attachment
	height	the desired height of the attachment
	configurationName	the name of the configuration settings to use for this processor (see top level docs)
	ownerID	an arbitrary string that represents the ID of the "owner" of this thumbnail (Person.primaryKey, for instance)

Member Function Documentation

String configurationName ( )

Returns the name of the configuration settings to use for this upload.

Returns:: the name of the configuration settings to use for this upload

int height ( )

Returns the desired height of this attachment.

Returns:: the desired height of this attachment

boolean isPendingDelete ( )

Returns whether or not this attachment should be deleted after import.

Returns:: whether or not this attachment should be deleted after import

String mimeType ( )

Returns the mime type (or null if there isn't an explicit one) for this file.

Returns:: the mime type (or null if there isn't an explicit one) for this file

String ownerID ( )

Returns the arbitrary string that represents the ID of the "owner" of this attachment (Person.primaryKey, for instance).

Returns:: the arbitrary string that represents the ID of the "owner" of this attachment (Person.primaryKey, for instance)

String recommendedFileName ( )

Returns the cleansed file name recommended by the user during import.

Returns:: the cleansed file name recommended by the user during import

String recommendedFilePath ( )

Returns the path recommended by the user during import.

Returns:: the path recommended by the user during import

void setConfigurationName ( String configurationName )

Sets the name of the configuration settings to use for this upload.

Parameters:

configurationName

the name of the configuration settings to use for this upload

void setHeight ( int height )

Sets the desired height of this attachment (or -1 to not specify).

Parameters:

height

the desired height of this attachment

void setMimeType ( String mimeType )

Sets the mime type (or null if there isn't an explicit one) for this file.

Parameters:

mimeType

the mime type (or null if there isn't an explicit one) for this file

void setOwnerID ( String ownerID )

Sets the arbitrary string that represents the ID of the "owner" of this attachment (Person.primaryKey, for instance).

Parameters:

ownerID

the arbitrary string that represents the ID of the "owner" of this attachment

void setPendingDelete ( boolean pendingDelete )

Sets whether or not this attachment should be deleted after import.

Parameters:

pendingDelete

whether or not this attachment should be deleted after import

void setRecommendedFilePath ( String recommendedFilePath )

Sets the path recommended by the user during import.

Parameters:

recommendedFilePath

the path recommended by the user during import

void setUploadedFile ( File uploadedFile )

Sets the uploaded temporary file (which will be deleted at the end).

Parameters:

uploadedFile

the uploaded temporary file

void setWidth ( int width )

Sets the desired width of this attachment (or -1 to not specify).

Parameters:

width

the desired width of this attachment

String toString ( )

File uploadedFile ( )

Returns the uploaded temporary file (which will be deleted at the end).

Returns:: the uploaded temporary file

int width ( )

Returns the desired width of this attachment.

Returns:: the desired width of this attachment

Member Data Documentation

String _configurationName [private]

int _height [private]

String _mimeType [private]

String _ownerID [private]

boolean _pendingDelete [private]

String _recommendedFilePath [private]

File _uploadedFile [private]

int _width [private]

The documentation for this class was generated from the following file:

/opt/source/Wonder/Frameworks/BusinessLogic/ERAttachment/Sources/er/attachment/model/ERPendingAttachment.java


Public Member Functions
String	configurationName ()
	ERPendingAttachment (File uploadedFile, String recommendedFilePath, String mimeType, int width, int height, String configurationName, String ownerID)
	ERPendingAttachment (File uploadedFile, String recommendedFilePath, String mimeType, String configurationName, String ownerID)
	ERPendingAttachment (File uploadedFile, String recommendedFilePath, String mimeType)
	ERPendingAttachment (File uploadedFile, String recommendedFilePath)
	ERPendingAttachment (File uploadedFile)
int	height ()
boolean	isPendingDelete ()
String	mimeType ()
String	ownerID ()
String	recommendedFileName ()
String	recommendedFilePath ()
void	setConfigurationName (String configurationName)
void	setHeight (int height)
void	setMimeType (String mimeType)
void	setOwnerID (String ownerID)
void	setPendingDelete (boolean pendingDelete)
void	setRecommendedFilePath (String recommendedFilePath)
void	setUploadedFile (File uploadedFile)
void	setWidth (int width)
String	toString ()
File	uploadedFile ()
int	width ()
Private Attributes
String	_configurationName
int	_height
String	_mimeType
String	_ownerID
boolean	_pendingDelete
String	_recommendedFilePath
File	_uploadedFile
int	_width