org.gcube.portlets.user.homelibrary.home.data
Interface DataArea

public interface DataArea

Manage home application data.

Author:

Federico De Faveri defaveri@isti.cnr.it

Method Summary

ApplicationDataArea	getApplicationDataArea(Class<?> applicationClass) Return the application data area for the specified application.
ApplicationDataArea	getApplicationDataArea(String applicationName) Return the application data area for the specified application.
DataFolder	getDataFolderRoot() Return the user home root folder.
DataFolder	getRelativeFolder(String relPath) Return a folder relative to the root folder.
List<String>	listApplicationNames() Retrieve the list of all application data areas.

Method Detail

getDataFolderRoot

DataFolder getDataFolderRoot()
                             throws InternalErrorException

Return the user home root folder.

Returns:

the application data root.

Throws:

InternalErrorException - if an internal error occurs.

getRelativeFolder

DataFolder getRelativeFolder(String relPath)
                             throws InternalErrorException

Return a folder relative to the root folder.

Parameters:

relPath - the relative path of the folder.

Returns:

the folder with the specified relative path.

Throws:

InternalErrorException - if an internal error occurs.

getApplicationDataArea

ApplicationDataArea getApplicationDataArea(String applicationName)
                                           throws InternalErrorException

Return the application data area for the specified application.

Parameters:

applicationName - the application name.

Returns:

the application data area.

Throws:

InternalErrorException - if an error occurs.

getApplicationDataArea

ApplicationDataArea getApplicationDataArea(Class<?> applicationClass)
                                           throws InternalErrorException

Return the application data area for the specified application.

Parameters:

applicationClass - the application class.

Returns:

the application data area.

Throws:

InternalErrorException - if an error occurs.

listApplicationNames

List<String> listApplicationNames()
                                  throws InternalErrorException

Retrieve the list of all application data areas.

Returns:

the application name list.

Throws:

InternalErrorException - if an error occurs.