org.yawlfoundation.yawl.resourcing.rsInterface

Class ResourceCalendarGatewayClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.resourcing.rsInterface.ResourceCalendarGatewayClient

public class ResourceCalendarGatewayClient
extends Interface_Client

Author:

Michael Adams

Created/Last Date:

11/10/2010

Constructor Summary

Constructors

Constructor and Description
ResourceCalendarGatewayClient() empty constructor
ResourceCalendarGatewayClient(java.lang.String uri) constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkConnection(java.lang.String handle) Check that a session handle is active
java.lang.String	connect(java.lang.String userID, java.lang.String password) Connects an external entity to the resource service
void	disconnect(java.lang.String handle) Disconnects an external entity from the resource service
java.lang.String	getAvailability(java.lang.String resourceXML, java.util.Date fromDate, java.util.Date toDate, java.lang.String handle) Gets the periods (timeslots) between 'from' and 'to' when the resource described by the resource record xml, is available
java.lang.String	getAvailability(java.lang.String resourceXML, long from, long to, java.lang.String handle) Gets the periods (timeslots) between 'from' and 'to' when the resource described by the resource record xml, is available
java.lang.String	getReservations(java.lang.String resourceXML, java.util.Date fromDate, java.util.Date toDate, java.lang.String handle) Gets all the current reservations held for a resource within a time period
java.lang.String	getReservations(java.lang.String resourceXML, long from, long to, java.lang.String handle) Gets all the current reservations held for a resource within a time period
java.lang.String	getResourceAvailability(java.lang.String resourceID, java.util.Date fromDate, java.util.Date toDate, java.lang.String handle) Gets the periods (timeslots) between 'from' and 'to' when the resource is available
java.lang.String	getResourceAvailability(java.lang.String resourceID, long from, long to, java.lang.String handle) Gets the periods (timeslots) between 'from' and 'to' when the resource is available
java.lang.String	registerStatusChangeListener(java.lang.String uri, java.lang.String handle) Registers a URI as a listener for status change events.
void	removeStatusChangeListener(java.lang.String uri, java.lang.String handle) Removes a URI as a listener for status change events.
java.lang.String	saveReservations(java.lang.String planXML, boolean checkOnly, java.lang.String handle) Saves all the reservations within a UtilisationPlan (where possible)

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client

executeGet, executePost, getReply, initPostConnection, prepareParamMap, send, setReadTimeout, stripOuterElement, successful

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCalendarGatewayClient

public ResourceCalendarGatewayClient()

empty constructor

ResourceCalendarGatewayClient

public ResourceCalendarGatewayClient(java.lang.String uri)

constructor

Parameters:

uri - the uri of the resourceService's gateway

Method Detail

connect

public java.lang.String connect(java.lang.String userID,
                                java.lang.String password)
                         throws java.io.IOException

Connects an external entity to the resource service

Parameters:

userID - the userid

password - the corresponding password

Returns:

a sessionHandle if successful, or a failure message if not

Throws:

java.io.IOException - if the service can't be reached

checkConnection

public java.lang.String checkConnection(java.lang.String handle)
                                 throws java.io.IOException

Check that a session handle is active

Parameters:

handle - the session handle to check

Returns:

"true" if the id is valid, "false" if otherwise

Throws:

java.io.IOException - if the service can't be reached

disconnect

public void disconnect(java.lang.String handle)
                throws java.io.IOException

Disconnects an external entity from the resource service

Parameters:

handle - the sessionHandle to disconnect

Throws:

java.io.IOException - if the service can't be reached

registerStatusChangeListener

public java.lang.String registerStatusChangeListener(java.lang.String uri,
                                                     java.lang.String handle)
                                              throws java.io.IOException

Registers a URI as a listener for status change events. Note that only changes that affect the owner of the handle will receive events via the URI.

Parameters:

uri - the uri to which status change announcements are made

handle - a valid session handle

Returns:

a diagnostic message

Throws:

java.io.IOException - if the service can't be reached

removeStatusChangeListener

public void removeStatusChangeListener(java.lang.String uri,
                                       java.lang.String handle)
                                throws java.io.IOException

Removes a URI as a listener for status change events.

Parameters:

uri - the uri to remove as a listener for status change announcements

handle - a valid session handle

Throws:

java.io.IOException - if the service can't be reached

getAvailability

public java.lang.String getAvailability(java.lang.String resourceXML,
                                        long from,
                                        long to,
                                        java.lang.String handle)
                                 throws java.io.IOException

Gets the periods (timeslots) between 'from' and 'to' when the resource described by the resource record xml, is available

Parameters:

resourceXML - the resource record to check for availability

from - the start of the date/time range

to - the end of the date/time range

handle - a valid session handle

Returns:

an xml string of the resource's available timeslots

Throws:

java.io.IOException - if the service can't be reached

getAvailability

public java.lang.String getAvailability(java.lang.String resourceXML,
                                        java.util.Date fromDate,
                                        java.util.Date toDate,
                                        java.lang.String handle)
                                 throws java.io.IOException

Gets the periods (timeslots) between 'from' and 'to' when the resource described by the resource record xml, is available

Parameters:

resourceXML - the resource record to check for availability

fromDate - the start of the date/time range

toDate - the end of the date/time range

handle - a valid session handle

Returns:

an xml string of the resource's available timeslots

Throws:

java.io.IOException - if the service can't be reached

getResourceAvailability

public java.lang.String getResourceAvailability(java.lang.String resourceID,
                                                long from,
                                                long to,
                                                java.lang.String handle)
                                         throws java.io.IOException

Gets the periods (timeslots) between 'from' and 'to' when the resource is available

Parameters:

resourceID - the resource to check for availability

from - the start of the date/time range

to - the end of the date/time range

handle - a valid session handle

Returns:

an xml string of the resource's available timeslots

Throws:

java.io.IOException - if the service can't be reached

getResourceAvailability

public java.lang.String getResourceAvailability(java.lang.String resourceID,
                                                java.util.Date fromDate,
                                                java.util.Date toDate,
                                                java.lang.String handle)
                                         throws java.io.IOException

Gets the periods (timeslots) between 'from' and 'to' when the resource is available

Parameters:

resourceID - the resource to check for availability

fromDate - the start of the date/time range

toDate - the end of the date/time range

handle - a valid session handle

Returns:

an xml string of the resource's available timeslots

Throws:

java.io.IOException - if the service can't be reached

getReservations

public java.lang.String getReservations(java.lang.String resourceXML,
                                        long from,
                                        long to,
                                        java.lang.String handle)
                                 throws java.io.IOException

Gets all the current reservations held for a resource within a time period

Parameters:

resourceXML - the resource(s) to get the reservations for

from - the start of the date/time range

to - the end of the date/time range

handle - a valid session handle

Returns:

an xml string of the resource's reservations

Throws:

java.io.IOException - if the service can't be reached

getReservations

public java.lang.String getReservations(java.lang.String resourceXML,
                                        java.util.Date fromDate,
                                        java.util.Date toDate,
                                        java.lang.String handle)
                                 throws java.io.IOException

Gets all the current reservations held for a resource within a time period

Parameters:

resourceXML - the resource(s) to get the reservations for

fromDate - the start of the date/time range

toDate - the end of the date/time range

handle - a valid session handle

Returns:

an xml string of the resource's reservations

Throws:

java.io.IOException - if the service can't be reached

saveReservations

public java.lang.String saveReservations(java.lang.String planXML,
                                         boolean checkOnly,
                                         java.lang.String handle)
                                  throws java.io.IOException

Saves all the reservations within a UtilisationPlan (where possible)

Parameters:

planXML - the UtilisationPlan containing the reservations

checkOnly - if true, will report on the effects only - won't update the reservations

handle - a valid session handle

Returns:

an passed xml plan, updated with messages where appropriate

Throws:

java.io.IOException - if the service can't be reached