Skip to content

Commit 22f1d16

Browse files
committed
Fixup comment references
1 parent 961d667 commit 22f1d16

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

src/org/labkey/remoteapi/query/BaseRowsCommand.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@
3232
* <p>
3333
* All three of these subclasses post similar JSON to the server, so this class
3434
* does all the common work. The client must supply three things: the schemaName,
35-
* the queryName and an array of 'rows' (i.e. Maps). The rows are added via
35+
* the queryName and an array of 'rows' (i.e., Maps). The rows are added via
3636
* the {@link #addRow(Map)} or {@link #setRows(List)} methods.
3737
* <p>
3838
* All data exposed from the LabKey Server is organized into a set of queries
3939
* contained in a set of schemas. A schema is simply a group of queries, identified
40-
* by a name (e.g., 'lists' or 'study'). A query is particular table or view within
40+
* by a name (e.g., 'lists' or 'study'). A query is a particular table or view within
4141
* that schema (e.g., 'People' or 'Peptides'). Currently, clients may update rows in
42-
* base tables only, and not in joined views. Therefore the query name must be the
42+
* base tables only and not in joined views. Therefore, the query name must be the
4343
* name of a table in the schema.
4444
* <p>
4545
* To view the schemas and queries exposed in a given folder, add a Query web part
@@ -49,8 +49,8 @@
4949
* <p>
5050
* Examples:
5151
* <pre><code>
52-
* // May need to add CONTEXT_PATH for dev instances
53-
* Connection cn = new Connection("http://localhost:8080", user, password);
52+
* ApiKeyCredentialsProvider credentials = new ApiKeyCredentialsProvider("xxx");
53+
* Connection cn = new Connection("http://localhost:8080", credentials);
5454
*
5555
* //Insert Rows Command
5656
* InsertRowsCommand cmd = new InsertRowsCommand("lists", "People");
@@ -60,7 +60,7 @@
6060
* row.put("LastName", "Test");
6161
*
6262
* cmd.addRow(row); //can add multiple rows to insert many at once
63-
* SaveRowsResponse resp = cmd.execute(cn, "PROJECT_NAME");
63+
* RowsResponse resp = cmd.execute(cn, "PROJECT_NAME");
6464
*
6565
* //get the newly-assigned primary key value from the first return row
6666
* int newKey = resp.getRows().get(0).get("Key");
@@ -98,7 +98,7 @@ public enum AuditBehavior
9898
private String _auditUserComment;
9999

100100
/**
101-
* Constructs a new SaveRowsCommand for a given schema, query and action name.
101+
* Constructs a new BaseRowsCommand for a given schema, query and action name.
102102
* @param schemaName The schema name.
103103
* @param queryName The query name.
104104
* @param actionName The action name to call (supplied by the derived class).

src/org/labkey/remoteapi/query/BaseRowsResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
abstract class BaseRowsResponse extends CommandResponse
3636
{
3737
/**
38-
* Constructs a new RowsResponse given the specified text and status code.
38+
* Constructs a new BaseRowsResponse given the specified text and status code.
3939
* @param text The response text.
4040
* @param statusCode The HTTP status code.
4141
* @param contentType the Content-Type header value.

src/org/labkey/remoteapi/query/RowsResponse.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
import org.labkey.remoteapi.HasRequiredVersion;
2020

2121
/**
22-
* Response object used for commands that derive from SaveRowsCommand.
22+
* Response object used for command responses that derive from {@link BaseRowsResponse}.
2323
* This response object provides helper methods for accessing the important
2424
* bits of the parsed response data.
2525
*/
2626
public class RowsResponse extends BaseRowsResponse
2727
{
2828
/**
29-
* Constructs a new SaveRowsResponse given the response text and status code
29+
* Constructs a new RowsResponse given the response text and status code
3030
* @param text The response text.
3131
* @param statusCode The HTTP status code.
3232
* @param contentType The Content-Type header value.

src/org/labkey/remoteapi/query/SaveRowsCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
* "start", 5000,
4545
* "end", 5500
4646
* )));
47-
* updateCmd.setAuditBehavior(SaveRowsCommand.AuditBehavior.DETAILED);
47+
* updateCmd.setAuditBehavior(BaseRowsCommand.AuditBehavior.DETAILED);
4848
* updateCmd.setAuditUserComment("Updated promoter region coordinates based on new assembly");
4949
* saveCmd.addCommands(updateCmd);
5050
*

0 commit comments

Comments
 (0)