com.yourmediashelf.fedora.client.request

Class PurgeDatastream

java.lang.Object

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

com.yourmediashelf.fedora.client.request.PurgeDatastream

public class PurgeDatastream
extends FedoraRequest<PurgeDatastream>

Builder for the PurgeDatastream method.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
PurgeDatastream(String pid, String dsId)

Method Summary

Methods

Modifier and Type	Method and Description
PurgeDatastream	endDT(Date endDT)
PurgeDatastream	endDT(String endDT)
PurgeDatastreamResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
PurgeDatastreamResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
PurgeDatastream	logMessage(String logMessage)
PurgeDatastream	startDT(Date startDT)
PurgeDatastream	startDT(String startDT)

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

PurgeDatastream

public PurgeDatastream(String pid,
               String dsId)

Method Detail

logMessage

public PurgeDatastream logMessage(String logMessage)

startDT

public PurgeDatastream startDT(String startDT)

Parameters:

startDT - the (inclusive) start date-time stamp of the range. If not specified, this is taken to be the lowest possible value, and thus, the entire version history up to the endDT will be purged.

Returns:

this builder

startDT

public PurgeDatastream startDT(Date startDT)

endDT

public PurgeDatastream endDT(String endDT)

Parameters:

endDT - the (inclusive) ending date-time stamp of the range. If not specified, this is taken to be the greatest possible value, and thus, the entire version history back to the startDT will be purged.

Returns:

this builder

endDT

public PurgeDatastream endDT(Date endDT)

execute

public PurgeDatastreamResponse execute()
                                throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<PurgeDatastream>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public PurgeDatastreamResponse execute(FedoraClient fedora)
                                throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<PurgeDatastream>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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