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 sizeOslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize, OslcQueryParameters oslcQueryParams)
Create an OSLC query that uses OSLC query parameters and the given page sizeOslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize, OslcQueryParameters oslcQueryParams, String version)
Create an OSLC query that uses OSLC query parameters and the given page sizeOslcQuery(OslcClient oslcClient, String capabilityUrl, OslcQueryParameters oslcQueryParams)
Create an OSLC query with query parameters that uses the default page size
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCapabilityUrl()
int
getPageSize()
String
getQueryUrl()
OslcQueryResult
submit()
-
-
-
Constructor Detail
-
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 clientcapabilityUrl
- 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 clientcapabilityUrl
- capabilityUrl the URL that is the baseoslcQueryParams
- an OslcQueryParameters object- 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 clientcapabilityUrl
- the URL that is the basepageSize
- 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 clientcapabilityUrl
- the URL that is the basepageSize
- the number of results to include on each page (OslcQueryResult)oslcQueryParams
- an OslcQueryParameters object (seeOslcQueryParameters
)
-
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 clientcapabilityUrl
- the URL that is the basepageSize
- the number of results to include on each page (OslcQueryResult)oslcQueryParams
- an OslcQueryParameters object (seeOslcQueryParameters
)version
- OSLC Version (seeOSLCConstants
)
-
-
Method Detail
-
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()
-
-