com.dotmarketing.portlets.fileassets.business
Interface FileAssetAPI

All Known Implementing Classes:

FileAssetAPIImpl

public interface FileAssetAPI

Field Summary

static java.lang.String	BINARY_FIELD
static java.lang.String	BINARY_FIELD_NAME
static java.lang.String	CONTENT_FIELD
static java.lang.String	DEFAULT_FILE_ASSET_STRUCTURE_DESCRIPTION
static java.lang.String	DEFAULT_FILE_ASSET_STRUCTURE_NAME
static java.lang.String	DEFAULT_FILE_ASSET_STRUCTURE_VELOCITY_VAR_NAME
static java.lang.String	DESCRIPTION
static java.lang.String	DESCRIPTION_NAME
static java.lang.String	FILE_NAME_FIELD
static java.lang.String	FILE_NAME_FIELD_NAME
static java.lang.String	HOST_FOLDER_FIELD
static java.lang.String	HOST_FOLDER_FIELD_NAME
static java.lang.String	META_DATA_FIELD
static java.lang.String	META_DATA_FIELD_NAME
static java.lang.String	META_DATA_TAB_NAME
static java.lang.String	MIMETYPE_FIELD
static java.lang.String	SHOW_ON_MENU
static java.lang.String	SHOW_ON_MENU_NAME
static java.lang.String	SIZE_FIELD
static java.lang.String	SORT_ORDER
static java.lang.String	SORT_ORDER_NAME
static java.lang.String	TITLE_FIELD
static java.lang.String	TITLE_FIELD_NAME

Method Summary

void	createBaseFileAssetFields(Structure structure)
boolean	fileNameExists(Host host, Folder folder, java.lang.String fileName, java.lang.String identifier)
java.util.List<FileAsset>	findFileAssetsByFolder(Folder parentFolder, java.lang.String sortBy, boolean live, boolean working, com.liferay.portal.model.User user, boolean respectFrontendRoles)
java.util.List<FileAsset>	findFileAssetsByFolder(Folder parentFolder, java.lang.String sortBy, boolean live, com.liferay.portal.model.User user, boolean respectFrontendRoles)
java.util.List<FileAsset>	findFileAssetsByFolder(Folder parentFolder, com.liferay.portal.model.User user, boolean respectFrontendRoles)
java.util.List<FileAsset>	findFileAssetsByHost(Host parentHost, com.liferay.portal.model.User user, boolean respectFrontendRoles)
FileAsset	fromContentlet(Contentlet con)
java.util.List<FileAsset>	fromContentlets(java.util.List<Contentlet> cons)
java.util.List<IFileAsset>	fromContentletsI(java.util.List<Contentlet> cons)
java.util.Map<java.lang.String,java.lang.String>	getMetaDataMap(Contentlet con, java.io.File binFile) Returns a map with the given binary file's meta data
java.lang.String	getRealAssetPath(java.lang.String inode)
java.lang.String	getRealAssetPath(java.lang.String inode, java.lang.String fileName)
java.lang.String	getRealAssetPath(java.lang.String inode, java.lang.String fileName, java.lang.String ext)
java.lang.String	getRelativeAssetPath(FileAsset fa)
boolean	isFileAsset(Contentlet c)
boolean	moveFile(Contentlet fileAssetCont, Folder parent, com.liferay.portal.model.User user, boolean respectFrontendRoles) Moves a given contentlet to a given folder
boolean	moveFile(Contentlet fileAssetCont, Host host, com.liferay.portal.model.User user, boolean respectFrontendRoles) Moves a given contentlet to a given host
boolean	renameFile(Contentlet fileAssetCont, java.lang.String newName, com.liferay.portal.model.User user, boolean respectFrontendRoles)

Field Detail

TITLE_FIELD

static final java.lang.String TITLE_FIELD

See Also:

Constant Field Values

FILE_NAME_FIELD

static final java.lang.String FILE_NAME_FIELD

See Also:

Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

SIZE_FIELD

static final java.lang.String SIZE_FIELD

See Also:

Constant Field Values

BINARY_FIELD

static final java.lang.String BINARY_FIELD

See Also:

Constant Field Values

MIMETYPE_FIELD

static final java.lang.String MIMETYPE_FIELD

See Also:

Constant Field Values

HOST_FOLDER_FIELD

static final java.lang.String HOST_FOLDER_FIELD

See Also:

Constant Field Values

SORT_ORDER

static final java.lang.String SORT_ORDER

See Also:

Constant Field Values

SHOW_ON_MENU

static final java.lang.String SHOW_ON_MENU

See Also:

Constant Field Values

META_DATA_FIELD

static final java.lang.String META_DATA_FIELD

See Also:

Constant Field Values

CONTENT_FIELD

static final java.lang.String CONTENT_FIELD

See Also:

Constant Field Values

TITLE_FIELD_NAME

static final java.lang.String TITLE_FIELD_NAME

See Also:

Constant Field Values

FILE_NAME_FIELD_NAME

static final java.lang.String FILE_NAME_FIELD_NAME

See Also:

Constant Field Values

DESCRIPTION_NAME

static final java.lang.String DESCRIPTION_NAME

See Also:

Constant Field Values

BINARY_FIELD_NAME

static final java.lang.String BINARY_FIELD_NAME

See Also:

Constant Field Values

HOST_FOLDER_FIELD_NAME

static final java.lang.String HOST_FOLDER_FIELD_NAME

See Also:

Constant Field Values

SORT_ORDER_NAME

static final java.lang.String SORT_ORDER_NAME

See Also:

Constant Field Values

SHOW_ON_MENU_NAME

static final java.lang.String SHOW_ON_MENU_NAME

See Also:

Constant Field Values

META_DATA_FIELD_NAME

static final java.lang.String META_DATA_FIELD_NAME

See Also:

Constant Field Values

META_DATA_TAB_NAME

static final java.lang.String META_DATA_TAB_NAME

See Also:

Constant Field Values

DEFAULT_FILE_ASSET_STRUCTURE_NAME

static final java.lang.String DEFAULT_FILE_ASSET_STRUCTURE_NAME

See Also:

Constant Field Values

DEFAULT_FILE_ASSET_STRUCTURE_DESCRIPTION

static final java.lang.String DEFAULT_FILE_ASSET_STRUCTURE_DESCRIPTION

See Also:

Constant Field Values

DEFAULT_FILE_ASSET_STRUCTURE_VELOCITY_VAR_NAME

static final java.lang.String DEFAULT_FILE_ASSET_STRUCTURE_VELOCITY_VAR_NAME

See Also:

Constant Field Values

Method Detail

createBaseFileAssetFields

void createBaseFileAssetFields(Structure structure)
                               throws DotDataException,
                                      DotStateException

Throws:

DotDataException

DotStateException

fromContentlet

FileAsset fromContentlet(Contentlet con)
                         throws DotStateException

Parameters:

con -

Returns:

Throws:

DotStateException

fromContentlets

java.util.List<FileAsset> fromContentlets(java.util.List<Contentlet> cons)
                                          throws DotStateException

Parameters:

cons -

Returns:

Throws:

DotStateException

fromContentletsI

java.util.List<IFileAsset> fromContentletsI(java.util.List<Contentlet> cons)
                                            throws DotStateException

Parameters:

cons -

Returns:

Throws:

DotStateException

isFileAsset

boolean isFileAsset(Contentlet c)

Parameters:

c -

Returns:

getMetaDataMap

java.util.Map<java.lang.String,java.lang.String> getMetaDataMap(Contentlet con,
                                                                java.io.File binFile)

Returns a map with the given binary file's meta data

Parameters:

binFile -

Returns:

fileNameExists

boolean fileNameExists(Host host,
                       Folder folder,
                       java.lang.String fileName,
                       java.lang.String identifier)
                       throws DotDataException

Parameters:

host -

folder -

fileName -

identifier -

Returns:

Throws:

DotDataException

getRelativeAssetPath

java.lang.String getRelativeAssetPath(FileAsset fa)

Parameters:

fa -

Returns:

findFileAssetsByFolder

java.util.List<FileAsset> findFileAssetsByFolder(Folder parentFolder,
                                                 com.liferay.portal.model.User user,
                                                 boolean respectFrontendRoles)
                                                 throws DotDataException,
                                                        DotSecurityException

Parameters:

parentFolder -

user -

respectFrontendRoles -

Returns:

Throws:

DotDataException

DotSecurityException

findFileAssetsByHost

java.util.List<FileAsset> findFileAssetsByHost(Host parentHost,
                                               com.liferay.portal.model.User user,
                                               boolean respectFrontendRoles)
                                               throws DotDataException,
                                                      DotSecurityException

Parameters:

parentHost -

user -

respectFrontendRoles -

Returns:

Throws:

DotDataException

DotSecurityException

findFileAssetsByFolder

java.util.List<FileAsset> findFileAssetsByFolder(Folder parentFolder,
                                                 java.lang.String sortBy,
                                                 boolean live,
                                                 com.liferay.portal.model.User user,
                                                 boolean respectFrontendRoles)
                                                 throws DotDataException,
                                                        DotSecurityException

Parameters:

parentFolder -

user -

respectFrontendRoles -

Returns:

Throws:

DotDataException

DotSecurityException

findFileAssetsByFolder

java.util.List<FileAsset> findFileAssetsByFolder(Folder parentFolder,
                                                 java.lang.String sortBy,
                                                 boolean live,
                                                 boolean working,
                                                 com.liferay.portal.model.User user,
                                                 boolean respectFrontendRoles)
                                                 throws DotDataException,
                                                        DotSecurityException

Parameters:

parentFolder -

user -

respectFrontendRoles -

Returns:

Throws:

DotDataException

DotSecurityException

renameFile

boolean renameFile(Contentlet fileAssetCont,
                   java.lang.String newName,
                   com.liferay.portal.model.User user,
                   boolean respectFrontendRoles)
                   throws DotStateException,
                          DotDataException,
                          DotSecurityException,
                          java.io.IOException

Parameters:

fileAssetCont -

newName -

user -

respectFrontendRoles -

Returns:

Throws:

DotStateException

DotDataException

DotSecurityException

java.io.IOException

moveFile

boolean moveFile(Contentlet fileAssetCont,
                 Folder parent,
                 com.liferay.portal.model.User user,
                 boolean respectFrontendRoles)
                 throws DotStateException,
                        DotDataException,
                        DotSecurityException

Moves a given contentlet to a given folder

Parameters:

fileAssetCont -

parent -

user -

respectFrontendRoles -

Returns:

Throws:

DotStateException

DotDataException

DotSecurityException

moveFile

boolean moveFile(Contentlet fileAssetCont,
                 Host host,
                 com.liferay.portal.model.User user,
                 boolean respectFrontendRoles)
                 throws DotStateException,
                        DotDataException,
                        DotSecurityException

Moves a given contentlet to a given host

Parameters:

fileAssetCont -

host -

user -

respectFrontendRoles -

Returns:

Throws:

DotStateException

DotDataException

DotSecurityException

getRealAssetPath

java.lang.String getRealAssetPath(java.lang.String inode,
                                  java.lang.String fileName,
                                  java.lang.String ext)

Parameters:

inode -

fileName -

ext -

Returns:

getRealAssetPath

java.lang.String getRealAssetPath(java.lang.String inode)

Parameters:

inode -

Returns:

getRealAssetPath

java.lang.String getRealAssetPath(java.lang.String inode,
                                  java.lang.String fileName)