org.gcube.common.storagehubwrapper.shared.tohl

Interface WorkspaceItem

All Known Subinterfaces:

FileItem, GCubeItem, ImageFileItem, PDFFileItem, URLFileItem, WorkspaceFolder, WorkspaceSharedFolder, WorkspaceTrashFolder, WorkspaceTrashItem, WorkspaceVREFolder

All Known Implementing Classes:

FileItem, ImageFile, PDFFile, URLFile, WorkspaceFolder, WorkspaceItem, WorkspaceSharedFolder, WorkspaceVREFolder

public interface WorkspaceItem

The Interface WorkspaceItem. Define a Workspace item like folder or folder-item.

Author:

Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it) Jun 15, 2018

Method Summary

Modifier and Type	Method and Description
List<AccountingEntry>	getAccounting() Gets the accounting.
Calendar	getCreationTime() This item creation time.
String	getDescription() This item description.
String	getId() This item id.
Calendar	getLastModificationTime() This item last modification time.
String	getLastModifiedBy() Gets the last modified by.
String	getName() This item name.
String	getOwner() This item owner.
String	getParentId() Gets the parent id.
String	getPath() Gets the path.
PropertyMap	getPropertyMap() Gets the map property.
WorkspaceItemType	getType() Return this item type.
boolean	isFolder() Check if the item is a folder.
boolean	isHidden() Return a flag indicating whether the element is hidden.
boolean	isRoot() Says if this item is a root element.
boolean	isShared() Return a flag indicating whether the element is shared.
boolean	isTrashed() Check if the item is in the trash.

Method Detail

getId

String getId()
      throws InternalErrorException

This item id.

Returns:

the id.

Throws:

InternalErrorException - if an internal error occurs.

getName

String getName()
        throws InternalErrorException

This item name.

Returns:

the name.

Throws:

InternalErrorException - if an internal error occurs.

getDescription

String getDescription()
               throws InternalErrorException

This item description.

Returns:

the description.

Throws:

InternalErrorException - if an internal error occurs.

getCreationTime

Calendar getCreationTime()
                  throws InternalErrorException

This item creation time.

Returns:

the creation time.

Throws:

InternalErrorException - if an internal error occurs.

getLastModificationTime

Calendar getLastModificationTime()
                          throws InternalErrorException

This item last modification time.

Returns:

the last modification time.

Throws:

InternalErrorException - if an internal error occurs.

getLastModifiedBy

String getLastModifiedBy()
                  throws InternalErrorException

Gets the last modified by.

Returns:

the last modified by

Throws:

InternalErrorException - the internal error exception

getOwner

String getOwner()
         throws InternalErrorException

This item owner.

Returns:

the owner.

Throws:

InternalErrorException - if an internal error occurs.

getPropertyMap

PropertyMap getPropertyMap()

Gets the map property.

Returns:

the map property

getAccounting

List<AccountingEntry> getAccounting()

Gets the accounting.

Returns:

the accounting

getPath

String getPath()

Gets the path.

Returns:

the path

getParentId

String getParentId()

Gets the parent id.

Returns:

the parent id

getType

WorkspaceItemType getType()

Return this item type.

Returns:

the type.

isRoot

boolean isRoot()
        throws InternalErrorException

Says if this item is a root element.

Returns:

true if this element is a root, false otherwise.

Throws:

InternalErrorException - if an internal error occurs.

isHidden

boolean isHidden()
          throws InternalErrorException

Return a flag indicating whether the element is hidden.

Returns:

true if the element is hidden, false if the element is visible.

Throws:

InternalErrorException - the internal error exception

isShared

boolean isShared()
          throws InternalErrorException

Return a flag indicating whether the element is shared.

Returns:

true if the element is shared, false otherwise.

Throws:

InternalErrorException - the internal error exception

isTrashed

boolean isTrashed()
           throws InternalErrorException

Check if the item is in the trash.

Returns:

true if the item has been trashed

Throws:

InternalErrorException - the internal error exception

isFolder

boolean isFolder()
          throws InternalErrorException

Check if the item is a folder.

Returns:

true if the item is a folder

Throws:

InternalErrorException - the internal error exception