public interface IWorkspace
Modifier and Type | Method and Description |
---|---|
void |
addShare(IShareInfo shareInfo)
Adds a share to the workspace.
|
void |
addShare(String principalID,
int rights)
Adds a user and rights to the share in the workspace.
|
void |
addTag(String tag)
Adds a keyword tag to the workspace.
|
IWorkspace |
copy(String newName,
String targetFolderID)
Makes a copy of the workspace and places it in the target folder.
|
void |
delete()
Deletes the workspace.
|
List<String> |
getAliases()
Get a List of aliases applied to this workspace.
|
IWorkspaceContext |
getContext()
Gets the workspace context.
|
Date |
getCreationDate()
Gets the date the workspace was created.
|
String |
getDescription()
Gets the workspace description.
|
String |
getID()
Gets the Workspace ID.
|
Date |
getLastModifiedDate()
Gets the date the workspace was last modified.
|
String |
getName()
Gets the workspace display name.
|
String |
getOwnerUID()
Gets the workspace owner's UID.
|
String |
getPrimaryContextURI()
Gets the primary context URI of this workspace, usually the object this workspace is analyzing.
|
List<IShareInfo> |
getShares()
Gets a list of IShareInfo shares for this workspace
|
List<String> |
getTags()
Gets a list of keyword tags associated with the workspace.
|
String |
getURL()
Gets the workspace link URL.
|
int |
getWorkspaceType()
Gets the workspace type, see Workspace Types.
|
boolean |
isDeletable()
Determines if the workspace can be deleted by the current user
|
boolean |
isDirty()
Indicates that the workspace been modified since load.
|
boolean |
isEditable()
Determines if the workspace is editable by the current user
|
void |
refresh()
Refreshes the workspace, any unsaved changes are lost
|
void |
removeShare(String principalID)
Removes an existing share from the workspace for the specified user or role.;
|
void |
removeTag(String tag)
Removes a keyword tag from the workspace.
|
boolean |
rename(String newName)
Renames the workspace.
|
void |
save()
Saves any changes made to the workspace.
|
void |
setAliases(List<String> aliases)
Applies a list of aliases to the workspace.
|
void |
setDescription(String description)
Sets the workspace description.
|
void |
setName(String name)
Sets the workspace display name.
|
void |
setOwnerUID(String ownerUID)
Sets the workspace owner's UID.
|
void |
setPrimaryContextURI(String contextURI)
Sets the primary context URI of this workspace; the URI of the object that is being analyzed by this workspace.
|
void |
setShares(List<IShareInfo> shareList,
boolean clearExistingShares)
Updates the sharing for this workspace
|
void |
setTags(List<String> tags)
Sets the list of keyword tags associated with the workspace.
|
void |
setWorkspaceType(int type)
Set the workspace type, see Workspace Types.
|
String getID() throws Exception
Exception
int getWorkspaceType() throws Exception
Exception
void setWorkspaceType(int type) throws Exception
Exception
void setName(String name) throws Exception
name
- The new workspace name string.Exception
String getName() throws Exception
Exception
void setDescription(String description) throws Exception
description
- The new workspace description string.Exception
String getDescription() throws Exception
Exception
String getOwnerUID() throws Exception
Exception
void setOwnerUID(String ownerUID) throws Exception
ownerUID
- Specifies the new user UID string to set as the workspace owner.Exception
Date getCreationDate() throws Exception
Exception
Date getLastModifiedDate() throws Exception
Exception
List<String> getAliases() throws Exception
Exception
void setAliases(List<String> aliases) throws Exception
aliases
- Specifies the list of alias strings to apply to the workspace.Exception
void addTag(String tag) throws Exception
tag
- Specified a workspace tag string to add to the workspaceException
void removeTag(String tag) throws Exception
tag
- Specifies the workspace tag string to removeException
List<String> getTags() throws Exception
Exception
void setTags(List<String> tags) throws Exception
tags
- Specifies the list of tag strings to apply to the workspace.Exception
boolean isDirty()
IWorkspaceContext getContext() throws Exception
Exception
boolean rename(String newName) throws Exception
newName
- Specifies the new name to apply to the workspace.Exception
IWorkspace copy(String newName, String targetFolderID) throws Exception
newName
- Specifies the new workspace name string.targetFolderID
- Specifies the folder ID of the new workspace parent folder.Exception
void refresh() throws Exception
Exception
void addShare(String principalID, int rights) throws Exception
principalID
- Specifies the user or role ID to share this workspace with.rights
- Specifies the set of rights to apply to this user's share, see Rights Levels.Exception
void addShare(IShareInfo shareInfo) throws Exception
shareInfo
- The IShareInfo instance to apply as a new share for this workspace.Exception
void removeShare(String principalID) throws Exception
principalID
- The ID of the user or role to removeException
List<IShareInfo> getShares() throws Exception
Exception
void setShares(List<IShareInfo> shareList, boolean clearExistingShares) throws Exception
shareList
- Specifies the list of IShareInfo instances describing the shares to apply to this workspace.clearExistingShares
- Specify true to apply only this list of shares, false to overlay the existing shares.Exception
String getPrimaryContextURI() throws Exception
Exception
boolean isEditable() throws Exception
Exception
boolean isDeletable() throws Exception
Exception