com.fsc.cicerone.model

Class Itinerary

java.lang.Object

com.fsc.cicerone.model.BusinessEntity

com.fsc.cicerone.model.Itinerary

public class Itinerary
extends BusinessEntity

An entity class that stores the data of an itinerary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Itinerary.Builder A factory for a Itinerary's object.
static class	Itinerary.Columns A utility class that contains various strings to be used as keys to communicate with the remote server.

Constructor Summary

Constructors

Constructor and Description
Itinerary() Default empty constructor.
Itinerary(org.json.JSONObject jsonObject) Create a new Itinerary object based on a JSON Object.
Itinerary(java.lang.String json) Itinerary's constructor.

Method Summary

Modifier and Type	Method and Description
void	addLanguage(Language language) Add a language to the itinerary's languages' list if it doesn't exists, otherwise do nothing.
boolean	equals(java.lang.Object o)
java.util.Date	getBeginningDate() Get the itinerary's beginning date.
User	getCicerone() Get the itinerary's author.
int	getCode() Get the itinerary's code.
java.lang.String	getDescription() Get the itinerary's description.
java.lang.String	getDuration() Get the itinerary's duration.
java.util.Date	getEndingDate() Get the itinerary's ending date.
float	getFullPrice() Get the itinerary's full price.
java.lang.String	getImageUrl() Get the itinerary's image url.
java.util.Set<Language>	getLanguages() Get all the itinerary's languages.
java.lang.String	getLocation() Get the itinerary's location.
int	getMaxParticipants() Get the itinerary's maximum participants number.
int	getMinParticipants() Get the itinerary's minimum participants number.
float	getReducedPrice() Get the itinerary's reduced price.
int	getRepetitions() Get the itinerary's repetitions per day.
java.util.Date	getReservationDate() Get the itinerary's askForReservation date.
java.lang.String	getTitle() Get the itinerary's title.
int	hashCode()
boolean	isInLanguages(java.util.Collection<Language> languages) Check if the itinerary is available in at least one of the given languages.
boolean	isInLanguages(Language languages) Check if the itinerary is available in the specified language.
protected void	loadFromJSONObject(org.json.JSONObject itinerary) Set the BusinessEntity's properties loading them from a JSONObject.
void	removeLanguage(Language language) Remove a language from the itinerary's languages' list if it exists, otherwise do nothing.
void	setBeginningDate(java.util.Date beginningDate) Set the itinerary's beginning date.
void	setCicerone(User cicerone) Set the itinerary's author.
void	setCode(int code) Set the itinerary's code.
void	setDescription(java.lang.String description) Set the itinerary's description.
void	setDuration(java.lang.String duration) Set the itinerary's duration.
void	setEndingDate(java.util.Date endingDate) Set the itinerary's endingDate.
void	setFullPrice(float fullPrice) Set the itinerary's full price.
void	setImageUrl(java.lang.String imageUrl) Set the itinerary's image url.
void	setLocation(java.lang.String location) Set the itinerary's location.
void	setMaxParticipants(int maxParticipants) Set the itinerary's maximum participants number.
void	setMinParticipants(int minParticipants) Set the itinerary's minimum participants number.
void	setReducedPrice(float reducedPrice) Set the itinerary's reduced price.
void	setRepetitions(int repetitions) Set the itinerary's repetitions per day.
void	setReservationDate(java.util.Date reservationDate) Set the itinerary's askForReservation Date.
void	setTitle(java.lang.String title) Set the itinerary's title.
org.json.JSONObject	toJSONObject() Convert the itinerary to a JSON Object.

Methods inherited from class com.fsc.cicerone.model.BusinessEntity

getJSONObject, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Itinerary

public Itinerary()

Default empty constructor.

Itinerary

public Itinerary(java.lang.String json)

Itinerary's constructor. Convert a json string to Itinerary.

Parameters:

json -

Itinerary

public Itinerary(org.json.JSONObject jsonObject)

Create a new Itinerary object based on a JSON Object. The JSON Object must contain at least the following values:

 
 {
     "itinerary_code": "-1",
     "itineraryname": "test",
     "title": "Titolo",
     "description": "Descrizione",
     "beginningDate": "01-01-2000",
     "endingDate": "01-01-2000",
     "reservationDate": "01-01-2000",
     "location": "Location",
     "duration": "00:00:00",
     "repetitions": "1",
     "minParticipants": "0",
     "maxParticipants": "0",
     "fullPrice": "0",
     "reducedPrice": "0"
 }
 
 

Parameters:

jsonObject - The JSON object from which data will be fetched.

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

loadFromJSONObject

protected void loadFromJSONObject(org.json.JSONObject itinerary)

Description copied from class: BusinessEntity

Set the BusinessEntity's properties loading them from a JSONObject.

Specified by:

loadFromJSONObject in class BusinessEntity

Parameters:

itinerary - The JSONObject.

See Also:

BusinessEntity.loadFromJSONObject(JSONObject)

getCode

public int getCode()

Get the itinerary's code.

Returns:

The itinerary's code.

getCicerone

public User getCicerone()

Get the itinerary's author.

Returns:

The itinerary's author.

setCicerone

public void setCicerone(User cicerone)

Set the itinerary's author.

Parameters:

cicerone - The new itinerary's author.

setCode

public void setCode(int code)

Set the itinerary's code.

Parameters:

code - The new itinerary's code.

getTitle

public java.lang.String getTitle()

Get the itinerary's title.

Returns:

The itinerary's title.

setTitle

public void setTitle(java.lang.String title)

Set the itinerary's title.

Parameters:

title - The new itinerary's title.

getDescription

public java.lang.String getDescription()

Get the itinerary's description.

Returns:

The itinerary's description.

setDescription

public void setDescription(java.lang.String description)

Set the itinerary's description.

Parameters:

description - The new itinerary's description.

getBeginningDate

public java.util.Date getBeginningDate()

Get the itinerary's beginning date.

Returns:

The itinerary's beginning date.

setBeginningDate

public void setBeginningDate(java.util.Date beginningDate)

Set the itinerary's beginning date.

Parameters:

beginningDate - The new itinerary's beginning date .

getEndingDate

public java.util.Date getEndingDate()

Get the itinerary's ending date.

Returns:

The itinerary's ending date.

setEndingDate

public void setEndingDate(java.util.Date endingDate)

Set the itinerary's endingDate.

Parameters:

endingDate - The new itinerary's ending date.

getReservationDate

public java.util.Date getReservationDate()

Get the itinerary's askForReservation date.

Returns:

The itinerary's askForReservation date.

setReservationDate

public void setReservationDate(java.util.Date reservationDate)

Set the itinerary's askForReservation Date.

Parameters:

reservationDate - The new itinerary's askForReservation date.

getLocation

public java.lang.String getLocation()

Get the itinerary's location.

Returns:

The itinerary's location.

setLocation

public void setLocation(java.lang.String location)

Set the itinerary's location.

Parameters:

location - The new itinerary's location.

getMinParticipants

public int getMinParticipants()

Get the itinerary's minimum participants number.

Returns:

The itinerary's minimum participants number.

setMinParticipants

public void setMinParticipants(int minParticipants)

Set the itinerary's minimum participants number.

Parameters:

minParticipants - The new itinerary's mininum participants number.

getMaxParticipants

public int getMaxParticipants()

Get the itinerary's maximum participants number.

Returns:

The itinerary's maximum partcipants number.

setMaxParticipants

public void setMaxParticipants(int maxParticipants)

Set the itinerary's maximum participants number.

Parameters:

maxParticipants - The new itinerary's maximum participants number.

getRepetitions

public int getRepetitions()

Get the itinerary's repetitions per day.

Returns:

The itinerary's repetitions per day.

setRepetitions

public void setRepetitions(int repetitions)

Set the itinerary's repetitions per day.

Parameters:

repetitions - The new itinerary's repetitions per day.

getDuration

public java.lang.String getDuration()

Get the itinerary's duration.

Returns:

The itinerary's duration.

setDuration

public void setDuration(java.lang.String duration)

Set the itinerary's duration.

Parameters:

duration - The new itinerary's duration.

getFullPrice

public float getFullPrice()

Get the itinerary's full price.

Returns:

The itinerary's full price.

setFullPrice

public void setFullPrice(float fullPrice)

Set the itinerary's full price.

Parameters:

fullPrice - price The new itinerary's full price.

getReducedPrice

public float getReducedPrice()

Get the itinerary's reduced price.

Returns:

The itinerary's reduced price.

setReducedPrice

public void setReducedPrice(float reducedPrice)

Set the itinerary's reduced price.

Parameters:

reducedPrice - price The new itinerary's reduced price.

getImageUrl

public java.lang.String getImageUrl()

Get the itinerary's image url.

Returns:

The itinerary's image url.

setImageUrl

public void setImageUrl(java.lang.String imageUrl)

Set the itinerary's image url.

Parameters:

imageUrl - price The new itinerary's image url.

getLanguages

public java.util.Set<Language> getLanguages()

Get all the itinerary's languages.

Returns:

A set containing all the user's languages.

addLanguage

public void addLanguage(Language language)

Add a language to the itinerary's languages' list if it doesn't exists, otherwise do nothing.

Parameters:

language - The language to be added.

removeLanguage

public void removeLanguage(Language language)

Remove a language from the itinerary's languages' list if it exists, otherwise do nothing.

Parameters:

language - The language to be removed.

isInLanguages

public boolean isInLanguages(java.util.Collection<Language> languages)

Check if the itinerary is available in at least one of the given languages.

Parameters:

languages - A collection of languages to be searched.

Returns:

It returns true if the itinerary is available in at least one language in languages, it returns false otherwise.

isInLanguages

public boolean isInLanguages(Language languages)

Check if the itinerary is available in the specified language.

Parameters:

languages - The language to be searched.

Returns:

It returns true if the itinerary is available in the given language, false otherwise.

toJSONObject

public org.json.JSONObject toJSONObject()

Convert the itinerary to a JSON Object.

Specified by:

toJSONObject in class BusinessEntity

Returns:

A JSON Object containing the data that were stored in the object.