er.attachment.model

Class ERPendingAttachment

java.lang.Object

er.attachment.model.ERPendingAttachment

public class ERPendingAttachment
extends Object

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

ERPendingAttachment はファイル・アップロード・ステータスを調べるための簡単なラッパーです。

Author:

mschrag

Constructor Summary

Constructors

Constructor and Description
ERPendingAttachment(File uploadedFile) Constructs an ERPendingAttachment.
ERPendingAttachment(File uploadedFile, String recommendedFilePath) Constructs an ERPendingAttachment.
ERPendingAttachment(File uploadedFile, String recommendedFilePath, String mimeType) Constructs an ERPendingAttachment.
ERPendingAttachment(File uploadedFile, String recommendedFilePath, String mimeType, int width, int height, String configurationName, String ownerID) Constructs an ERPendingAttachment.
ERPendingAttachment(File uploadedFile, String recommendedFilePath, String mimeType, String configurationName, String ownerID) Constructs an ERPendingAttachment.

Method Summary

Modifier and Type	Method and Description
String	configurationName() Returns the name of the configuration settings to use for this upload.
int	height() Returns the desired height of this attachment.
boolean	isPendingDelete() 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.
String	ownerID() 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.
String	recommendedFilePath() 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.
void	setHeight(int height) Sets the desired height of this attachment (or -1 to not specify).
void	setMimeType(String mimeType) Sets 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).
void	setPendingDelete(boolean pendingDelete) Sets whether or not this attachment should be deleted after import.
void	setRecommendedFilePath(String recommendedFilePath) Sets the path recommended by the user during import.
void	setUploadedFile(File uploadedFile) Sets the uploaded temporary file (which will be deleted at the end).
void	setWidth(int width) Sets the desired width of this attachment (or -1 to not specify).
String	toString()
File	uploadedFile() Returns the uploaded temporary file (which will be deleted at the end).
int	width() Returns the desired width of this attachment.

Methods inherited from class java.lang.Object

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

Constructor Detail

ERPendingAttachment

public ERPendingAttachment(File uploadedFile)

Constructs an ERPendingAttachment.

コンストラクター

Parameters:

uploadedFile -

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

アップロードする一時的ファイル（最後には削除される）

ERPendingAttachment

public 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

public 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)

使用する mimeType (null = ファイル拡張子で自動認識)

ERPendingAttachment

public 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)

使用する mimeType (null = ファイル拡張子で自動認識)

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)

サムナイルの「owner」を持つ表記文字列　(例えば、Person.primaryKey)

ERPendingAttachment

public 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)

使用する mimeType (null = ファイル拡張子で自動認識)

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)

サムナイルの「owner」を持つ表記文字列　(例えば、Person.primaryKey)

Method Detail

uploadedFile

public File uploadedFile()

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

一時的のアップロード・ファイルを戻します。（最後には削除される）

Returns:

the uploaded temporary file

一時的のアップロード・ファイル

setUploadedFile

public void setUploadedFile(File uploadedFile)

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

一時的のアップロード・ファイルをセットします。（最後には削除される）

Parameters:

uploadedFile -

the uploaded temporary file

一時的のアップロード・ファイル

recommendedFilePath

public String recommendedFilePath()

Returns the path recommended by the user during import.

ユーザによる希望のファイル・パスを戻します。

Returns:

the path recommended by the user during import

ユーザによる希望のファイル・パス

setRecommendedFilePath

public void setRecommendedFilePath(String recommendedFilePath)

Sets the path recommended by the user during import.

ユーザによる希望のファイル・パスをセットします。

Parameters:

recommendedFilePath -

the path recommended by the user during import

ユーザによる希望のファイル・パス

recommendedFileName

public String recommendedFileName()

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

ユーザによる希望のファイル名を戻します。

Returns:

the cleansed file name recommended by the user during import

ユーザによる希望のファイル名

mimeType

public String mimeType()

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

このファイルの mime type (指定が無い場合には null) を戻します。

Returns:

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

このファイルの mime type (指定が無い場合には null)

setMimeType

public void setMimeType(String mimeType)

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

このファイルの mime type (指定が無い場合には null) をセットします。

Parameters:

mimeType -

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

このファイルの mime type (指定が無い場合には null)

configurationName

public 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

このアップロードに使用する定義ファイル名

setConfigurationName

public 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

このアップロードに使用する定義ファイル名

ownerID

public String ownerID()

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

「owner」を持つ表記文字列　(例えば、Person.primaryKey) を戻します。

Returns:

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

「owner」を持つ表記文字列　(例えば、Person.primaryKey)

setOwnerID

public void setOwnerID(String ownerID)

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

「owner」を持つ表記文字列　(例えば、Person.primaryKey) をセットします。

Parameters:

ownerID -

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

「owner」を持つ表記文字列　(例えば、Person.primaryKey)

setPendingDelete

public 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

インポート後にアタッチメントを削除するかどうか

isPendingDelete

public boolean isPendingDelete()

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

インポート後にアタッチメントを削除するかどうかを戻します。

Returns:

whether or not this attachment should be deleted after import

インポート後にアタッチメントを削除するかどうか

setWidth

public void setWidth(int width)

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

アタッチメントの希望幅をセットします。 (又は -1 は未設定)

Parameters:

width -

the desired width of this attachment

アタッチメントの希望幅

width

public int width()

Returns the desired width of this attachment.

アタッチメントの希望幅を戻します。

Returns:

the desired width of this attachment

アタッチメントの希望幅

setHeight

public void setHeight(int height)

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

アタッチメントの希望高をセットします。 (又は -1 は未設定)

Parameters:

height -

the desired height of this attachment

アタッチメントの希望高

height

public int height()

Returns the desired height of this attachment.

アタッチメントの希望高を戻します。

Returns:

the desired height of this attachment

アタッチメントの希望高

toString

public String toString()

Overrides:

toString in class Object