com.xtravelsystem.online.published.V1_0RC1.basket.requests
Class GetBasketsRQ

java.lang.Object
  com.xtravelsystem.online.published.V1_0RC1.common.AbstractRQ
      com.xtravelsystem.online.published.V1_0RC1.basket.requests.GetBasketsRQ

public class GetBasketsRQ
extends AbstractRQ

holder for the getbaskets method request.
Please note that we will return baskets for a 3 months period as maximum.

Author:

Miguel Pérez

Constructor Summary

GetBasketsRQ()

Method Summary

java.lang.String	getAgencyCode() getter for your agency code.
java.lang.String	getBasketId()
java.util.Date	getFromConfirmDate() use this when you want to search by basket confirm date.
java.util.Date	getFromLastUpdateDate() use this when you want to search by basket last update date.
int	getFromRow() this method return a paged list.
java.util.Date	getFromServiceStart() getter for service starting date filter.
int	getNumRows() this method return a paged list.
java.lang.String[]	getStatuses() array of status codes.
java.lang.String	getTitular() getter for the titular name.
java.util.Date	getToConfirmDate() use this when you want to search by basket confirm date.
java.util.Date	getToLastUpdateDate() use this when you want to search by basket last update date.
java.util.Date	getToServiceStart() use this field when you want to search by service starting date.
java.lang.String	getUserId() id of user who made the reservation.
java.lang.String	getWasOnRequest() Use this to filter by confirmation type (ONLINE / ONREQUEST).
java.lang.String	getYourReference() getter for your reference.
void	setAgencyCode(java.lang.String agencyCode) setter for your agency code.
void	setBasketId(java.lang.String basketId)
void	setFromConfirmDate(java.util.Date fromConfirmDate) use this when you want to search by basket confirm date.
void	setFromLastUpdateDate(java.util.Date fromLastUpdateDate) use this when you want to search by basket last update date.
void	setFromRow(int fromRow) this method return a paged list.
void	setFromServiceStart(java.util.Date fromServiceStart) setter for service starting date filter.
void	setNumRows(int numRows) this method return a paged list.
void	setStatuses(java.lang.String[] statuses) array of status codes.
void	setTitular(java.lang.String titular) setter for the titular name.
void	setToConfirmDate(java.util.Date toConfirmDate) use this when you want to search by basket confirm date.
void	setToLastUpdateDate(java.util.Date toLastUpdateDate) use this when you want to search by basket last update date.
void	setToServiceStart(java.util.Date toServiceStart) use this field when you want to search by service starting date.
void	setUserId(java.lang.String userId) id of user who made the reservation.
void	setWasOnRequest(java.lang.String wasOnRequest) Use this to filter by confirmation type (ONLINE / ONREQUEST).
void	setYourReference(java.lang.String yourReference) setter for your reference.
boolean	validate()

Methods inherited from class com.xtravelsystem.online.published.V1_0RC1.common.AbstractRQ

getBrandCode, getPointOfSaleId, setBrandCode, setPointOfSaleId

Methods inherited from class java.lang.Object

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

Constructor Detail

GetBasketsRQ

public GetBasketsRQ()

Method Detail

getBasketId

public java.lang.String getBasketId()

setBasketId

public void setBasketId(java.lang.String basketId)

getFromConfirmDate

public java.util.Date getFromConfirmDate()

use this when you want to search by basket confirm date. Leave null if you don't want to search by this criteria

setFromConfirmDate

public void setFromConfirmDate(java.util.Date fromConfirmDate)

use this when you want to search by basket confirm date. Leave null if you don't want to search by this criteria

getFromLastUpdateDate

public java.util.Date getFromLastUpdateDate()

use this when you want to search by basket last update date. Leave null if you don't want to search by this criteria

setFromLastUpdateDate

public void setFromLastUpdateDate(java.util.Date fromLastUpdateDate)

use this when you want to search by basket last update date. Leave null if you don't want to search by this criteria

getFromRow

public int getFromRow()

this method return a paged list. Use this field to indicate from which row you want to retrieve results.
Starts with 1. This parameter is MANDATORY

setFromRow

public void setFromRow(int fromRow)

this method return a paged list. Use this field to indicate from which row you want to retrieve results.
Starts with 1. This parameter is MANDATORY

getFromServiceStart

public java.util.Date getFromServiceStart()

getter for service starting date filter. Use this field when you want to search by service starting date. Leave null if you don't want to search by this criteria

setFromServiceStart

public void setFromServiceStart(java.util.Date fromServiceStart)

setter for service starting date filter. Use this field when you want to search by service starting date. Leave null if you don't want to search by this criteria

getNumRows

public int getNumRows()

this method return a paged list. Use this field to indicate how many rows you want to retrieve.
You can indicate a max value of 300. This parameter is MANDATORY

setNumRows

public void setNumRows(int numRows)

this method return a paged list. Use this field to indicate how many rows you want to retrieve.
You can indicate a max value of 300. This parameter is MANDATORY

getStatuses

public java.lang.String[] getStatuses()

array of status codes. Use this to filter by status code. Leave null if you don't want to search by this criteria.

status code can be:

• CONFIRMED for confirmed baskets
• CANCELLED for cancelled baskets
• ONREQUEST for confirmation pending baskets

setStatuses

public void setStatuses(java.lang.String[] statuses)

array of status codes. Use this to filter by status code. Leave null if you don't want to search by this criteria.

status code can be:

• CONFIRMED for confirmed baskets
• CANCELLED for cancelled baskets
• ONREQUEST for confirmation pending baskets

getTitular

public java.lang.String getTitular()

getter for the titular name. Leave null if you don't want to search by this criteria

setTitular

public void setTitular(java.lang.String titular)

setter for the titular name. Leave null if you don't want to search by this criteria

getToConfirmDate

public java.util.Date getToConfirmDate()

use this when you want to search by basket confirm date. Leave null if you don't want to search by this criteria

setToConfirmDate

public void setToConfirmDate(java.util.Date toConfirmDate)

use this when you want to search by basket confirm date. Leave null if you don't want to search by this criteria

getToLastUpdateDate

public java.util.Date getToLastUpdateDate()

use this when you want to search by basket last update date. Leave null if you don't want to search by this criteria

setToLastUpdateDate

public void setToLastUpdateDate(java.util.Date toLastUpdateDate)

use this when you want to search by basket last update date. Leave null if you don't want to search by this criteria

getToServiceStart

public java.util.Date getToServiceStart()

use this field when you want to search by service starting date. Leave null if you don't want to search by this criteria

setToServiceStart

public void setToServiceStart(java.util.Date toServiceStart)

use this field when you want to search by service starting date. Leave null if you don't want to search by this criteria

getWasOnRequest

public java.lang.String getWasOnRequest()

Use this to filter by confirmation type (ONLINE / ONREQUEST). Leave null if you don't want to search by this criteria.

type code can be:

• NO for confirmed online baskets
• YES for confirmed on request baskets

setWasOnRequest

public void setWasOnRequest(java.lang.String wasOnRequest)

Use this to filter by confirmation type (ONLINE / ONREQUEST). Leave null if you don't want to search by this criteria.

type code can be:

• NO for confirmed online baskets
• YES for confirmed on request baskets

getUserId

public java.lang.String getUserId()

id of user who made the reservation. In fact, you can use this field for whatever you want

setUserId

public void setUserId(java.lang.String userId)

id of user who made the reservation. In fact, you can use this field for whatever you want

getYourReference

public java.lang.String getYourReference()

getter for your reference. Leave null if you don't want to search by this criteria

setYourReference

public void setYourReference(java.lang.String yourReference)

setter for your reference. Leave null if you don't want to search by this criteria

getAgencyCode

public java.lang.String getAgencyCode()

getter for your agency code. This parameter is MANDATORY

Overrides:

getAgencyCode in class AbstractRQ

setAgencyCode

public void setAgencyCode(java.lang.String agencyCode)

setter for your agency code. This parameter is MANDATORY

Overrides:

setAgencyCode in class AbstractRQ

validate

public boolean validate()
                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException