Package org.bedework.calfacade.requests

Class GetInstancesRequest

java.lang.Object

org.bedework.calfacade.requests.RequestBase

org.bedework.calfacade.requests.GetInstancesRequest

public class GetInstancesRequest
extends RequestBase

Request instances for a given recurrence rule and start date. Exdates, Rdates may be provided. Additionally the result may be limited by a begin and/or an end date.

If no rrule is provided then rdates MUST be supplied

User: douglm: Bedework Commercial Services

Field Summary

Fields inherited from class org.bedework.calfacade.requests.RequestBase

getInstancesAction

Constructor Summary

Constructors

Constructor	Description
GetInstancesRequest()
GetInstancesRequest(String rrule, BwDateTime startDt, BwDateTime endDt)

Method Summary

Modifier and Type	Method	Description
String	getBegin()
String	getEnd()
BwDateTime	getEndDt()
Collection<String>	getExdates()
Collection<String>	getRdates()
String	getRrule()
BwDateTime	getStartDt()
void	setBegin(String val)
void	setEnd(String val)
void	setExdates(Collection<String> val)
void	setRdates(Collection<String> val)
void	toStringSegment(org.bedework.util.misc.ToString ts)	Add information to the ToString builder
boolean	validate(org.bedework.util.misc.response.Response resp)	May clean up the data in the request.

Methods inherited from class org.bedework.calfacade.requests.RequestBase

getAction, getId, setAction, setId, toString

Methods inherited from class java.lang.Object

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

Constructor Details

GetInstancesRequest

public GetInstancesRequest()

GetInstancesRequest

public GetInstancesRequest(String rrule,
 BwDateTime startDt,
 BwDateTime endDt)

Method Details

getRrule

public String getRrule()

Returns:

rrule or null

getStartDt

public BwDateTime getStartDt()

Returns:

start date

getEndDt

public BwDateTime getEndDt()

Returns:

end date

setExdates

public void setExdates(Collection<String> val)

Parameters:

val - collection of exdates

getExdates

public Collection<String> getExdates()

Returns:

collection of exdates

setRdates

public void setRdates(Collection<String> val)

Parameters:

val - collection of rdates

getRdates

public Collection<String> getRdates()

Returns:

collection of rdates

setBegin

public void setBegin(String val)

Parameters:

val - beginning of window or null

getBegin

public String getBegin()

Returns:

beginning of window or null

setEnd

public void setEnd(String val)

Parameters:

val - end of window or null

getEnd

public String getEnd()

Returns:

end of window or null

validate

public boolean validate(org.bedework.util.misc.response.Response resp)

Description copied from class: RequestBase

May clean up the data in the request.

Overrides:

validate in class RequestBase

Parameters:

resp - for failed status and message

Returns:

true for ok request

toStringSegment

public void toStringSegment(org.bedework.util.misc.ToString ts)

Description copied from class: RequestBase

Add information to the ToString builder

Overrides:

toStringSegment in class RequestBase

Parameters:

ts - ToString builder