com.goldencode.p2j.ui

Class DirectUploadDef

java.lang.Object

com.goldencode.p2j.ui.DirectUploadDef

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

ClientDirectUploadDef

public class DirectUploadDef
extends java.lang.Object
implements java.io.Externalizable

The DirectUploadDef class represents information for a direct upload definition.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int[]	eventCodes An array of legacy event codes.
private java.lang.String[]	filters The variable holds an array of file system selection dialog filters.
private boolean	multiple Represents a boolean flag indicating whether multiple uploads is enabled or not.
private java.lang.String	title A title for the upload dialog.
private boolean	upload Represents the upload status of a file, true for success, false for en error.
private java.lang.String	uploadDir Represents the local file system directory where files are uploaded.
private int	widgetId Represents the unique identifier for a widget.

Constructor Summary

Constructors

Constructor and Description
DirectUploadDef() Constructs a new DirectUploadDef object.
DirectUploadDef(int widgetId) Constructs a new DirectUploadDef object.
DirectUploadDef(int widgetId, int[] eventCodes, java.lang.String title, boolean multiple, boolean upload, java.lang.String uploadDir, java.lang.String[] filters) Constructs a new DirectUploadDef object with the given parameters.

Method Summary

Modifier and Type	Method and Description
static DirectUploadDef	find(java.util.List<DirectUploadDef> list, int widgetId) Finds a DirectUploadDef object in the given list based on the widgetId.
int[]	getEventCodes() Retrieves the array of legacy event codes associated with the DirectUploadDef object.
java.lang.String[]	getFilters() Retrieves the array of filters associated with the DirectUploadDef object.
java.lang.String	getTitle() Retrieves the title of the upload dialog.
java.lang.String	getUploadDir() Retrieves the directory for file uploads.
int	getWidgetId() Retrieves the ID of the widget.
boolean	isMultiple() Checks whether multiple files can be uploaded.
boolean	isUpload() Checks whether uploading is enabled for the DirectUploadDef object.
void	readExternal(java.io.ObjectInput in) The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	writeExternal(java.io.ObjectOutput out) The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class java.lang.Object

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

Field Detail

widgetId

private int widgetId

Represents the unique identifier for a widget.

eventCodes

private int[] eventCodes

An array of legacy event codes.

title

private java.lang.String title

A title for the upload dialog.

multiple

private boolean multiple

Represents a boolean flag indicating whether multiple uploads is enabled or not.

upload

private boolean upload

Represents the upload status of a file, true for success, false for en error.

uploadDir

private java.lang.String uploadDir

Represents the local file system directory where files are uploaded.

filters

private java.lang.String[] filters

The variable holds an array of file system selection dialog filters.

Constructor Detail

DirectUploadDef

public DirectUploadDef()

Constructs a new DirectUploadDef object.

DirectUploadDef

public DirectUploadDef(int widgetId)

Constructs a new DirectUploadDef object.

Parameters:

widgetId - the ID of the widget

DirectUploadDef

public DirectUploadDef(int widgetId,
                       int[] eventCodes,
                       java.lang.String title,
                       boolean multiple,
                       boolean upload,
                       java.lang.String uploadDir,
                       java.lang.String[] filters)

Constructs a new DirectUploadDef object with the given parameters.

Parameters:

widgetId - the ID of the widget

eventCodes - the array of legacy event codes

title - the title of the upload dialog

multiple - indicates whether multiple files can be uploaded

upload - indicates whether uploading is enabled

uploadDir - the directory for file uploads

filters - the array of upload filters

Method Detail

find

public static DirectUploadDef find(java.util.List<DirectUploadDef> list,
                                   int widgetId)

Finds a DirectUploadDef object in the given list based on the widgetId.

Parameters:

list - The list of DirectUploadDef objects to search from

widgetId - The widgetId to match against

Returns:

The DirectUploadDef object with matching widgetId, or null if not found

getWidgetId

public int getWidgetId()

Retrieves the ID of the widget.

Returns:

The widget ID.

getEventCodes

public int[] getEventCodes()

Retrieves the array of legacy event codes associated with the DirectUploadDef object.

Returns:

The array of event codes

getTitle

public java.lang.String getTitle()

Retrieves the title of the upload dialog.

Returns:

The title of the upload dialog.

isMultiple

public boolean isMultiple()

Checks whether multiple files can be uploaded.

Returns:

true if multiple files can be uploaded, false otherwise

isUpload

public boolean isUpload()

Checks whether uploading is enabled for the DirectUploadDef object.

Returns:

true if uploading is enabled, false otherwise.

getUploadDir

public java.lang.String getUploadDir()

Retrieves the directory for file uploads.

Returns:

The upload directory as a String.

getFilters

public java.lang.String[] getFilters()

Retrieves the array of filters associated with the DirectUploadDef object.

Returns:

The array of filters as a String[]

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - the stream to write the object to

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - the stream to read data from in order to restore the object

Throws:

java.io.IOException

java.lang.ClassNotFoundException