workspace-explorer/src/main/java/org/gcube/portlets/widgets/wsexplorer/client/rpc/WorkspaceExplorerService.java

package org.gcube.portlets.widgets.wsexplorer.client.rpc;

import java.util.List;

import org.gcube.portlets.widgets.wsexplorer.shared.FilterCriteria;
import org.gcube.portlets.widgets.wsexplorer.shared.Item;
import org.gcube.portlets.widgets.wsexplorer.shared.ItemCategory;
import org.gcube.portlets.widgets.wsexplorer.shared.ItemType;
import org.gcube.portlets.widgets.wsexplorer.shared.WorkspaceNavigatorServiceException;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;

/**
 * The client side stub for the RPC service.
 *
 * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it
 * Jul 10, 2015
 */
@RemoteServiceRelativePath("WorkspaceExplorerService")
public interface WorkspaceExplorerService extends RemoteService {

	/**
	 * Gets the breadcrumbs by item identifier.
	 *
	 * @param itemIdentifier the item identifier
	 * @param includeItemAsParent the include item as parent
	 * @return the breadcrumbs by item identifier
	 * @throws Exception the exception
	 */
	List<Item> getBreadcrumbsByItemIdentifier(String itemIdentifier,
			boolean includeItemAsParent) throws Exception;

	/**
	 * Check name.
	 *
	 * @param name the name
	 * @return true, if successful
	 * @throws WorkspaceNavigatorServiceException the workspace navigator service exception
	 */
	boolean checkName(String name) throws WorkspaceNavigatorServiceException;

	/**
	 * Gets the folder.
	 *
	 * @param folderId the folder id
	 * @param showableTypes the showable types
	 * @param purgeEmpyFolders the purge empy folders
	 * @param filterCriteria the filter criteria
	 * @return the folder
	 * @throws WorkspaceNavigatorServiceException the workspace navigator service exception
	 */
	Item getFolder(String folderId, List<ItemType> showableTypes,
			boolean purgeEmpyFolders, FilterCriteria filterCriteria)
			throws WorkspaceNavigatorServiceException;

	/**
	 * Gets the root.
	 *
	 * @param showableTypes the showable types
	 * @param purgeEmpyFolders the purge empy folders
	 * @param filterCriteria the filter criteria
	 * @return the root
	 * @throws WorkspaceNavigatorServiceException the workspace navigator service exception
	 */
	Item getRoot(List<ItemType> showableTypes, boolean purgeEmpyFolders,
			FilterCriteria filterCriteria)
			throws WorkspaceNavigatorServiceException;

	/**
	 * Gets the my special folder.
	 *
	 * @param showableTypes the showable types
	 * @param purgeEmpyFolders the purge empy folders
	 * @param filterCriteria the filter criteria
	 * @return the my special folder
	 * @throws WorkspaceNavigatorServiceException the workspace navigator service exception
	 */
	Item getMySpecialFolder(List<ItemType> showableTypes,
			boolean purgeEmpyFolders, FilterCriteria filterCriteria)
			throws WorkspaceNavigatorServiceException;

	/**
	 * Gets the item by category.
	 *
	 * @param category the category
	 * @return the item by category
	 * @throws WorkspaceNavigatorServiceException the workspace navigator service exception
	 */
	Item getItemByCategory(ItemCategory category)throws WorkspaceNavigatorServiceException;

	/**
	 * Gets the size by item id.
	 *
	 * @param itemId the item id
	 * @return the size by item id
	 * @throws Exception the exception
	 */
	Long getSizeByItemId(String itemId) throws Exception;

	/**
	 * Gets the mime type.
	 *
	 * @param itemId the item id
	 * @return the mime type
	 * @throws Exception the exception
	 */
	String getMimeType(String itemId) throws Exception;

	/**
	 * Gets the user acl for folder id.
	 *
	 * @param folderId the folder id
	 * @return the user acl for folder id
	 * @throws Exception the exception
	 */
	String getUserACLForFolderId(String folderId) throws Exception;


	/**
	 * Gets the readable size by item id.
	 *
	 * @param id the id
	 * @return the readable size by item id
	 * @throws Exception the exception
	 */
	String getReadableSizeByItemId(String id) throws Exception;

	/**
	 * @param itemIdentifier
	 * @param parentLimit
	 * @param includeItemAsParent
	 * @return
	 * @throws Exception
	 */
	List<Item> getBreadcrumbsByItemIdentifierToParentLimit(
			String itemIdentifier, String parentLimit,
			boolean includeItemAsParent) throws Exception;

	/**
	 * @param nameFolder
	 * @param description
	 * @param parentId
	 * @param showableTypes
	 * @param filterCriteria
	 * @return
	 * @throws Exception
	 */
	Item createFolder(
		String nameFolder, String description, String parentId)
		throws Exception;
}