Package com.webmethods.bpm.noodle

Interface IWorkspace

public interface IWorkspace

  • Method Details

    • getID

      String getID() throws Exception
      Gets the Workspace ID. This is the unique identifier for the workspace.
      Returns:
      Throws:
      Exception

    • getURL

      String getURL() throws Exception
      Gets the workspace link URL.
      Returns:
      Throws:
      Exception

    • getWorkspaceType

      int getWorkspaceType() throws Exception
      Gets the workspace type, see Workspace Types.
      Returns:
      type The workspace type constant
      Throws:
      Exception

    • setWorkspaceType

      void setWorkspaceType(int type) throws Exception
      Set the workspace type, see Workspace Types.
      Throws:
      Exception

    • setName

      void setName(String name) throws Exception
      Sets the workspace display name.
      Parameters:
      name - The new workspace name string.
      Throws:
      Exception

    • getName

      String getName() throws Exception
      Gets the workspace display name.
      Returns:
      Returns the workspace display name string.
      Throws:
      Exception

    • setDescription

      void setDescription(String description) throws Exception
      Sets the workspace description.
      Parameters:
      description - The new workspace description string.
      Throws:
      Exception

    • getDescription

      String getDescription() throws Exception
      Gets the workspace description.
      Returns:
      Returns the workspace description string.
      Throws:
      Exception

    • getOwnerUID

      String getOwnerUID() throws Exception
      Gets the workspace owner's UID.
      Returns:
      Returns the workspace owner's UID as a string.
      Throws:
      Exception

    • setOwnerUID

      void setOwnerUID(String ownerUID) throws Exception
      Sets the workspace owner's UID.
      Parameters:
      ownerUID - Specifies the new user UID string to set as the workspace owner.
      Throws:
      Exception

    • getCreationDate

      Date getCreationDate() throws Exception
      Gets the date the workspace was created.
      Returns:
      Returns the date of workspace creation.
      Throws:
      Exception

    • getLastModifiedDate

      Date getLastModifiedDate() throws Exception
      Gets the date the workspace was last modified.
      Returns:
      Returns the date this workspace was last modified.
      Throws:
      Exception

    • getAliases

      List<String> getAliases() throws Exception
      Get a List of aliases applied to this workspace.
      Returns:
      Returns a list of workspace alias strings.
      Throws:
      Exception

    • setAliases

      void setAliases(List<String> aliases) throws Exception
      Applies a list of aliases to the workspace.
      Parameters:
      aliases - Specifies the list of alias strings to apply to the workspace.
      Throws:
      Exception

    • addTag

      void addTag(String tag) throws Exception
      Adds a keyword tag to the workspace.
      Parameters:
      tag - Specified a workspace tag string to add to the workspace
      Throws:
      Exception

    • removeTag

      void removeTag(String tag) throws Exception
      Removes a keyword tag from the workspace.
      Parameters:
      tag - Specifies the workspace tag string to remove
      Throws:
      Exception

    • getTags

      List<String> getTags() throws Exception
      Gets a list of keyword tags associated with the workspace.
      Returns:
      Reutnrs a ist of workspace tag strings.
      Throws:
      Exception

    • setTags

      void setTags(List<String> tags) throws Exception
      Sets the list of keyword tags associated with the workspace.
      Parameters:
      tags - Specifies the list of tag strings to apply to the workspace.
      Throws:
      Exception

    • isDirty

      boolean isDirty()
      Indicates that the workspace been modified since load.
      Returns:
      Returns true if the workspace has unsaved changes.

    • getContext

      IWorkspaceContext getContext() throws Exception
      Gets the workspace context.
      Returns:
      Returns the workspace context.
      Throws:
      Exception

    • rename

      boolean rename(String newName) throws Exception
      Renames the workspace.
      Parameters:
      newName - Specifies the new name to apply to the workspace.
      Returns:
      Returns true if the workspace has been successfully renamed.
      Throws:
      Exception

    • delete

      void delete() throws Exception
      Deletes the workspace.
      Throws:
      Exception

    • save

      void save() throws Exception
      Saves any changes made to the workspace.
      Throws:
      Exception

    • copy

      IWorkspace copy(String newName, String targetFolderID) throws Exception
      Makes a copy of the workspace and places it in the target folder. If the targetFolderID is null, a copy will is placed in the original folder.
      Parameters:
      newName - Specifies the new workspace name string.
      targetFolderID - Specifies the folder ID of the new workspace parent folder.
      Returns:
      Returns a copy of the workspace.
      Throws:
      Exception

    • refresh

      void refresh() throws Exception
      Refreshes the workspace, any unsaved changes are lost
      Throws:
      Exception

    • addShare

      void addShare(String principalID, int rights) throws Exception
      Adds a user and rights to the share in the workspace.
      Parameters:
      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.
      Throws:
      Exception

    • addShare

      void addShare(IShareInfo shareInfo) throws Exception
      Adds a share to the workspace.
      Parameters:
      shareInfo - The IShareInfo instance to apply as a new share for this workspace.
      Throws:
      Exception

    • removeShare

      void removeShare(String principalID) throws Exception
      Removes an existing share from the workspace for the specified user or role.;
      Parameters:
      principalID - The ID of the user or role to remove
      Throws:
      Exception

    • getShares

      List<IShareInfo> getShares() throws Exception
      Gets a list of IShareInfo shares for this workspace
      Returns:
      Returns a list of IShareInfo instances representing the shares currently applied to this workspace
      Throws:
      Exception

    • setShares

      void setShares(List<IShareInfo> shareList, boolean clearExistingShares) throws Exception
      Updates the sharing for this workspace
      Parameters:
      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.
      Throws:
      Exception

    • getPrimaryContextURI

      String getPrimaryContextURI() throws Exception
      Gets the primary context URI of this workspace, usually the object this workspace is analyzing.
      Returns:
      Returns the ContextURI string.
      Throws:
      Exception

    • isEditable

      boolean isEditable() throws Exception
      Determines if the workspace is editable by the current user
      Returns:
      Returns true if the workspace is editable by the current user.
      Throws:
      Exception

    • isDeletable

      boolean isDeletable() throws Exception
      Determines if the workspace can be deleted by the current user
      Returns:
      Returns true if the workspace can be deleted by the current user.
      Throws:
      Exception

    • setPrimaryContextURI

      void setPrimaryContextURI(String contextURI) throws Exception
      Sets the primary context URI of this workspace; the URI of the object that is being analyzed by this workspace.
      Parameters:
      contextURI - The URI string of the analyzed object
      Throws:
      Exception