## Uses of Class
org.modeshape.web.jcr.rest.client.domain.Workspace

- Packages that use Workspace
  Package | Description
  --- | ---
  org.modeshape.web.jcr.rest.client | The ModeShape REST Client is a lightweight, non-UI Maven project that interacts with the ModeShape REST server.
  org.modeshape.web.jcr.rest.client.json | The ModeShape REST Client JSON package defines an implementation of an `ModeShape REST client`.

- - ### Uses of Workspace in org.modeshape.web.jcr.rest.client

    Methods in org.modeshape.web.jcr.rest.client that return types with arguments of type Workspace
    Modifier and Type | Method and Description
    --- | ---
    `Collection<Workspace>` | IRestClient.`getWorkspaces(Repository repository)` Obtains the workspaces defined within the specified ModeShape respository.

    Methods in org.modeshape.web.jcr.rest.client with parameters of type Workspace
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | IRestClient.`fileExists(File file, Workspace workspace, String path)` Checks if the given file exists or not on the server, by issuing a GET request.
    `URL` | IRestClient.`getUrl(File file, String path, Workspace workspace)` Returns a url string, representing a "server recognizable" url for a the given file.
    `Status` | IRestClient.`markAsPublishArea(Workspace workspace, String path, String title, String description)` Marks the last folder of the given path as a publish area, by adding the `mode:publishArea` mixin.
    `String` | IRestClient.`planForQuery(Workspace workspace, String language, String statement, int offset, int limit, Map<String,String> variables)` Compute the plan for the supplied query in the workspace.
    `Status` | IRestClient.`publish(Workspace workspace, String path, File file)` Publishes, or uploads, a local file to the workspace at the specified path.
    `Status` | IRestClient.`publish(Workspace workspace, String path, File file, boolean useVersioning)` Publishes, or uploads, a local file to the workspace at the specified path.
    `List<QueryRow>` | IRestClient.`query(Workspace workspace, String language, String statement)` Executes the given query in the workspace.
    `List<QueryRow>` | IRestClient.`query(Workspace workspace, String language, String statement, int offset, int limit)` Executes the given query in the workspace.
    `List<QueryRow>` | IRestClient.`query(Workspace workspace, String language, String statement, int offset, int limit, Map<String,String> variables)` Executes the given query in the workspace.
    `Status` | IRestClient.`unmarkAsPublishArea(Workspace workspace, String path)` Unmarks the last folder of the given path as a publish area, by removing the `mode:publishArea` mixin.
    `Status` | IRestClient.`unpublish(Workspace workspace, String path, File file)` Unpublishes, or deletes, the resource at the specified path in the workspace.

  - ### Uses of Workspace in org.modeshape.web.jcr.rest.client.json

    Methods in org.modeshape.web.jcr.rest.client.json that return types with arguments of type Workspace
    Modifier and Type | Method and Description
    --- | ---
    `Collection<Workspace>` | JsonRestClient.`getWorkspaces(Repository repository)`
    `Collection<Workspace>` | RepositoryNode.`getWorkspaces(String jsonResponse)`

    Methods in org.modeshape.web.jcr.rest.client.json with parameters of type Workspace
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | JsonRestClient.`fileExists(File file, Workspace workspace, String path)`
    `URL` | JsonRestClient.`getUrl(File file, String path, Workspace workspace)`
    `Status` | JsonRestClient.`markAsPublishArea(Workspace workspace, String path, String title, String description)`
    `boolean` | JsonRestClient.`pathExists(Workspace workspace, String path, File file)`
    `String` | JsonRestClient.`planForQuery(Workspace workspace, String language, String statement, int offset, int limit, Map<String,String> variables)`
    `Status` | JsonRestClient.`publish(Workspace workspace, String path, File file)`
    `Status` | JsonRestClient.`publish(Workspace workspace, String path, File file, boolean useVersioning)`
    `List<QueryRow>` | JsonRestClient.`query(Workspace workspace, String language, String statement)`
    `List<QueryRow>` | JsonRestClient.`query(Workspace workspace, String language, String statement, int offset, int limit)`
    `List<QueryRow>` | JsonRestClient.`query(Workspace workspace, String language, String statement, int offset, int limit, Map<String,String> variables)`
    `Status` | JsonRestClient.`unmarkAsPublishArea(Workspace workspace, String path)`
    `Status` | JsonRestClient.`unpublish(Workspace workspace, String path, File file)`

    Constructors in org.modeshape.web.jcr.rest.client.json with parameters of type Workspace
    Constructor and Description
    `FileNode(Workspace workspace, String path, File file)`
    `FileNode(Workspace workspace, String path, File file, boolean versionable)`
    `FolderNode(Workspace workspace, String fullPath)`
    `NodeTypeNode(Workspace workspace)` Use this constructor if wanting all node types for a workspace
    `NodeTypeNode(Workspace workspace, String nodeTypeName)` Use this constructor if wanting all node types for a workspace
    `WorkspaceNode(Workspace workspace)`

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.