org.gcube.portlets.user.homelibrary.home.workspace
Interface WorkspaceSmartFolder

public interface WorkspaceSmartFolder

Author:

Antonio Gioia antonio.gioia@isti.cnr.it

Method Summary

Capabilities	getCapabilities() The item capabilities.
List<? extends WorkspaceItem>	getChildren() Return this item children.
Calendar	getCreationTime() This item creation time.
String	getDescription() This item description.
String	getId() This item id.
WorkspaceItemAction	getLastAction() Return the last action on this Item.
Calendar	getLastModificationTime() This item last modification time.
String	getName() This item name.
User	getOwner() This item owner.
Properties	getProperties() The item properties.
List<? extends SearchItem>	getSearchItems()
WorkspaceItemType	getType() Return this item type.
void	remove() Remove this item from the workspace.
void	rename(String name) Change this item name.
void	setDescription(String description) Set a new item description.

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.

setDescription

void setDescription(String description)
                    throws InternalErrorException

Set a new item description.

Parameters:

description - the new description.

Throws:

InternalErrorException - if an internal error occurs.

rename

void rename(String name)
            throws InternalErrorException,
                   InsufficientPrivilegesException,
                   ItemAlreadyExistException

Change this item name.

Parameters:

name - the new name.

Throws:

InternalErrorException - if an internal error occurs.

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

ItemAlreadyExistException - if an item with this name already exists in the containing folder.

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.

getLastAction

WorkspaceItemAction getLastAction()
                                  throws InternalErrorException

Return the last action on this Item.

Returns:

the last action.

Throws:

InternalErrorException - if an internal error occurs.

getOwner

User getOwner()
              throws InternalErrorException

This item owner.

Returns:

the owner.

Throws:

InternalErrorException - if an internal error occurs.

getCapabilities

Capabilities getCapabilities()

The item capabilities.

Returns:

the capabilities.

getProperties

Properties getProperties()
                         throws InternalErrorException

The item properties.

Returns:

the properties.

Throws:

InternalErrorException - if an internal error occurs.

getType

WorkspaceItemType getType()

Return this item type.

Returns:

the type.

getChildren

List<? extends WorkspaceItem> getChildren()
                                          throws InternalErrorException

Return this item children.

Returns:

the children.

Throws:

InternalErrorException - if an internal error occurs.

getSearchItems

List<? extends SearchItem> getSearchItems()
                                          throws InternalErrorException

Throws:

InternalErrorException

remove

void remove()
            throws InternalErrorException,
                   InsufficientPrivilegesException

Remove this item from the workspace.

Throws:

InternalErrorException - if an internal error occurs.

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.