org.yawlfoundation.yawl.scheduling.resource

Class ResourceServiceInterface

java.lang.Object

org.yawlfoundation.yawl.scheduling.resource.ResourceServiceInterface

All Implemented Interfaces:

Constants

public class ResourceServiceInterface
extends java.lang.Object
implements Constants

implementation of wrapping interface to RS interface methods

Version:

$Id$

Author:

tbe

Field Summary

Fields inherited from interface org.yawlfoundation.yawl.scheduling.Constants

ADDRESS_TYPE_EMAIL, ADDRESS_TYPE_IP, ADDRESS_TYPE_SMS, CSS_BOOLEANINPUT, CSS_DATEINPUT, CSS_DURATIONINPUT, CSS_ERRORINPUT, CSS_ERRORTEXT, CSS_INTINPUT, CSS_REQUIRED, CSS_TEXTINPUT, CSS_WARNINGINPUT, CSS_WARNINGTEXT, CSV_DELIMITER, DELIMITER, LANGUAGE_ATTRIBUTE_NAME, LANGUAGE_DEFAULT, LANGUAGES, MSGREL_AFTER, MSGREL_BEFORE, RESOURCE_STATUS_AVAILABLE, RESOURCE_STATUS_NOTAVAILABLE, RESOURCE_STATUS_REQUESTED, RESOURCE_STATUS_RESERVED, RESOURCE_STATUS_UNCHECKED, RESOURCE_STATUS_UNKNOWN, UTILISATION_TYPE_BEGIN, UTILISATION_TYPE_END, UTILISATION_TYPE_PLAN, WORD_SEPARATORS, XML_ACTIVITY, XML_ACTIVITYNAME, XML_ACTIVITYTYPE, XML_ADDRESS, XML_ADDRESSTYPE, XML_CAPABILITY, XML_CASEID, XML_CATEGORY, XML_CHANNEL, XML_DUMMY, XML_DURATION, XML_ENDTASKID, XML_ERROR, XML_EVENT_RECEIVE, XML_FILTERMODEL, XML_FROM, XML_ID, XML_MAX, XML_MESSAGE_SEND, XML_MESSAGEPUSH_SEND, XML_MESSAGES, XML_MIN, XML_MSGBODY, XML_MSGDURATION, XML_MSGREL, XML_MSGTO, XML_MSGTRANSFER, XML_MSGUTILISATIONTYPE, XML_OTHERACTIVITYNAME, XML_OTHERUTILISATIONTYPE, XML_PAYLOAD, XML_REQUESTTYPE, XML_RESCHEDULING, XML_RESERVATION, XML_RESERVATIONID, XML_RESOURCE, XML_RESOURCE_TYPE, XML_ROLE, XML_RUP, XML_RUP_LIGHT, XML_STARTTASKID, XML_STATUS, XML_STATUSTOBE, XML_SUBCATEGORY, XML_TEXT, XML_THISUTILISATIONTYPE, XML_TIMESTAMP, XML_TO, XML_UNIT, XML_UTILISATION, XML_UTILISATION_TYPE, XML_UTILISATIONREL, XML_UTILISATIONTYPE, XML_WARNING, XML_WORKLOAD, XSDDatatypes_Boolean, XSDDatatypes_DateTime, XSDDatatypes_Double, XSDDatatypes_Duration, XSDDatatypes_Int, XSDDatatypes_Long, XSDDatatypes_String

Method Summary

Modifier and Type	Method and Description
void	addReservations(Document rup, java.util.Map<java.lang.String,java.util.List<Element>> res)
boolean	checkConnection(java.lang.String handle)
java.util.List<Element>	getAvailabilities(Element resource, java.util.Date from, java.util.Date to) return list of available timeslots between given period for each resource, matching given resource string
java.lang.String	getCaseData(java.lang.String caseID)
java.util.Map<java.lang.String,java.lang.Object>	getDropdownContent(java.lang.String objectName, java.lang.String prevFieldValue) not used
java.lang.String	getFullNameForUserID(java.lang.String userID)
java.lang.String	getHandle()
static ResourceServiceInterface	getInstance()
java.util.List<NonHumanCategory>	getNonHumanCategories()
NonHumanCategory	getNonHumanCategory(java.lang.String catID)
NonHumanResource	getNonHumanResource(java.lang.String resID)
java.util.List<NonHumanResource>	getNonHumanResources()
Participant	getParticipant(java.lang.String pID)
java.util.List<Capability>	getParticipantCapabilities(java.lang.String cid)
java.util.List<Role>	getParticipantRoles(java.lang.String pid)
java.util.List<Participant>	getParticipants()
Role	getRole(java.lang.String roleID)
java.util.Map<java.lang.String,java.lang.String>	getRoleIdentifiers()
java.lang.String	getUserName(java.lang.String handle)
java.lang.String	getUserSessionHandle(java.lang.String userID, java.lang.String password)
java.lang.String	getWorkItem(java.lang.String itemID, java.lang.String handle)
boolean	isValidSession(java.lang.String userID, java.lang.String handle)
boolean	isValidUserSession(java.lang.String handle)
java.lang.String	registerCalendarStatusChangeListener(java.lang.String uri)
java.util.Map<java.lang.String,java.util.List<Element>>	removeReservations(Document rup, java.lang.String statusToBe)
Document	saveReservations(Document rup, boolean checkOnly, boolean resourceChange) Saves all reservation XML elements of the ResourceUtilisationPlan, depending on "reservation.planningStatus" (see rup.xsd for the XML data model) and removes or updates older reservations for the case and for each activity.
java.lang.String	updateWorkItemData(java.lang.String itemID, java.lang.String data, java.lang.String handle)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ResourceServiceInterface getInstance()

getHandle

public java.lang.String getHandle()
                           throws java.io.IOException

Throws:

java.io.IOException

getAvailabilities

public java.util.List<Element> getAvailabilities(Element resource,
                                                 java.util.Date from,
                                                 java.util.Date to)
                                          throws YAWLException,
                                                 java.io.IOException

return list of available timeslots between given period for each resource, matching given resource string

Parameters:

resource -

from -

to -

Returns:

list of timeslots

Throws:

YAWLException

java.io.IOException

getDropdownContent

public java.util.Map<java.lang.String,java.lang.Object> getDropdownContent(java.lang.String objectName,
                                                                           java.lang.String prevFieldValue)
                                                                    throws ResourceGatewayException,
                                                                           java.io.IOException

not used

Throws:

ResourceGatewayException

java.io.IOException

saveReservations

public Document saveReservations(Document rup,
                                 boolean checkOnly,
                                 boolean resourceChange)
                          throws ResourceGatewayException,
                                 JDOMException,
                                 java.io.IOException

Saves all reservation XML elements of the ResourceUtilisationPlan, depending on "reservation.planningStatus" (see rup.xsd for the XML data model) and removes or updates older reservations for the case and for each activity. Then sets planning status and error or warning values on XML elements (e.g. if a resource cannot be reserved or technical errors occur) and returns the ResourceUtilisationPlan.

Parameters:

rup -

checkOnly -

resourceChange -

Throws:

ResourceGatewayException

JDOMException

java.io.IOException

removeReservations

public java.util.Map<java.lang.String,java.util.List<Element>> removeReservations(Document rup,
                                                                                  java.lang.String statusToBe)
                                                                           throws JDOMException

Throws:

JDOMException

addReservations

public void addReservations(Document rup,
                            java.util.Map<java.lang.String,java.util.List<Element>> res)
                     throws JDOMException

Throws:

JDOMException

getParticipants

public java.util.List<Participant> getParticipants()
                                            throws java.io.IOException,
                                                   ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getParticipantRoles

public java.util.List<Role> getParticipantRoles(java.lang.String pid)
                                         throws java.io.IOException,
                                                ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getParticipantCapabilities

public java.util.List<Capability> getParticipantCapabilities(java.lang.String cid)
                                                      throws java.io.IOException,
                                                             ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getNonHumanResources

public java.util.List<NonHumanResource> getNonHumanResources()
                                                      throws java.io.IOException,
                                                             ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getRole

public Role getRole(java.lang.String roleID)
             throws java.io.IOException,
                    ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getParticipant

public Participant getParticipant(java.lang.String pID)
                           throws java.io.IOException,
                                  ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getNonHumanResource

public NonHumanResource getNonHumanResource(java.lang.String resID)
                                     throws java.io.IOException,
                                            ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getNonHumanCategory

public NonHumanCategory getNonHumanCategory(java.lang.String catID)
                                     throws java.io.IOException,
                                            ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getNonHumanCategories

public java.util.List<NonHumanCategory> getNonHumanCategories()
                                                       throws java.io.IOException,
                                                              ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getRoleIdentifiers

public java.util.Map<java.lang.String,java.lang.String> getRoleIdentifiers()
                                                                    throws java.io.IOException,
                                                                           ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

checkConnection

public boolean checkConnection(java.lang.String handle)

registerCalendarStatusChangeListener

public java.lang.String registerCalendarStatusChangeListener(java.lang.String uri)
                                                      throws java.io.IOException

Throws:

java.io.IOException

getCaseData

public java.lang.String getCaseData(java.lang.String caseID)
                             throws java.io.IOException

Throws:

java.io.IOException

isValidUserSession

public boolean isValidUserSession(java.lang.String handle)
                           throws java.io.IOException

Throws:

java.io.IOException

getWorkItem

public java.lang.String getWorkItem(java.lang.String itemID,
                                    java.lang.String handle)
                             throws java.io.IOException,
                                    ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

updateWorkItemData

public java.lang.String updateWorkItemData(java.lang.String itemID,
                                           java.lang.String data,
                                           java.lang.String handle)
                                    throws java.io.IOException,
                                           ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getFullNameForUserID

public java.lang.String getFullNameForUserID(java.lang.String userID)
                                      throws java.io.IOException,
                                             ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

isValidSession

public boolean isValidSession(java.lang.String userID,
                              java.lang.String handle)
                       throws java.io.IOException

Throws:

java.io.IOException

getUserSessionHandle

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

Throws:

java.io.IOException

getUserName

public java.lang.String getUserName(java.lang.String handle)
                             throws java.io.IOException,
                                    ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException