org.gcube.common.homelibrary.home.workspace.catalogue

Interface WorkspaceCatalogue

All Superinterfaces:

WorkspaceFolder, WorkspaceItem

public interface WorkspaceCatalogue
extends WorkspaceFolder

Author:

valentina

Method Summary

Methods

Modifier and Type	Method and Description
WorkspaceItem	addWorkspaceItem(String workspaceItemID) Copy item into Catalogue root
WorkspaceItem	addWorkspaceItem(String workspaceItemID, String destinationFolderID) Copy item into Catalogue Folder
WorkspaceItem	getCatalogueItem(String id) Retrieve a catalogue item by id
WorkspaceItem	getCatalogueItemByPath(String path) Retrieve a catalogue item by relative path
List<WorkspaceItem>	getCatalogueItemByWorkspaceID(String workspaceItemID) Get all catalogue Items by a workspace item ID
WorkspaceItem	getWorkspaceItemByCatalogueID(String catalogueItemID) Get a WorkspaceItem by a catalogue item ID

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.WorkspaceFolder

createExternalFileItem, createExternalFileItem, createExternalFileItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalImageItem, createExternalImageItem, createExternalPDFFileItem, createExternalPDFFileItem, createExternalUrlItem, createExternalUrlItem, createExternalUrlItem, createFolder, createQueryItem, createQueryItem, createReportItem, createReportTemplateItem, createTimeSeries, exists, find, getAllChildren, getAllChildren, getChildren, getChildren, getChildren, getChildrenCount, getCount, getHiddenChildren, getLastItems, getNewFolderBulkCreator, getSize, getUniqueName, isPublic, isSystemFolder, setACL, setPublic, setSystemFolder, share

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.WorkspaceItem

cloneItem, deleteACL, getAccounting, getACLOwner, getACLUser, getCreationTime, getDescription, getId, getIdSharedFolder, getLastAction, getLastModificationTime, getLastUpdatedBy, getName, getOwner, getParent, getPath, getProperties, getPublicLink, getReaders, getRemotePath, getSecurePublicLink, getStorageID, getType, hasAccessRight, isFolder, isHidden, isMarkedAsRead, isRoot, isShared, isTrashed, markAsRead, move, remove, removeChild, rename, setDescription, setHidden, updateItem

Method Detail

getCatalogueItem

WorkspaceItem getCatalogueItem(String id)
                               throws InternalErrorException,
                                      InsufficientPrivilegesException

Retrieve a catalogue item by id

Parameters:

id - the ID of a catalogue item

Returns:

a catalogue item

Throws:

InternalErrorException

InsufficientPrivilegesException

getCatalogueItemByPath

WorkspaceItem getCatalogueItemByPath(String path)
                                     throws InternalErrorException,
                                            InsufficientPrivilegesException

Retrieve a catalogue item by relative path

Parameters:

path - the relative path of a catalogue item

Returns:

a catalogue item

Throws:

InternalErrorException

InsufficientPrivilegesException

addWorkspaceItem

WorkspaceItem addWorkspaceItem(String workspaceItemID,
                             String destinationFolderID)
                               throws InternalErrorException

Copy item into Catalogue Folder

Parameters:

workspaceItemID - the ID of the workspaceItem to copy

destinationFolderID - the ID of an existing catalogue folder

Returns:

the copied item

Throws:

InternalErrorException

addWorkspaceItem

WorkspaceItem addWorkspaceItem(String workspaceItemID)
                               throws InternalErrorException

Copy item into Catalogue root

Parameters:

workspaceItemID - the ID of the workspaceItem to copy

Returns:

the copied item

Throws:

InternalErrorException

getWorkspaceItemByCatalogueID

WorkspaceItem getWorkspaceItemByCatalogueID(String catalogueItemID)
                                            throws InternalErrorException

Get a WorkspaceItem by a catalogue item ID

Parameters:

catalogueItemID - ID of an element of the catalogue

Returns:

a WorkspaceItem

Throws:

InternalErrorException

getCatalogueItemByWorkspaceID

List<WorkspaceItem> getCatalogueItemByWorkspaceID(String workspaceItemID)
                                                  throws InternalErrorException

Get all catalogue Items by a workspace item ID

Parameters:

workspaceItemID - ID of an workspace item

Returns:

a WorkspaceItem

Throws:

InternalErrorException