org.yawlfoundation.yawl.resourcing.rsInterface
Class ResourceLogGatewayClient

java.lang.Object
  extended by org.yawlfoundation.yawl.engine.interfce.Interface_Client
      extended by org.yawlfoundation.yawl.resourcing.rsInterface.ResourceLogGatewayClient

public class ResourceLogGatewayClient
extends Interface_Client

An API to be used by clients that want to retrieve data from the resource service process logs.

Author:
Michael Adams 03/02/2010

Constructor Summary
ResourceLogGatewayClient(String uri)
          the only constructor
 
Method Summary
 String checkConnection(String handle)
          Checks if a sessionhandle is active
 String connect(String userID, String password)
          Connects an external entity to the resource service
 String getAllResourceEvents(String handle)
          Gets an xml list of all the resource events logged
 String getCaseEvent(String caseID, boolean launch, String handle)
          Gets an xml record of the logged case launch or cancel event
 String getCaseEvents(String caseID, Date dateFrom, Date dateTo, String handle)
          Gets an summary xml list of all the logged events for a case within the time range specified
 String getCaseEvents(String caseID, long from, long to, String handle)
          Gets an summary xml list of all the logged events for a case within the time range specified
 String getCaseEvents(String caseID, String handle)
          Gets an summary xml list of all the logged events for a case
 String getCaseHistoryInvolvingParticipant(String pid, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all case events for all cases in which the specified participant had some involvement within the time range specified
 String getCaseHistoryInvolvingParticipant(String pid, long from, long to, String handle)
          Gets an xml list of all case events for all cases in which the specified participant had some involvement within the time range specified
 String getCaseHistoryInvolvingParticipant(String pid, String handle)
          Gets an xml list of all case events for all cases in which the specified participant had some involvement
 String getCaseStartedBy(String caseID, String handle)
          Gets an summary xml list of all the specifications logged
 String getMergedXESLog(String identifier, String version, String uri, boolean withData, String handle)
          Gets all events for all cases of the specification passed, from both the resource service and the engine, merged together, optionally including the data value changes from the engine's log
 String getMergedXESLog(String identifier, String version, String uri, String handle)
          Gets all events for all cases of the specification passed, from both the resource service and the engine, merged together
 String getParticipantHistory(String pid, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all work item events involving the specified participant within the time range specified
 String getParticipantHistory(String pid, long from, long to, String handle)
          Gets an xml list of all work item events involving the specified participant within the time range specified
 String getParticipantHistory(String pid, String handle)
          Gets an xml list of all work item events involving the specified participant
 String getParticipantHistoryForEvent(String pid, String eventName, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all instances of the specified event involving the specified participant within the time range specified
 String getParticipantHistoryForEvent(String pid, String eventName, long from, long to, String handle)
          Gets an xml list of all instances of the specified event involving the specified participant within the time range specified
 String getParticipantHistoryForEvent(String pid, String eventName, String handle)
          Gets an xml list of all instances of the specified event involving the specified participant
 String getResourceHistory(String id, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all work item events involving the specified resource within the time range specified (can be a Participant or a NonHumanResource)
 String getResourceHistory(String id, long from, long to, String handle)
          Gets an xml list of all work item events involving the specified resource within the time range specified (can be a Participant or a NonHumanResource)
 String getResourceHistory(String id, String handle)
          Gets an xml list of all work item events involving the specified resource (can be a Participant or a NonHumanResource)
 String getResourceHistoryForEvent(String id, String eventName, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all instances of the specified event involving the specified participant within the time range specified
 String getResourceHistoryForEvent(String id, String eventName, long from, long to, String handle)
          Gets an xml list of all instances of the specified event involving the specified resource within the time range specified (can be a Participant or a NonHumanResource)
 String getResourceHistoryForEvent(String id, String eventName, String handle)
          Gets an xml list of all instances of the specified event involving the specified resource (can be a Participant or a NonHumanResource)
 String getSpecificationEvents(Set<YSpecificationID> specIDs, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all case events for all case instances of all the specifications in a Set
 String getSpecificationEvents(Set<YSpecificationID> specIDs, long from, long to, String handle)
          Gets an xml list of all case events for all case instances of all the specifications in a Set
 String getSpecificationEvents(Set<YSpecificationID> specIDs, String handle)
          Gets an xml list of all case events for all case instances of all the specifications in a Set
 String getSpecificationEvents(String identifier, String version, String uri, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all case events for all case instances of a specification
 String getSpecificationEvents(String identifier, String version, String uri, long from, long to, String handle)
          Gets an xml list of all case events for all case instances of a specification
 String getSpecificationEvents(String identifier, String version, String uri, String handle)
          Gets an xml list of all case events for all case instances of a specification
 String getSpecificationEvents(YSpecificationID specID, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all case events for all case instances of a specification
 String getSpecificationEvents(YSpecificationID specID, long from, long to, String handle)
          Gets an xml list of all case events for all case instances of a specification
 String getSpecificationEvents(YSpecificationID specID, String handle)
          Gets an xml list of all case events for all case instances of a specification
 String getSpecificationEventsByID(String id, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all case events for all case instances of all the specifications with a matching identifier
 String getSpecificationEventsByID(String id, long from, long to, String handle)
          Gets an xml list of all case events for all case instances of all the specifications with a matching identifier
 String getSpecificationEventsByID(String id, String handle)
          Gets an xml list of all case events for all case instances of all the specifications with a matching identifier
 String getSpecificationEventsByURI(String uri, Date dateFrom, Date dateTo, String handle)
          Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)
 String getSpecificationEventsByURI(String uri, long from, long to, String handle)
          Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)
 String getSpecificationEventsByURI(String uri, String handle)
          Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)
 String getSpecificationIdentifiers(long key, String handle)
          Gets an xml string of the YSpecificationID for a specification key (returned in the xml of one of the other log methods)
 String getSpecificationStatistics(String identifier, String version, String uri, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all case instances of a specification
 String getSpecificationStatistics(String identifier, String version, String uri, long from, long to, String handle)
          Gets a summary set of statistics for all case instances of a specification
 String getSpecificationStatistics(String identifier, String version, String uri, String handle)
          Gets a summary set of statistics for all case instances of a specification
 String getSpecificationStatistics(YSpecificationID specID, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all case instances of a specification
 String getSpecificationStatistics(YSpecificationID specID, long from, long to, String handle)
          Gets a summary set of statistics for all case instances of a specification
 String getSpecificationStatistics(YSpecificationID specID, String handle)
          Gets a summary set of statistics for all case instances of a specification
 String getSpecificationXESLog(String identifier, String version, String uri, String handle)
          Gets all events for all cases of the specification passed
 String getTaskStatistics(String identifier, String version, String uri, String taskName, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all instances of a specified task
 String getTaskStatistics(String identifier, String version, String uri, String taskName, long from, long to, String handle)
          Gets a summary set of statistics for all instances of a specified task
 String getTaskStatistics(String identifier, String version, String uri, String taskName, String handle)
          Gets a summary set of statistics for all instances of a specified task
 String getTaskStatistics(YSpecificationID specID, String taskName, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all instances of a specified task
 String getTaskStatistics(YSpecificationID specID, String taskName, long from, long to, String handle)
          Gets a summary set of statistics for all instances of a specified task
 String getTaskStatistics(YSpecificationID specID, String taskName, String handle)
          Gets a summary set of statistics for all instances of a specified task
 String getTaskStatisticsForCase(String caseID, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all task instances of a specified case
 String getTaskStatisticsForCase(String caseID, long from, long to, String handle)
          Gets a summary set of statistics for all task instances of a specified case
 String getTaskStatisticsForCase(String caseID, String handle)
          Gets a summary set of statistics for all task instances of a specified case
 String getTaskStatisticsForSpecification(Set<YSpecificationID> specIDs, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all task instances of all the specifications in a Set
 String getTaskStatisticsForSpecification(Set<YSpecificationID> specIDs, long from, long to, String handle)
          Gets a summary set of statistics for all task instances of all the specifications in a Set
 String getTaskStatisticsForSpecification(Set<YSpecificationID> specIDs, String handle)
          Gets a summary set of statistics for all task instances of all the specifications in a Set
 String getTaskStatisticsForSpecification(String identifier, String version, String uri, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all task instances of a specified specification
 String getTaskStatisticsForSpecification(String identifier, String version, String uri, long from, long to, String handle)
          Gets a summary set of statistics for all task instances of a specified specification
 String getTaskStatisticsForSpecification(String identifier, String version, String uri, String handle)
          Gets a summary set of statistics for all task instances of a specified specification
 String getTaskStatisticsForSpecification(YSpecificationID specID, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all task instances of a specified specification
 String getTaskStatisticsForSpecification(YSpecificationID specID, long from, long to, String handle)
          Gets a summary set of statistics for all task instances of a specified specification
 String getTaskStatisticsForSpecification(YSpecificationID specID, String handle)
          Gets a summary set of statistics for all task instances of a specified specification
 String getTaskStatisticsForSpecificationUID(String id, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all task instances of all the specifications with a matching identifier
 String getTaskStatisticsForSpecificationUID(String id, long from, long to, String handle)
          Gets a summary set of statistics for all task instances of all the specifications with a matching identifier
 String getTaskStatisticsForSpecificationUID(String id, String handle)
          Gets a summary set of statistics for all task instances of all the specifications with a matching identifier
 String getTaskStatisticsForSpecificationURI(String uri, Date dateFrom, Date dateTo, String handle)
          Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)
 String getTaskStatisticsForSpecificationURI(String uri, long from, long to, String handle)
          Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)
 String getTaskStatisticsForSpecificationURI(String uri, String handle)
          Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)
 String getWorkItemAllocated(String itemID, String handle)
          Gets an xml string of the 'allocate' event for the specified work item
 String getWorkItemEvents(String itemID, boolean fullName, Date dateFrom, Date dateTo, String handle)
          Gets an summary xml list of all logged events for a workitem within the time range specified
 String getWorkItemEvents(String itemID, boolean fullName, long from, long to, String handle)
          Gets an summary xml list of all logged events for a workitem within the time range specified
 String getWorkItemEvents(String itemID, boolean fullName, String handle)
          Gets an summary xml list of all logged events for a workitem
 String getWorkItemOffered(String itemID, String handle)
          Gets an xml list of all 'offer' events for the specified work item
 String getWorkItemStarted(String itemID, String handle)
          Gets an xml string of the 'start' event for the specified work item
 
Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client
executeGet, executePost, prepareParamMap, setReadTimeout, stripOuterElement, successful
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceLogGatewayClient

public ResourceLogGatewayClient(String uri)
the only constructor

Parameters:
uri - the uri of the YAWL Resource Service's log gateway
Method Detail

getAllResourceEvents

public String getAllResourceEvents(String handle)
                            throws IOException
Gets an xml list of all the resource events logged

Parameters:
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseStartedBy

public String getCaseStartedBy(String caseID,
                               String handle)
                        throws IOException
Gets an summary xml list of all the specifications logged

Parameters:
caseID - the case id
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseEvents

public String getCaseEvents(String caseID,
                            String handle)
                     throws IOException
Gets an summary xml list of all the logged events for a case

Parameters:
caseID - the case id
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseEvents

public String getCaseEvents(String caseID,
                            long from,
                            long to,
                            String handle)
                     throws IOException
Gets an summary xml list of all the logged events for a case within the time range specified

Parameters:
caseID - the case id
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseEvents

public String getCaseEvents(String caseID,
                            Date dateFrom,
                            Date dateTo,
                            String handle)
                     throws IOException
Gets an summary xml list of all the logged events for a case within the time range specified

Parameters:
caseID - the case id
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseEvent

public String getCaseEvent(String caseID,
                           boolean launch,
                           String handle)
                    throws IOException
Gets an xml record of the logged case launch or cancel event

Parameters:
caseID - the case id
launch - true for the launch_case event, false for the cancel_case event
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getWorkItemEvents

public String getWorkItemEvents(String itemID,
                                boolean fullName,
                                String handle)
                         throws IOException
Gets an summary xml list of all logged events for a workitem

Parameters:
itemID - the workitem's id string
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getWorkItemEvents

public String getWorkItemEvents(String itemID,
                                boolean fullName,
                                long from,
                                long to,
                                String handle)
                         throws IOException
Gets an summary xml list of all logged events for a workitem within the time range specified

Parameters:
itemID - the workitem's id string
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getWorkItemEvents

public String getWorkItemEvents(String itemID,
                                boolean fullName,
                                Date dateFrom,
                                Date dateTo,
                                String handle)
                         throws IOException
Gets an summary xml list of all logged events for a workitem within the time range specified

Parameters:
itemID - the workitem's id string
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getParticipantHistory

public String getParticipantHistory(String pid,
                                    String handle)
                             throws IOException
Gets an xml list of all work item events involving the specified participant

Parameters:
pid - the participant identifier
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getParticipantHistory

public String getParticipantHistory(String pid,
                                    long from,
                                    long to,
                                    String handle)
                             throws IOException
Gets an xml list of all work item events involving the specified participant within the time range specified

Parameters:
pid - the participant identifier
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getParticipantHistory

public String getParticipantHistory(String pid,
                                    Date dateFrom,
                                    Date dateTo,
                                    String handle)
                             throws IOException
Gets an xml list of all work item events involving the specified participant within the time range specified

Parameters:
pid - the participant identifier
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getResourceHistory

public String getResourceHistory(String id,
                                 String handle)
                          throws IOException
Gets an xml list of all work item events involving the specified resource (can be a Participant or a NonHumanResource)

Parameters:
id - the resource identifier
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getResourceHistory

public String getResourceHistory(String id,
                                 long from,
                                 long to,
                                 String handle)
                          throws IOException
Gets an xml list of all work item events involving the specified resource within the time range specified (can be a Participant or a NonHumanResource)

Parameters:
id - the resource identifier
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getResourceHistory

public String getResourceHistory(String id,
                                 Date dateFrom,
                                 Date dateTo,
                                 String handle)
                          throws IOException
Gets an xml list of all work item events involving the specified resource within the time range specified (can be a Participant or a NonHumanResource)

Parameters:
id - the resource identifier
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getParticipantHistoryForEvent

public String getParticipantHistoryForEvent(String pid,
                                            String eventName,
                                            String handle)
                                     throws IOException
Gets an xml list of all instances of the specified event involving the specified participant

Parameters:
pid - the participant identifier
eventName - a String matching one of the EventLogger events (offer, allocate, start, reallocate and so on)
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getParticipantHistoryForEvent

public String getParticipantHistoryForEvent(String pid,
                                            String eventName,
                                            long from,
                                            long to,
                                            String handle)
                                     throws IOException
Gets an xml list of all instances of the specified event involving the specified participant within the time range specified

Parameters:
pid - the participant identifier
eventName - a String matching one of the EventLogger events (offer, allocate, start, reallocate and so on)
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getParticipantHistoryForEvent

public String getParticipantHistoryForEvent(String pid,
                                            String eventName,
                                            Date dateFrom,
                                            Date dateTo,
                                            String handle)
                                     throws IOException
Gets an xml list of all instances of the specified event involving the specified participant within the time range specified

Parameters:
pid - the participant identifier
eventName - a String matching one of the EventLogger events (offer, allocate, start, reallocate and so on)
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getResourceHistoryForEvent

public String getResourceHistoryForEvent(String id,
                                         String eventName,
                                         String handle)
                                  throws IOException
Gets an xml list of all instances of the specified event involving the specified resource (can be a Participant or a NonHumanResource)

Parameters:
id - the resource identifier
eventName - a String matching one of the EventLogger events (offer, allocate, start, reallocate and so on)
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getResourceHistoryForEvent

public String getResourceHistoryForEvent(String id,
                                         String eventName,
                                         long from,
                                         long to,
                                         String handle)
                                  throws IOException
Gets an xml list of all instances of the specified event involving the specified resource within the time range specified (can be a Participant or a NonHumanResource)

Parameters:
id - the resource identifier
eventName - a String matching one of the EventLogger events (offer, allocate, start, reallocate and so on)
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getResourceHistoryForEvent

public String getResourceHistoryForEvent(String id,
                                         String eventName,
                                         Date dateFrom,
                                         Date dateTo,
                                         String handle)
                                  throws IOException
Gets an xml list of all instances of the specified event involving the specified participant within the time range specified

Parameters:
id - the participant identifier
eventName - a String matching one of the EventLogger events (offer, allocate, start, reallocate and so on)
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getWorkItemOffered

public String getWorkItemOffered(String itemID,
                                 String handle)
                          throws IOException
Gets an xml list of all 'offer' events for the specified work item

Parameters:
itemID - the work item identifier
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getWorkItemAllocated

public String getWorkItemAllocated(String itemID,
                                   String handle)
                            throws IOException
Gets an xml string of the 'allocate' event for the specified work item

Parameters:
itemID - the work item identifier
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getWorkItemStarted

public String getWorkItemStarted(String itemID,
                                 String handle)
                          throws IOException
Gets an xml string of the 'start' event for the specified work item

Parameters:
itemID - the work item identifier
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseHistoryInvolvingParticipant

public String getCaseHistoryInvolvingParticipant(String pid,
                                                 String handle)
                                          throws IOException
Gets an xml list of all case events for all cases in which the specified participant had some involvement

Parameters:
pid - the identifier of the participant
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseHistoryInvolvingParticipant

public String getCaseHistoryInvolvingParticipant(String pid,
                                                 long from,
                                                 long to,
                                                 String handle)
                                          throws IOException
Gets an xml list of all case events for all cases in which the specified participant had some involvement within the time range specified

Parameters:
pid - the identifier of the participant
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getCaseHistoryInvolvingParticipant

public String getCaseHistoryInvolvingParticipant(String pid,
                                                 Date dateFrom,
                                                 Date dateTo,
                                                 String handle)
                                          throws IOException
Gets an xml list of all case events for all cases in which the specified participant had some involvement within the time range specified

Parameters:
pid - the identifier of the participant
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(String identifier,
                                     String version,
                                     String uri,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of a specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(String identifier,
                                     String version,
                                     String uri,
                                     long from,
                                     long to,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of a specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(String identifier,
                                     String version,
                                     String uri,
                                     Date dateFrom,
                                     Date dateTo,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of a specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(YSpecificationID specID,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of a specification

Parameters:
specID - the specification identifier
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(YSpecificationID specID,
                                     long from,
                                     long to,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of a specification

Parameters:
specID - the specification identifier
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(YSpecificationID specID,
                                     Date dateFrom,
                                     Date dateTo,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of a specification

Parameters:
specID - the specification identifier
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(Set<YSpecificationID> specIDs,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of all the specifications in a Set

Parameters:
specIDs - the set of specification identifiers
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(Set<YSpecificationID> specIDs,
                                     long from,
                                     long to,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of all the specifications in a Set

Parameters:
specIDs - the set of specification identifiers
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEvents

public String getSpecificationEvents(Set<YSpecificationID> specIDs,
                                     Date dateFrom,
                                     Date dateTo,
                                     String handle)
                              throws IOException
Gets an xml list of all case events for all case instances of all the specifications in a Set

Parameters:
specIDs - the set of specification identifiers
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEventsByURI

public String getSpecificationEventsByURI(String uri,
                                          String handle)
                                   throws IOException
Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)

Parameters:
uri - the uri or name of the specification
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEventsByURI

public String getSpecificationEventsByURI(String uri,
                                          long from,
                                          long to,
                                          String handle)
                                   throws IOException
Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)

Parameters:
uri - the uri or name of the specification
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEventsByURI

public String getSpecificationEventsByURI(String uri,
                                          Date dateFrom,
                                          Date dateTo,
                                          String handle)
                                   throws IOException
Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)

Parameters:
uri - the uri or name of the specification
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEventsByID

public String getSpecificationEventsByID(String id,
                                         String handle)
                                  throws IOException
Gets an xml list of all case events for all case instances of all the specifications with a matching identifier

Parameters:
id - the unique identifier of the specification
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEventsByID

public String getSpecificationEventsByID(String id,
                                         long from,
                                         long to,
                                         String handle)
                                  throws IOException
Gets an xml list of all case events for all case instances of all the specifications with a matching identifier

Parameters:
id - the unique identifier of the specification
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationEventsByID

public String getSpecificationEventsByID(String id,
                                         Date dateFrom,
                                         Date dateTo,
                                         String handle)
                                  throws IOException
Gets an xml list of all case events for all case instances of all the specifications with a matching identifier

Parameters:
id - the unique identifier of the specification
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatistics

public String getTaskStatistics(YSpecificationID specID,
                                String taskName,
                                String handle)
                         throws IOException
Gets a summary set of statistics for all instances of a specified task

Parameters:
specID - the specification identifier that contains the task
taskName - the name of the task
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatistics

public String getTaskStatistics(YSpecificationID specID,
                                String taskName,
                                long from,
                                long to,
                                String handle)
                         throws IOException
Gets a summary set of statistics for all instances of a specified task

Parameters:
specID - the specification identifier that contains the task
taskName - the name of the task
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatistics

public String getTaskStatistics(YSpecificationID specID,
                                String taskName,
                                Date dateFrom,
                                Date dateTo,
                                String handle)
                         throws IOException
Gets a summary set of statistics for all instances of a specified task

Parameters:
specID - the specification identifier that contains the task
taskName - the name of the task
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatistics

public String getTaskStatistics(String identifier,
                                String version,
                                String uri,
                                String taskName,
                                String handle)
                         throws IOException
Gets a summary set of statistics for all instances of a specified task

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
taskName - the name of the task
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatistics

public String getTaskStatistics(String identifier,
                                String version,
                                String uri,
                                String taskName,
                                Date dateFrom,
                                Date dateTo,
                                String handle)
                         throws IOException
Gets a summary set of statistics for all instances of a specified task

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
taskName - the name of the task
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatistics

public String getTaskStatistics(String identifier,
                                String version,
                                String uri,
                                String taskName,
                                long from,
                                long to,
                                String handle)
                         throws IOException
Gets a summary set of statistics for all instances of a specified task

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
taskName - the name of the task
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForCase

public String getTaskStatisticsForCase(String caseID,
                                       String handle)
                                throws IOException
Gets a summary set of statistics for all task instances of a specified case

Parameters:
caseID - the id of the case
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForCase

public String getTaskStatisticsForCase(String caseID,
                                       Date dateFrom,
                                       Date dateTo,
                                       String handle)
                                throws IOException
Gets a summary set of statistics for all task instances of a specified case

Parameters:
caseID - the id of the case
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForCase

public String getTaskStatisticsForCase(String caseID,
                                       long from,
                                       long to,
                                       String handle)
                                throws IOException
Gets a summary set of statistics for all task instances of a specified case

Parameters:
caseID - the id of the case
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(YSpecificationID specID,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of a specified specification

Parameters:
specID - the specification identifier that contains the task
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(YSpecificationID specID,
                                                long from,
                                                long to,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of a specified specification

Parameters:
specID - the specification identifier that contains the task
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(YSpecificationID specID,
                                                Date dateFrom,
                                                Date dateTo,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of a specified specification

Parameters:
specID - the specification identifier that contains the task
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(String identifier,
                                                String version,
                                                String uri,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of a specified specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(String identifier,
                                                String version,
                                                String uri,
                                                Date dateFrom,
                                                Date dateTo,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of a specified specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(String identifier,
                                                String version,
                                                String uri,
                                                long from,
                                                long to,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of a specified specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(Set<YSpecificationID> specIDs,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of all the specifications in a Set

Parameters:
specIDs - the set of specification identifiers
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(Set<YSpecificationID> specIDs,
                                                long from,
                                                long to,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of all the specifications in a Set

Parameters:
specIDs - the set of specification identifiers
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public String getTaskStatisticsForSpecification(Set<YSpecificationID> specIDs,
                                                Date dateFrom,
                                                Date dateTo,
                                                String handle)
                                         throws IOException
Gets a summary set of statistics for all task instances of all the specifications in a Set

Parameters:
specIDs - the set of specification identifiers
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationURI

public String getTaskStatisticsForSpecificationURI(String uri,
                                                   String handle)
                                            throws IOException
Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)

Parameters:
uri - the uri or name of the specification
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationURI

public String getTaskStatisticsForSpecificationURI(String uri,
                                                   long from,
                                                   long to,
                                                   String handle)
                                            throws IOException
Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)

Parameters:
uri - the uri or name of the specification
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationURI

public String getTaskStatisticsForSpecificationURI(String uri,
                                                   Date dateFrom,
                                                   Date dateTo,
                                                   String handle)
                                            throws IOException
Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)

Parameters:
uri - the uri or name of the specification
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationUID

public String getTaskStatisticsForSpecificationUID(String id,
                                                   String handle)
                                            throws IOException
Gets a summary set of statistics for all task instances of all the specifications with a matching identifier

Parameters:
id - the unique identifier of the specification
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationUID

public String getTaskStatisticsForSpecificationUID(String id,
                                                   long from,
                                                   long to,
                                                   String handle)
                                            throws IOException
Gets a summary set of statistics for all task instances of all the specifications with a matching identifier

Parameters:
id - the unique identifier of the specification
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationUID

public String getTaskStatisticsForSpecificationUID(String id,
                                                   Date dateFrom,
                                                   Date dateTo,
                                                   String handle)
                                            throws IOException
Gets a summary set of statistics for all task instances of all the specifications with a matching identifier

Parameters:
id - the unique identifier of the specification
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationStatistics

public String getSpecificationStatistics(YSpecificationID specID,
                                         String handle)
                                  throws IOException
Gets a summary set of statistics for all case instances of a specification

Parameters:
specID - the specification identifier
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationStatistics

public String getSpecificationStatistics(YSpecificationID specID,
                                         long from,
                                         long to,
                                         String handle)
                                  throws IOException
Gets a summary set of statistics for all case instances of a specification

Parameters:
specID - the specification identifier
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationStatistics

public String getSpecificationStatistics(YSpecificationID specID,
                                         Date dateFrom,
                                         Date dateTo,
                                         String handle)
                                  throws IOException
Gets a summary set of statistics for all case instances of a specification

Parameters:
specID - the specification identifier
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationStatistics

public String getSpecificationStatistics(String identifier,
                                         String version,
                                         String uri,
                                         String handle)
                                  throws IOException
Gets a summary set of statistics for all case instances of a specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationStatistics

public String getSpecificationStatistics(String identifier,
                                         String version,
                                         String uri,
                                         long from,
                                         long to,
                                         String handle)
                                  throws IOException
Gets a summary set of statistics for all case instances of a specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
from - the lower time range value
to - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationStatistics

public String getSpecificationStatistics(String identifier,
                                         String version,
                                         String uri,
                                         Date dateFrom,
                                         Date dateTo,
                                         String handle)
                                  throws IOException
Gets a summary set of statistics for all case instances of a specification

Parameters:
identifier - the unique specification identifier
version - the specification version
uri - the specification uri
dateFrom - the lower time range value
dateTo - the upper time range value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationIdentifiers

public String getSpecificationIdentifiers(long key,
                                          String handle)
                                   throws IOException
Gets an xml string of the YSpecificationID for a specification key (returned in the xml of one of the other log methods)

Parameters:
key - the specification key value
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getSpecificationXESLog

public String getSpecificationXESLog(String identifier,
                                     String version,
                                     String uri,
                                     String handle)
                              throws IOException
Gets all events for all cases of the specification passed

Parameters:
identifier - the unique identifier of the specification
version - the specification's version number
uri - the specification's uri
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getMergedXESLog

public String getMergedXESLog(String identifier,
                              String version,
                              String uri,
                              String handle)
                       throws IOException
Gets all events for all cases of the specification passed, from both the resource service and the engine, merged together

Parameters:
identifier - the unique identifier of the specification
version - the specification's version number
uri - the specification's uri
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

getMergedXESLog

public String getMergedXESLog(String identifier,
                              String version,
                              String uri,
                              boolean withData,
                              String handle)
                       throws IOException
Gets all events for all cases of the specification passed, from both the resource service and the engine, merged together, optionally including the data value changes from the engine's log

Parameters:
identifier - the unique identifier of the specification
version - the specification's version number
uri - the specification's uri
withData - if true, the data value changes in the engine log are included
handle - an active sessionhandle
Returns:
the resultant String response (log data or error message)
Throws:
IOException - if there's a problem connecting to the service

connect

public String connect(String userID,
                      String password)
               throws IOException
Connects an external entity to the resource service

Parameters:
userID - the userid
password - the password
Returns:
a sessionHandle if successful, or a failure message if not
Throws:
IOException - if there's a problem connecting to the service

checkConnection

public String checkConnection(String handle)
                       throws IOException
Checks if a sessionhandle is active

Parameters:
handle - the sessionhandle to check
Returns:
true if the session is alive, false if otherwise
Throws:
IOException - if there's a problem connecting to the service


Copyright © 2004-2012 The YAWL Foundation.