public class FindObjects extends FedoraRequest<FindObjects>
Constructor and Description |
---|
FindObjects() |
Modifier and Type | Method and Description |
---|---|
FindObjects |
cDate() |
FindObjects |
contributor() |
FindObjects |
coverage() |
FindObjects |
creator() |
FindObjects |
date() |
FindObjects |
dcmDate() |
FindObjects |
description() |
FindObjectsResponse |
execute()
Executes this request against the
FedoraRequest.DEFAULT_CLIENT |
FindObjectsResponse |
execute(FedoraClient fedora)
Execute this request using the supplied FedoraClient instance.
|
FindObjects |
format() |
FindObjects |
identifier() |
FindObjects |
label() |
FindObjects |
language() |
FindObjects |
maxResults(int maxResults)
The maximum number of results that the server should provide at once.
|
FindObjects |
mDate() |
FindObjects |
ownerId() |
FindObjects |
pid()
Return the Fedora persistent identifier (PID) element of matching objects
in the response.
|
FindObjects |
publisher() |
FindObjects |
query(String query)
A sequence of space-separated conditions.
|
FindObjects |
relation() |
FindObjects |
resultFormat(String resultFormat)
The preferred output format.
|
FindObjects |
rights() |
FindObjects |
sessionToken(String sessionToken)
The identifier of the session to which the search results are being
returned.
|
FindObjects |
source() |
FindObjects |
state() |
FindObjects |
subject() |
FindObjects |
terms(String terms)
A phrase represented as a sequence of characters (including the ? and *
wildcards) for the search.
|
FindObjects |
title()
Return the Dublin Core title element(s) of matching objects in the
response.
|
FindObjects |
type() |
addHeader, addQueryParam, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, isDefaultClientSet, removeHeader, resource, resource, resource, resource, setDefaultClient, setHeaders, xParam
public FindObjects terms(String terms)
If this sequence is found in any of the fields for an object, the object is considered a match. Do NOT use this parameter in combination with the "query" parameter.
terms
- A phrase represented as a sequence of characterspublic FindObjects query(String query)
A condition consists of a metadata element name followed directly by an operator, followed directly by a value.
Valid element names are (pid, label, state, ownerId, cDate, mDate, dcmDate, title, creator, subject, description, publisher, contributor, date, type, format, identifier, source, language, relation, coverage, rights).
Valid operators are: contains (), equals (=), greater than (>), less than (<), greater than or equals (>=), less than or equals (<=). The contains () operator may be used in combination with the ? and * wildcards to query for simple string patterns. Space-separators should be encoded in the URL as %20.
Operators must be encoded when used in the URL syntax as follows: the (=) operator must be encoded as %3D, the (>) operator as %3E, the (<) operator as %3C, the (>=) operator as %3E%3D, the (<=) operator as %3C%3D, and the (~) operator as %7E. Values may be any string. If the string contains a space, the value should begin and end with a single quote character ('). If all conditions are met for an object, the object is considered a match.
Do NOT use this parameter in combination with the "terms" parameter.
query
- A sequence of space-separated conditions.public FindObjects maxResults(int maxResults)
maxResults
- The maximum number of results that the server should provide
at oncepublic FindObjects resultFormat(String resultFormat)
resultFormat
- one of "html" or "xml". Defaults to "xml".public FindObjects sessionToken(String sessionToken)
sessionToken
- The session identifierpublic FindObjects pid()
public FindObjects label()
public FindObjects state()
public FindObjects ownerId()
public FindObjects cDate()
public FindObjects mDate()
public FindObjects dcmDate()
public FindObjects title()
public FindObjects creator()
public FindObjects subject()
public FindObjects description()
public FindObjects publisher()
public FindObjects contributor()
public FindObjects date()
public FindObjects type()
public FindObjects format()
public FindObjects identifier()
public FindObjects source()
public FindObjects language()
public FindObjects relation()
public FindObjects coverage()
public FindObjects rights()
public FindObjectsResponse execute() throws FedoraClientException
FedoraRequest
Executes this request against the FedoraRequest.DEFAULT_CLIENT
execute
in class FedoraRequest<FindObjects>
FedoraClientException
- if FedoraRequest.DEFAULT_CLIENT
is null
public FindObjectsResponse execute(FedoraClient fedora) throws FedoraClientException
FedoraRequest
Execute this request using the supplied FedoraClient instance.
execute
in class FedoraRequest<FindObjects>
fedora
- an instance of FedoraClientFedoraClientException
- if the HTTP status code of the response is
>= 400.Copyright © 2010-2013 MediaShelf. All Rights Reserved.