|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkspaceAreaItem
Define a Workspace item like workspace, basket or basket-item.
Method Summary | |
---|---|
WorkspaceAreaItem |
cloneItem(java.lang.String cloneName)
Clone this item. |
Capabilities |
getCapabilities()
The item capabilities. |
java.util.List<? extends WorkspaceAreaItem> |
getChildren()
Return this item children. |
java.util.Calendar |
getCreationTime()
This item creation time. |
java.lang.String |
getDescription()
This item description. |
java.lang.String |
getId()
This item id. |
WorkspaceAreaItemAction |
getLastAction()
Return the last action on this Item. |
java.util.Calendar |
getLastModificationTime()
This item last modification time. |
java.lang.String |
getName()
This item name. |
User |
getOwner()
This item owner. |
WorkspaceFolder |
getParent()
Return this item parent. |
java.lang.String |
getPath()
Return the current item path. |
Properties |
getProperties()
The item properties. |
WorkspaceAreaItemType |
getType()
Return this item type. |
boolean |
isRoot()
Says if this item is a root element. |
void |
move(WorkspaceFolder destination)
Move this item to a new folder. |
void |
remove()
Remove this item from the workspace area. |
void |
removeChild(WorkspaceAreaItem child)
Remove a child from this item. |
void |
rename(java.lang.String name)
Change this item name. |
void |
setDescription(java.lang.String description)
Set a new item description. |
Method Detail |
---|
java.lang.String getId() throws InternalErrorException
InternalErrorException
- if an internal error occurs.java.lang.String getName() throws InternalErrorException
InternalErrorException
- if an internal error occurs.java.lang.String getDescription() throws InternalErrorException
InternalErrorException
- if an internal error occurs.void setDescription(java.lang.String description) throws InternalErrorException
description
- the new description.
InternalErrorException
- if an internal error occurs.void rename(java.lang.String name) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException
name
- the new name.
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.java.util.Calendar getCreationTime() throws InternalErrorException
InternalErrorException
- if an internal error occurs.java.util.Calendar getLastModificationTime() throws InternalErrorException
InternalErrorException
- if an internal error occurs.WorkspaceAreaItemAction getLastAction() throws InternalErrorException
InternalErrorException
- if an internal error occurs.User getOwner() throws InternalErrorException
InternalErrorException
- if an internal error occurs.Capabilities getCapabilities()
Properties getProperties() throws InternalErrorException
InternalErrorException
- if an internal error occurs.WorkspaceAreaItemType getType()
WorkspaceFolder getParent() throws InternalErrorException
InternalErrorException
- if an internal error occurs.java.lang.String getPath() throws InternalErrorException
InternalErrorException
- if an internal error occurs.boolean isRoot() throws InternalErrorException
true
if this element is a root, false
otherwise.
InternalErrorException
- if an internal error occurs.java.util.List<? extends WorkspaceAreaItem> getChildren() throws InternalErrorException
InternalErrorException
- if an internal error occurs.void removeChild(WorkspaceAreaItem child) throws InternalErrorException, InsufficientPrivilegesException
child
- the child to remove.
InternalErrorException
- if an internal error occurs.
InsufficientPrivilegesException
- if the user don't have sufficient privileges to perform this operation.void remove() throws InternalErrorException, InsufficientPrivilegesException
InternalErrorException
- if an internal error occurs.
InsufficientPrivilegesException
- if the user don't have sufficient privileges to perform this operation.void move(WorkspaceFolder destination) throws InternalErrorException, WrongDestinationException, InsufficientPrivilegesException, ItemAlreadyExistException
destination
- the destination folder.
InternalErrorException
- if an internal error occurs.
WrongDestinationException
- if the destination folder have a wrong type.
InsufficientPrivilegesException
- if the user don't have sufficient privileges to perform this operation.
ItemAlreadyExistException
- if an item with the new name already exist in the destination folder.WorkspaceAreaItem cloneItem(java.lang.String cloneName) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException
cloneName
- the new clone name.
InternalErrorException
- if an internal error occurs.
InsufficientPrivilegesException
- if the user don't have sufficient privileges to perform this operation.
ItemAlreadyExistException
- if an item with the new name already exist.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |