org.yawlfoundation.yawl.resourcing.rsInterface

Class ResourceLogGatewayClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

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

Constructors

Constructor and Description
ResourceLogGatewayClient(java.lang.String uri) the only constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkConnection(java.lang.String handle) Checks if a sessionhandle is active
java.lang.String	connect(java.lang.String userID, java.lang.String password) Connects an external entity to the resource service
java.lang.String	getAllResourceEvents(java.lang.String handle) Gets an xml list of all the resource events logged
java.lang.String	getCaseEvent(java.lang.String caseID, boolean launch, java.lang.String handle) Gets an xml record of the logged case launch or cancel event
java.lang.String	getCaseEvents(java.lang.String caseID, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an summary xml list of all the logged events for a case within the time range specified
java.lang.String	getCaseEvents(java.lang.String caseID, long from, long to, java.lang.String handle) Gets an summary xml list of all the logged events for a case within the time range specified
java.lang.String	getCaseEvents(java.lang.String caseID, java.lang.String handle) Gets an summary xml list of all the logged events for a case
java.lang.String	getCaseHistoryInvolvingParticipant(java.lang.String pid, java.util.Date dateFrom, java.util.Date dateTo, java.lang.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
java.lang.String	getCaseHistoryInvolvingParticipant(java.lang.String pid, long from, long to, java.lang.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
java.lang.String	getCaseHistoryInvolvingParticipant(java.lang.String pid, java.lang.String handle) Gets an xml list of all case events for all cases in which the specified participant had some involvement
java.lang.String	getCaseStartedBy(java.lang.String caseID, java.lang.String handle) Gets an summary xml list of all the specifications logged
java.lang.String	getMergedXESLog(java.lang.String identifier, java.lang.String version, java.lang.String uri, boolean withData, java.lang.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
java.lang.String	getMergedXESLog(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets all events for all cases of the specification passed, from both the resource service and the engine, merged together
java.lang.String	getParticipantHistory(java.lang.String pid, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all work item events involving the specified participant within the time range specified
java.lang.String	getParticipantHistory(java.lang.String pid, long from, long to, java.lang.String handle) Gets an xml list of all work item events involving the specified participant within the time range specified
java.lang.String	getParticipantHistory(java.lang.String pid, java.lang.String handle) Gets an xml list of all work item events involving the specified participant
java.lang.String	getParticipantHistoryForEvent(java.lang.String pid, java.lang.String eventName, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all instances of the specified event involving the specified participant within the time range specified
java.lang.String	getParticipantHistoryForEvent(java.lang.String pid, java.lang.String eventName, long from, long to, java.lang.String handle) Gets an xml list of all instances of the specified event involving the specified participant within the time range specified
java.lang.String	getParticipantHistoryForEvent(java.lang.String pid, java.lang.String eventName, java.lang.String handle) Gets an xml list of all instances of the specified event involving the specified participant
java.lang.String	getResourceHistory(java.lang.String id, java.util.Date dateFrom, java.util.Date dateTo, java.lang.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)
java.lang.String	getResourceHistory(java.lang.String id, long from, long to, java.lang.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)
java.lang.String	getResourceHistory(java.lang.String id, java.lang.String handle) Gets an xml list of all work item events involving the specified resource (can be a Participant or a NonHumanResource)
java.lang.String	getResourceHistoryForEvent(java.lang.String id, java.lang.String eventName, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all instances of the specified event involving the specified participant within the time range specified
java.lang.String	getResourceHistoryForEvent(java.lang.String id, java.lang.String eventName, long from, long to, java.lang.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)
java.lang.String	getResourceHistoryForEvent(java.lang.String id, java.lang.String eventName, java.lang.String handle) Gets an xml list of all instances of the specified event involving the specified resource (can be a Participant or a NonHumanResource)
java.lang.String	getSpecificationEvents(java.util.Set<YSpecificationID> specIDs, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications in a Set
java.lang.String	getSpecificationEvents(java.util.Set<YSpecificationID> specIDs, long from, long to, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications in a Set
java.lang.String	getSpecificationEvents(java.util.Set<YSpecificationID> specIDs, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications in a Set
java.lang.String	getSpecificationEvents(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all case events for all case instances of a specification
java.lang.String	getSpecificationEvents(java.lang.String identifier, java.lang.String version, java.lang.String uri, long from, long to, java.lang.String handle) Gets an xml list of all case events for all case instances of a specification
java.lang.String	getSpecificationEvents(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets an xml list of all case events for all case instances of a specification
java.lang.String	getSpecificationEvents(YSpecificationID specID, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all case events for all case instances of a specification
java.lang.String	getSpecificationEvents(YSpecificationID specID, long from, long to, java.lang.String handle) Gets an xml list of all case events for all case instances of a specification
java.lang.String	getSpecificationEvents(YSpecificationID specID, java.lang.String handle) Gets an xml list of all case events for all case instances of a specification
java.lang.String	getSpecificationEventsByID(java.lang.String id, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications with a matching identifier
java.lang.String	getSpecificationEventsByID(java.lang.String id, long from, long to, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications with a matching identifier
java.lang.String	getSpecificationEventsByID(java.lang.String id, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications with a matching identifier
java.lang.String	getSpecificationEventsByURI(java.lang.String uri, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)
java.lang.String	getSpecificationEventsByURI(java.lang.String uri, long from, long to, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)
java.lang.String	getSpecificationEventsByURI(java.lang.String uri, java.lang.String handle) Gets an xml list of all case events for all case instances of all the specifications with a matching URI (name)
java.lang.String	getSpecificationIdentifiers(long key, java.lang.String handle) Gets an xml string of the YSpecificationID for a specification key (returned in the xml of one of the other log methods)
java.lang.String	getSpecificationStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all case instances of a specification
java.lang.String	getSpecificationStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, long from, long to, java.lang.String handle) Gets a summary set of statistics for all case instances of a specification
java.lang.String	getSpecificationStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets a summary set of statistics for all case instances of a specification
java.lang.String	getSpecificationStatistics(YSpecificationID specID, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all case instances of a specification
java.lang.String	getSpecificationStatistics(YSpecificationID specID, long from, long to, java.lang.String handle) Gets a summary set of statistics for all case instances of a specification
java.lang.String	getSpecificationStatistics(YSpecificationID specID, java.lang.String handle) Gets a summary set of statistics for all case instances of a specification
java.lang.String	getSpecificationXESLog(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets all events for all cases of the specification passed
java.lang.String	getTaskStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String taskName, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all instances of a specified task
java.lang.String	getTaskStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String taskName, long from, long to, java.lang.String handle) Gets a summary set of statistics for all instances of a specified task
java.lang.String	getTaskStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String taskName, java.lang.String handle) Gets a summary set of statistics for all instances of a specified task
java.lang.String	getTaskStatistics(YSpecificationID specID, java.lang.String taskName, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all instances of a specified task
java.lang.String	getTaskStatistics(YSpecificationID specID, java.lang.String taskName, long from, long to, java.lang.String handle) Gets a summary set of statistics for all instances of a specified task
java.lang.String	getTaskStatistics(YSpecificationID specID, java.lang.String taskName, java.lang.String handle) Gets a summary set of statistics for all instances of a specified task
java.lang.String	getTaskStatisticsForCase(java.lang.String caseID, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified case
java.lang.String	getTaskStatisticsForCase(java.lang.String caseID, long from, long to, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified case
java.lang.String	getTaskStatisticsForCase(java.lang.String caseID, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified case
java.lang.String	getTaskStatisticsForSpecification(java.util.Set<YSpecificationID> specIDs, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications in a Set
java.lang.String	getTaskStatisticsForSpecification(java.util.Set<YSpecificationID> specIDs, long from, long to, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications in a Set
java.lang.String	getTaskStatisticsForSpecification(java.util.Set<YSpecificationID> specIDs, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications in a Set
java.lang.String	getTaskStatisticsForSpecification(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified specification
java.lang.String	getTaskStatisticsForSpecification(java.lang.String identifier, java.lang.String version, java.lang.String uri, long from, long to, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified specification
java.lang.String	getTaskStatisticsForSpecification(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified specification
java.lang.String	getTaskStatisticsForSpecification(YSpecificationID specID, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified specification
java.lang.String	getTaskStatisticsForSpecification(YSpecificationID specID, long from, long to, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified specification
java.lang.String	getTaskStatisticsForSpecification(YSpecificationID specID, java.lang.String handle) Gets a summary set of statistics for all task instances of a specified specification
java.lang.String	getTaskStatisticsForSpecificationUID(java.lang.String id, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications with a matching identifier
java.lang.String	getTaskStatisticsForSpecificationUID(java.lang.String id, long from, long to, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications with a matching identifier
java.lang.String	getTaskStatisticsForSpecificationUID(java.lang.String id, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications with a matching identifier
java.lang.String	getTaskStatisticsForSpecificationURI(java.lang.String uri, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)
java.lang.String	getTaskStatisticsForSpecificationURI(java.lang.String uri, long from, long to, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)
java.lang.String	getTaskStatisticsForSpecificationURI(java.lang.String uri, java.lang.String handle) Gets a summary set of statistics for all task instances of all the specifications with a matching URI (name)
java.lang.String	getWorkItemAllocated(java.lang.String itemID, java.lang.String handle) Gets an xml string of the 'allocate' event for the specified work item
java.lang.String	getWorkItemEvents(java.lang.String itemID, boolean fullName, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String handle) Gets an summary xml list of all logged events for a workitem within the time range specified
java.lang.String	getWorkItemEvents(java.lang.String itemID, boolean fullName, long from, long to, java.lang.String handle) Gets an summary xml list of all logged events for a workitem within the time range specified
java.lang.String	getWorkItemEvents(java.lang.String itemID, boolean fullName, java.lang.String handle) Gets an summary xml list of all logged events for a workitem
java.lang.String	getWorkItemOffered(java.lang.String itemID, java.lang.String handle) Gets an xml list of all 'offer' events for the specified work item
java.lang.String	getWorkItemStarted(java.lang.String itemID, java.lang.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, 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

ResourceLogGatewayClient

public ResourceLogGatewayClient(java.lang.String uri)

the only constructor

Parameters:

uri - the uri of the YAWL Resource Service's log gateway

Method Detail

getAllResourceEvents

public java.lang.String getAllResourceEvents(java.lang.String handle)
                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseStartedBy

public java.lang.String getCaseStartedBy(java.lang.String caseID,
                                         java.lang.String handle)
                                  throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseEvents

public java.lang.String getCaseEvents(java.lang.String caseID,
                                      java.lang.String handle)
                               throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseEvents

public java.lang.String getCaseEvents(java.lang.String caseID,
                                      long from,
                                      long to,
                                      java.lang.String handle)
                               throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseEvents

public java.lang.String getCaseEvents(java.lang.String caseID,
                                      java.util.Date dateFrom,
                                      java.util.Date dateTo,
                                      java.lang.String handle)
                               throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseEvent

public java.lang.String getCaseEvent(java.lang.String caseID,
                                     boolean launch,
                                     java.lang.String handle)
                              throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getWorkItemEvents

public java.lang.String getWorkItemEvents(java.lang.String itemID,
                                          boolean fullName,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getWorkItemEvents

public java.lang.String getWorkItemEvents(java.lang.String itemID,
                                          boolean fullName,
                                          long from,
                                          long to,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getWorkItemEvents

public java.lang.String getWorkItemEvents(java.lang.String itemID,
                                          boolean fullName,
                                          java.util.Date dateFrom,
                                          java.util.Date dateTo,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getParticipantHistory

public java.lang.String getParticipantHistory(java.lang.String pid,
                                              java.lang.String handle)
                                       throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getParticipantHistory

public java.lang.String getParticipantHistory(java.lang.String pid,
                                              long from,
                                              long to,
                                              java.lang.String handle)
                                       throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getParticipantHistory

public java.lang.String getParticipantHistory(java.lang.String pid,
                                              java.util.Date dateFrom,
                                              java.util.Date dateTo,
                                              java.lang.String handle)
                                       throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getResourceHistory

public java.lang.String getResourceHistory(java.lang.String id,
                                           java.lang.String handle)
                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getResourceHistory

public java.lang.String getResourceHistory(java.lang.String id,
                                           long from,
                                           long to,
                                           java.lang.String handle)
                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getResourceHistory

public java.lang.String getResourceHistory(java.lang.String id,
                                           java.util.Date dateFrom,
                                           java.util.Date dateTo,
                                           java.lang.String handle)
                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getParticipantHistoryForEvent

public java.lang.String getParticipantHistoryForEvent(java.lang.String pid,
                                                      java.lang.String eventName,
                                                      java.lang.String handle)
                                               throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getParticipantHistoryForEvent

public java.lang.String getParticipantHistoryForEvent(java.lang.String pid,
                                                      java.lang.String eventName,
                                                      long from,
                                                      long to,
                                                      java.lang.String handle)
                                               throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getParticipantHistoryForEvent

public java.lang.String getParticipantHistoryForEvent(java.lang.String pid,
                                                      java.lang.String eventName,
                                                      java.util.Date dateFrom,
                                                      java.util.Date dateTo,
                                                      java.lang.String handle)
                                               throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getResourceHistoryForEvent

public java.lang.String getResourceHistoryForEvent(java.lang.String id,
                                                   java.lang.String eventName,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getResourceHistoryForEvent

public java.lang.String getResourceHistoryForEvent(java.lang.String id,
                                                   java.lang.String eventName,
                                                   long from,
                                                   long to,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getResourceHistoryForEvent

public java.lang.String getResourceHistoryForEvent(java.lang.String id,
                                                   java.lang.String eventName,
                                                   java.util.Date dateFrom,
                                                   java.util.Date dateTo,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getWorkItemOffered

public java.lang.String getWorkItemOffered(java.lang.String itemID,
                                           java.lang.String handle)
                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getWorkItemAllocated

public java.lang.String getWorkItemAllocated(java.lang.String itemID,
                                             java.lang.String handle)
                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getWorkItemStarted

public java.lang.String getWorkItemStarted(java.lang.String itemID,
                                           java.lang.String handle)
                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseHistoryInvolvingParticipant

public java.lang.String getCaseHistoryInvolvingParticipant(java.lang.String pid,
                                                           java.lang.String handle)
                                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseHistoryInvolvingParticipant

public java.lang.String getCaseHistoryInvolvingParticipant(java.lang.String pid,
                                                           long from,
                                                           long to,
                                                           java.lang.String handle)
                                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getCaseHistoryInvolvingParticipant

public java.lang.String getCaseHistoryInvolvingParticipant(java.lang.String pid,
                                                           java.util.Date dateFrom,
                                                           java.util.Date dateTo,
                                                           java.lang.String handle)
                                                    throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(java.lang.String identifier,
                                               java.lang.String version,
                                               java.lang.String uri,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(java.lang.String identifier,
                                               java.lang.String version,
                                               java.lang.String uri,
                                               long from,
                                               long to,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(java.lang.String identifier,
                                               java.lang.String version,
                                               java.lang.String uri,
                                               java.util.Date dateFrom,
                                               java.util.Date dateTo,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(YSpecificationID specID,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(YSpecificationID specID,
                                               long from,
                                               long to,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(YSpecificationID specID,
                                               java.util.Date dateFrom,
                                               java.util.Date dateTo,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(java.util.Set<YSpecificationID> specIDs,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(java.util.Set<YSpecificationID> specIDs,
                                               long from,
                                               long to,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEvents

public java.lang.String getSpecificationEvents(java.util.Set<YSpecificationID> specIDs,
                                               java.util.Date dateFrom,
                                               java.util.Date dateTo,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEventsByURI

public java.lang.String getSpecificationEventsByURI(java.lang.String uri,
                                                    java.lang.String handle)
                                             throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEventsByURI

public java.lang.String getSpecificationEventsByURI(java.lang.String uri,
                                                    long from,
                                                    long to,
                                                    java.lang.String handle)
                                             throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEventsByURI

public java.lang.String getSpecificationEventsByURI(java.lang.String uri,
                                                    java.util.Date dateFrom,
                                                    java.util.Date dateTo,
                                                    java.lang.String handle)
                                             throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEventsByID

public java.lang.String getSpecificationEventsByID(java.lang.String id,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEventsByID

public java.lang.String getSpecificationEventsByID(java.lang.String id,
                                                   long from,
                                                   long to,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationEventsByID

public java.lang.String getSpecificationEventsByID(java.lang.String id,
                                                   java.util.Date dateFrom,
                                                   java.util.Date dateTo,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatistics

public java.lang.String getTaskStatistics(YSpecificationID specID,
                                          java.lang.String taskName,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatistics

public java.lang.String getTaskStatistics(YSpecificationID specID,
                                          java.lang.String taskName,
                                          long from,
                                          long to,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatistics

public java.lang.String getTaskStatistics(YSpecificationID specID,
                                          java.lang.String taskName,
                                          java.util.Date dateFrom,
                                          java.util.Date dateTo,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatistics

public java.lang.String getTaskStatistics(java.lang.String identifier,
                                          java.lang.String version,
                                          java.lang.String uri,
                                          java.lang.String taskName,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatistics

public java.lang.String getTaskStatistics(java.lang.String identifier,
                                          java.lang.String version,
                                          java.lang.String uri,
                                          java.lang.String taskName,
                                          java.util.Date dateFrom,
                                          java.util.Date dateTo,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatistics

public java.lang.String getTaskStatistics(java.lang.String identifier,
                                          java.lang.String version,
                                          java.lang.String uri,
                                          java.lang.String taskName,
                                          long from,
                                          long to,
                                          java.lang.String handle)
                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForCase

public java.lang.String getTaskStatisticsForCase(java.lang.String caseID,
                                                 java.lang.String handle)
                                          throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForCase

public java.lang.String getTaskStatisticsForCase(java.lang.String caseID,
                                                 java.util.Date dateFrom,
                                                 java.util.Date dateTo,
                                                 java.lang.String handle)
                                          throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForCase

public java.lang.String getTaskStatisticsForCase(java.lang.String caseID,
                                                 long from,
                                                 long to,
                                                 java.lang.String handle)
                                          throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(YSpecificationID specID,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(YSpecificationID specID,
                                                          long from,
                                                          long to,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(YSpecificationID specID,
                                                          java.util.Date dateFrom,
                                                          java.util.Date dateTo,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(java.lang.String identifier,
                                                          java.lang.String version,
                                                          java.lang.String uri,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(java.lang.String identifier,
                                                          java.lang.String version,
                                                          java.lang.String uri,
                                                          java.util.Date dateFrom,
                                                          java.util.Date dateTo,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(java.lang.String identifier,
                                                          java.lang.String version,
                                                          java.lang.String uri,
                                                          long from,
                                                          long to,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(java.util.Set<YSpecificationID> specIDs,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(java.util.Set<YSpecificationID> specIDs,
                                                          long from,
                                                          long to,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecification

public java.lang.String getTaskStatisticsForSpecification(java.util.Set<YSpecificationID> specIDs,
                                                          java.util.Date dateFrom,
                                                          java.util.Date dateTo,
                                                          java.lang.String handle)
                                                   throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationURI

public java.lang.String getTaskStatisticsForSpecificationURI(java.lang.String uri,
                                                             java.lang.String handle)
                                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationURI

public java.lang.String getTaskStatisticsForSpecificationURI(java.lang.String uri,
                                                             long from,
                                                             long to,
                                                             java.lang.String handle)
                                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationURI

public java.lang.String getTaskStatisticsForSpecificationURI(java.lang.String uri,
                                                             java.util.Date dateFrom,
                                                             java.util.Date dateTo,
                                                             java.lang.String handle)
                                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationUID

public java.lang.String getTaskStatisticsForSpecificationUID(java.lang.String id,
                                                             java.lang.String handle)
                                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationUID

public java.lang.String getTaskStatisticsForSpecificationUID(java.lang.String id,
                                                             long from,
                                                             long to,
                                                             java.lang.String handle)
                                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getTaskStatisticsForSpecificationUID

public java.lang.String getTaskStatisticsForSpecificationUID(java.lang.String id,
                                                             java.util.Date dateFrom,
                                                             java.util.Date dateTo,
                                                             java.lang.String handle)
                                                      throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(YSpecificationID specID,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(YSpecificationID specID,
                                                   long from,
                                                   long to,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(YSpecificationID specID,
                                                   java.util.Date dateFrom,
                                                   java.util.Date dateTo,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(java.lang.String identifier,
                                                   java.lang.String version,
                                                   java.lang.String uri,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(java.lang.String identifier,
                                                   java.lang.String version,
                                                   java.lang.String uri,
                                                   long from,
                                                   long to,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(java.lang.String identifier,
                                                   java.lang.String version,
                                                   java.lang.String uri,
                                                   java.util.Date dateFrom,
                                                   java.util.Date dateTo,
                                                   java.lang.String handle)
                                            throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationIdentifiers

public java.lang.String getSpecificationIdentifiers(long key,
                                                    java.lang.String handle)
                                             throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getSpecificationXESLog

public java.lang.String getSpecificationXESLog(java.lang.String identifier,
                                               java.lang.String version,
                                               java.lang.String uri,
                                               java.lang.String handle)
                                        throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getMergedXESLog

public java.lang.String getMergedXESLog(java.lang.String identifier,
                                        java.lang.String version,
                                        java.lang.String uri,
                                        java.lang.String handle)
                                 throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

getMergedXESLog

public java.lang.String getMergedXESLog(java.lang.String identifier,
                                        java.lang.String version,
                                        java.lang.String uri,
                                        boolean withData,
                                        java.lang.String handle)
                                 throws java.io.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:

java.io.IOException - if there's a problem connecting to the service

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 password

Returns:

a sessionHandle if successful, or a failure message if not

Throws:

java.io.IOException - if there's a problem connecting to the service

checkConnection

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

Checks if a sessionhandle is active

Parameters:

handle - the sessionhandle to check

Returns:

true if the session is alive, false if otherwise

Throws:

java.io.IOException - if there's a problem connecting to the service