com.yourmediashelf.fedora.client.request

Class GetNextPID

java.lang.Object

com.yourmediashelf.fedora.client.request.FedoraRequest<GetNextPID>

com.yourmediashelf.fedora.client.request.GetNextPID

public class GetNextPID
extends FedoraRequest<GetNextPID>

Builder for the GetNextPID method.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
GetNextPID()

Method Summary

Methods

Modifier and Type	Method and Description
GetNextPIDResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
GetNextPIDResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
GetNextPID	format(String format) The format of the response.
GetNextPID	namespace(String namespace) Namespace of the returned pid(s).
GetNextPID	numPIDs(int numPIDs) Set the number of pids this request should return.

Methods inherited from class com.yourmediashelf.fedora.client.request.FedoraRequest

addHeader, addQueryParam, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, isDefaultClientSet, removeHeader, resource, resource, resource, resource, setDefaultClient, setHeaders, xParam

Methods inherited from class java.lang.Object

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

Constructor Detail

GetNextPID

public GetNextPID()

Method Detail

format

public GetNextPID format(String format)

The format of the response. Defaults to "xml".

The Fedora REST API default is "html", but fedora-client will set "xml" as the default in order to parse the response. If "html" is selected, the caller is responsible for parsing the raw HTTP response as most of the FedoraResponse convenience methods rely on an XML response.

Parameters:

format - The response format, either "xml" or "html"

Returns:

this builder

namespace

public GetNextPID namespace(String namespace)

Namespace of the returned pid(s). If omitted, the returned pids will use the server-configured default namespace.

Parameters:

namespace -

Returns:

this builder

numPIDs

public GetNextPID numPIDs(int numPIDs)

Set the number of pids this request should return.

Parameters:

numPIDs - the number of pids to return.

Returns:

this builder

execute

public GetNextPIDResponse execute()
                           throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<GetNextPID>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public GetNextPIDResponse execute(FedoraClient fedora)
                           throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<GetNextPID>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

FedoraClientException - if the HTTP status code of the response is >= 400.