Class Index | File Index

Classes


Class TourismClient

jQuery client stub for the CitySDK Tourism WP5
Defined in: jquery.citysdk-tourism.stub.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
TourismClient.getByCode(code, handleData, handleError)
Returns a list of POI-based objects containing the given code
<static>  
TourismClient.getCategories(parameters, handleData, handleError)
Perform a request to get a list of Categories of either POIs, Events or Routes.
<static>  
TourismClient.getEvent(base, id, handleData, handleError)
Request for a single Event.
<static>  
TourismClient.getEventRelation(base, id, relation, handleData, handleError)
Returns a list of Events with the given relation with the Event identified by base and id.
<static>  
TourismClient.getEvents(parameters, handleData, handleError)
Perform a request with the given parameters to get the Events corresponding to the query.
<static>  
TourismClient.getGeneric(base, id, handleData, handleError)
Request for a generic POI-based object.
<static>  
TourismClient.getPoi(base, id, handleData, handleError)
Request for a single POI.
<static>  
TourismClient.getPoiRelation(base, id, relation, handleData, handleError)
Returns a list of Points of Interest with the given relation with the POI identified by base and id.
<static>  
TourismClient.getPois(parameters, handleData, handleError)
Perform a request with the given parameters to get the POIs corresponding to the query.
<static>  
TourismClient.getResources()
Gets the available resources for the visited server.
<static>  
TourismClient.getRoute(base, id, handleData, handleError)
Request for a single Route.
<static>  
TourismClient.getRoutes(parameters, handleData, handleError)
Perform a request with the given parameters to get the Routes corresponding to the query.
<static>  
TourismClient.getTags(parameters, handleData, handleError)
Perform a request to get a list of Tags of either POIs, Events or Routes.
<static>  
TourismClient.hasResource(resource)
Checks whether the given resource is available or not.
<static>  
TourismClient.hasResourceParameter(resource, parameter)
Checks whether the given parameter is available in a resource or not.
<static>  
TourismClient.useVersion(v)
Use a given version
Class Detail
TourismClient(data)
Parameters:
data
mapping of available capacities in the server
Method Detail
<static> TourismClient.getByCode(code, handleData, handleError)
Returns a list of POI-based objects containing the given code
Parameters:
code
a link to search for POI-based objects
handleData
the callback to handle the returned data. Its parameters should be the data (a list of POI-based objects), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{ResourceNotAvailable}
thrown if getting a Event relations is unavailable for the server.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> TourismClient.getCategories(parameters, handleData, handleError)
Perform a request to get a list of Categories of either POIs, Events or Routes.
Parameters:
parameters
the request parameters. The list parameter should be either pois, events or routes.
handleData
the callback to handle the returned data. Its parameters should be the data (a list of Categories) and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{InvalidTermException}
thrown if the term is an invalid term.
{ResourceNotAvailable}
thrown if getting a category listing is unavailable for the server.
{InvalidParameterException}
thrown if at least one parameter is not valid for the Categories listing search.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> TourismClient.getEvent(base, id, handleData, handleError)
Request for a single Event.
Parameters:
base
the base URI of the Event.
id
the id of the Event.
handleData
the callback to handle the returned data. Its parameters should be the data (a Event), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.

<static> TourismClient.getEventRelation(base, id, relation, handleData, handleError)
Returns a list of Events with the given relation with the Event identified by base and id. The relation should be either: child or parent
Parameters:
base
the base URI of the related Event.
id
the id of the related Event.
relation
the relationship to search for
handleData
the callback to handle the returned data. Its parameters should be the data (a list of Events), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{InvalidTermException}
thrown if the relation is an invalid term.
{ResourceNotAvailable}
thrown if getting a Event relations is unavailable for the server.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> TourismClient.getEvents(parameters, handleData, handleError)
Perform a request with the given parameters to get the Events corresponding to the query.
Parameters:
parameters
the request parameters
handleData
the callback to handle the returned data. Its parameters should be the data (a list of Events), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{ResourceNotAvailableException}
thrown if Events listing search is not available in this server.
{InvalidParameterException}
thrown if at least one parameter is not valid for the Events listing search.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> TourismClient.getGeneric(base, id, handleData, handleError)
Request for a generic POI-based object.
Parameters:
base
the base URI of the object.
id
the id of the object.
handleData
the callback to handle the returned data. Its parameters should be the data (a object), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.

<static> TourismClient.getPoi(base, id, handleData, handleError)
Request for a single POI.
Parameters:
base
the base URI of the POI.
id
the id of the POI.
handleData
the callback to handle the returned data. Its parameters should be the data (a POI), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.

<static> TourismClient.getPoiRelation(base, id, relation, handleData, handleError)
Returns a list of Points of Interest with the given relation with the POI identified by base and id. The relation should be either: child or parent
Parameters:
base
the base URI of the related POI.
id
the id of the related POI.
relation
the relationship to search for
handleData
the callback to handle the returned data. Its parameters should be the data (a list of POIs), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{InvalidTermException}
thrown if the relation is an invalid term.
{ResourceNotAvailable}
thrown if getting a POI relations is unavailable for the server.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> TourismClient.getPois(parameters, handleData, handleError)
Perform a request with the given parameters to get the POIs corresponding to the query.
Parameters:
parameters
the request parameters
handleData
the callback to handle the returned data. Its parameters should be the data (a list of POIs), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{ResourceNotAvailableException}
thrown if POIs listing search is not available in this server.
{InvalidParameterException}
thrown if at least one parameter is not valid for the POIs listing search.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> {String[]} TourismClient.getResources()
Gets the available resources for the visited server.
Throws:
{VersionNotAvailableException}
thrown if the version was not set or is not available.
Returns:
{String[]} a mapping of available resources.

<static> TourismClient.getRoute(base, id, handleData, handleError)
Request for a single Route.
Parameters:
base
the base URI of the Route.
id
the id of the Route.
handleData
the callback to handle the returned data. Its parameters should be the data (a Route), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.

<static> TourismClient.getRoutes(parameters, handleData, handleError)
Perform a request with the given parameters to get the Routes corresponding to the query.
Parameters:
parameters
the request parameters
handleData
the callback to handle the returned data. Its parameters should be the data (a list of Routes), a textStatus and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{ResourceNotAvailableException}
thrown if Routes listing search is not available in this server.
{InvalidParameterException}
thrown if at least one parameter is not valid for the Routes listing search.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> TourismClient.getTags(parameters, handleData, handleError)
Perform a request to get a list of Tags of either POIs, Events or Routes.
Parameters:
parameters
the request parameters. The list parameter should be either pois, events or routes.
handleData
the callback to handle the returned data. Its parameters should be the data (a list of Tags) and a jQuery XMLHttpRequest (jqXHR) object.
handleError
the callback to handle network errors. Its parameters should be a jQuery XMLHttpRequest (jqXHR) object, textStatus and errorThrown.
Throws:
{InvalidTermException}
thrown if the term is an invalid term.
{ResourceNotAvailable}
thrown if getting a tags listing is unavailable for the server.
{InvalidParameterException}
thrown if at least one parameter is not valid for the Tags listing search.
{VersionNotAvailableException}
thrown if the version was not set or is not available.

<static> {boolean} TourismClient.hasResource(resource)
Checks whether the given resource is available or not.
Parameters:
resource
the resource to check for availability.
Throws:
{VersionNotAvailableException}
thrown if the version was not set or is not available.
Returns:
{boolean} true if available, false otherwise.

<static> {boolean} TourismClient.hasResourceParameter(resource, parameter)
Checks whether the given parameter is available in a resource or not.
Parameters:
resource
the resource to check the parameter.
parameter
the parameter to check for availability
Throws:
{VersionNotAvailableException}
thrown if the version was not set or is not available.
Returns:
{boolean} true if available, false otherwise.

<static> TourismClient.useVersion(v)
Use a given version
Parameters:
v
version to use

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Jul 02 2013 13:20:49 GMT+0100 (WEST)