Package org.eclipse.lyo.client.query

Class OslcQuery

java.lang.Object

org.eclipse.lyo.client.query.OslcQuery

public class OslcQuery
extends Object

Represents an OSLC query (HTTP GET) request to be made of a remote system. Immutable.

Constructor Summary

Constructors

Constructor	Description
OslcQuery(OslcClient oslcClient, String capabilityUrl)	Create an OSLC query that uses the remote system's default page size.
OslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize)	Create an OSLC query that uses the given page size
OslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize, OslcQueryParameters oslcQueryParams)	Create an OSLC query that uses OSLC query parameters and the given page size
OslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize, OslcQueryParameters oslcQueryParams, String version)	Create an OSLC query that uses OSLC query parameters and the given page size
OslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize, OslcQueryParameters oslcQueryParams, String version, Map<String,String> additionalHeaders)	Create an OSLC query that uses OSLC query parameters and the given page size
OslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize, OslcQueryParameters oslcQueryParams, Map<String,String> additionalHeaders)	Create an OSLC query that uses OSLC query parameters and the given page size
OslcQuery(OslcClient oslcClient, String capabilityUrl, OslcQueryParameters oslcQueryParams)	Create an OSLC query with query parameters that uses the default page size
OslcQuery(OslcClient oslcClient, String capabilityUrl, OslcQueryParameters oslcQueryParams, Map<String,String> additionalHeaders)	Create an OSLC query with query parameters that uses the default page size

Method Summary

Modifier and Type	Method	Description
String	getCapabilityUrl()
int	getPageSize()
String	getQueryUrl()
OslcQueryResult	submit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl)

Create an OSLC query that uses the remote system's default page size.

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - the URL that is the base

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl,
 OslcQueryParameters oslcQueryParams)

Create an OSLC query with query parameters that uses the default page size

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - capabilityUrl the URL that is the base

oslcQueryParams - an OslcQueryParameters object

See Also:

• OslcQueryParameters

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl,
 OslcQueryParameters oslcQueryParams,
 Map<String,String> additionalHeaders)

Create an OSLC query with query parameters that uses the default page size

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - capabilityUrl the URL that is the base

oslcQueryParams - an OslcQueryParameters object

additionalHeaders - additional request headers sent with the query

See Also:

• OslcQueryParameters

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl,
 int pageSize)

Create an OSLC query that uses the given page size

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - the URL that is the base

pageSize - the number of results to include on each page (OslcQueryResult)

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl,
 int pageSize,
 OslcQueryParameters oslcQueryParams)

Create an OSLC query that uses OSLC query parameters and the given page size

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - the URL that is the base

pageSize - the number of results to include on each page (OslcQueryResult)

oslcQueryParams - an OslcQueryParameters object (see OslcQueryParameters)

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl,
 int pageSize,
 OslcQueryParameters oslcQueryParams,
 Map<String,String> additionalHeaders)

Create an OSLC query that uses OSLC query parameters and the given page size

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - the URL that is the base

pageSize - the number of results to include on each page (OslcQueryResult)

oslcQueryParams - an OslcQueryParameters object (see OslcQueryParameters)

additionalHeaders - additional request headers sent with the query

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl,
 int pageSize,
 OslcQueryParameters oslcQueryParams,
 String version)

Create an OSLC query that uses OSLC query parameters and the given page size

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - the URL that is the base

pageSize - the number of results to include on each page (OslcQueryResult)

oslcQueryParams - an OslcQueryParameters object (see OslcQueryParameters)

version - OSLC Version (see OSLCConstants)

OslcQuery

public OslcQuery(OslcClient oslcClient,
 String capabilityUrl,
 int pageSize,
 OslcQueryParameters oslcQueryParams,
 String version,
 Map<String,String> additionalHeaders)

Create an OSLC query that uses OSLC query parameters and the given page size

Parameters:

oslcClient - the authenticated OSLC client

capabilityUrl - the URL that is the base

pageSize - the number of results to include on each page (OslcQueryResult)

oslcQueryParams - an OslcQueryParameters object (see OslcQueryParameters)

version - OSLC Version (see OSLCConstants)

additionalHeaders - additional request headers sent with the query

Method Details

getPageSize

public int getPageSize()

Returns:

the number of entries to return for each page, if zero, the remote system's (or full query's) default is used

getCapabilityUrl

public String getCapabilityUrl()

Returns:

the base query capability URL

getQueryUrl

public String getQueryUrl()

Returns:

the complete query URL

submit

public OslcQueryResult submit()