Package lumis.portal.file

Class FileConfig

java.lang.Object

lumis.portal.file.FileConfig

All Implemented Interfaces:

IDownloadableFile

@StableMinor(version="16.0",
             sinceVersion="4.0")
public class FileConfig
extends java.lang.Object
implements IDownloadableFile

Object that represents a file object

Since:

4.0.0

Version:

$Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

Field Summary

Fields

Modifier and Type	Field	Description
static int	TYPE_DEFAULT	Default file type.
static int	TYPE_FILES	This type indicates that this file belongs to a "files" data type.

Constructor Summary

Constructors

Constructor	Description
FileConfig(java.lang.String fileId)	Deprecated. Since 6.0.0, FileConfig should not be constructed directly.
FileConfig(java.lang.String fileId, java.lang.String name, java.lang.String fullPath, java.lang.String contentType, long fileSize, int type, java.lang.String serviceInstanceId)	Deprecated. Since 6.0.0, FileConfig should not be constructed directly.
FileConfig(java.lang.String fileId, FileParameter fileParameter, java.lang.String serviceInstanceId)	Deprecated. Since 6.0.0, FileConfig should not be constructed directly.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getContentLocaleId()	Returns the content locale identifier.
java.lang.String	getContentType()	Returns the file content type
long	getFileSize()	Returns the file size
java.lang.String	getFullPath()
java.lang.String	getId()
IFileMetadata	getMetadata()	Retrieves the metadata of the file.
java.lang.String	getName()	Returns the file name
java.lang.String	getServiceInstanceId()
int	getType()
void	setContentLocaleId(java.lang.String contentLocaleId)	Sets the content locale identifier.
void	setName(java.lang.String name)
void	setType(int type)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_DEFAULT

public static final int TYPE_DEFAULT

Default file type.

See Also:

Constant Field Values

TYPE_FILES

public static final int TYPE_FILES

This type indicates that this file belongs to a "files" data type.

See Also:

Constant Field Values

Constructor Detail

FileConfig

@Deprecated
public FileConfig(java.lang.String fileId)

Deprecated.

Since 6.0.0, FileConfig should not be constructed directly. Use IFileManager.add(lumis.portal.authentication.SessionConfig, String, java.io.File, String, String, lumis.util.ITransaction) instead.

FileConfig

@Deprecated
public FileConfig(java.lang.String fileId,
                  FileParameter fileParameter,
                  java.lang.String serviceInstanceId)
           throws java.io.IOException

Deprecated.

Since 6.0.0, FileConfig should not be constructed directly. Use IFileManager.add(lumis.portal.authentication.SessionConfig, String, java.io.File, String, String, lumis.util.ITransaction) instead.

Throws:

java.io.IOException

FileConfig

@Deprecated
public FileConfig(java.lang.String fileId,
                  java.lang.String name,
                  java.lang.String fullPath,
                  java.lang.String contentType,
                  long fileSize,
                  int type,
                  java.lang.String serviceInstanceId)

Deprecated.

Since 6.0.0, FileConfig should not be constructed directly. Use IFileManager.add(lumis.portal.authentication.SessionConfig, String, java.io.File, String, String, lumis.util.ITransaction) instead.

Method Detail

getContentType

public java.lang.String getContentType()

Description copied from interface: IDownloadableFile

Returns the file content type

Specified by:

getContentType in interface IDownloadableFile

Returns:

the file content type

getId

public java.lang.String getId()

getFileSize

public long getFileSize()

Description copied from interface: IDownloadableFile

Returns the file size

Specified by:

getFileSize in interface IDownloadableFile

Returns:

the file size

getFullPath

public java.lang.String getFullPath()

getName

public java.lang.String getName()

Description copied from interface: IDownloadableFile

Returns the file name

Specified by:

getName in interface IDownloadableFile

Returns:

the file name

getServiceInstanceId

public java.lang.String getServiceInstanceId()

setName

public void setName(java.lang.String name)

getType

public int getType()

setType

public void setType(int type)

getMetadata

public IFileMetadata getMetadata()

Retrieves the metadata of the file.

Returns:

the metadata of the file.

Since:

6.0.0

setContentLocaleId

public void setContentLocaleId(java.lang.String contentLocaleId)

Sets the content locale identifier.

Parameters:

contentLocaleId - the content locale identifier.

Since:

10.1.0

getContentLocaleId

public java.lang.String getContentLocaleId()

Returns the content locale identifier.

Returns:

the content locale identifier.

Since:

10.1.0