public class AssayListCommand extends Command<AssayListResponse>
By default, this command returns information about all assays, but you may use the various setters to filter this list to assays of a given name, type or id.
Command.CommonParameters, Command.Response
CONTENT_TYPE_JSON
Constructor and Description |
---|
AssayListCommand()
Constructs a new AssayListCommand object.
|
AssayListCommand(AssayListCommand source)
Constructs a new AssayListCommand which is a copy of the source command
|
Modifier and Type | Method and Description |
---|---|
AssayListCommand |
copy()
Returns a copy of this object.
|
protected AssayListResponse |
createResponse(java.lang.String text,
int status,
java.lang.String contentType,
org.json.simple.JSONObject json)
Creates an instance of the response class, initialized with
the response text, the HTTP status code, and parsed JSONObject.
|
java.lang.Integer |
getId()
Returns the current assay id filter (if any).
|
java.lang.String |
getName()
Returns the assay name filter upon (if any)
|
java.util.Map<java.lang.String,java.lang.Object> |
getParameters()
Returns the current parameter map, or null if a map has not yet been set.
|
java.lang.String |
getType()
Returns the current assay type filter (if any).
|
void |
setId(java.lang.Integer id)
Sets the current assay id filter.
|
void |
setName(java.lang.String name)
Sets the assay name to filter upon.
|
void |
setType(java.lang.String type)
Sets the assay type filter.
|
_execute, checkThrowError, createRequest, execute, getActionName, getActionUrl, getControllerName, getHttpRequest, getParamValueAsString, getQueryString, getRequiredVersion, getTimeout, setParameters, setRequiredVersion, setTimeout
public AssayListCommand()
public AssayListCommand(AssayListCommand source)
source
- The source AssayListCommandpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- The assay name.public java.lang.String getType()
public void setType(java.lang.String type)
type
- The type to filter upon.public java.lang.Integer getId()
public void setId(java.lang.Integer id)
id
- The assay id.protected AssayListResponse createResponse(java.lang.String text, int status, java.lang.String contentType, org.json.simple.JSONObject json)
Command
Override this method to create an instance of a different class that extends CommandResponse
createResponse
in class Command<AssayListResponse>
text
- The response text from the server.status
- The HTTP status code.contentType
- The Content-Type header value.json
- The parsed JSONObject (or null if no JSON was returned).public java.util.Map<java.lang.String,java.lang.Object> getParameters()
Command
getParameters
in class Command<AssayListResponse>
public AssayListCommand copy()
Command
copy
in class Command<AssayListResponse>