LiveSupport::Scheduler::DisplayScheduleMethod Class Reference

#include <DisplayScheduleMethod.h>

Inheritance diagram for LiveSupport::Scheduler::DisplayScheduleMethod:

[legend]Collaboration diagram for LiveSupport::Scheduler::DisplayScheduleMethod:

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to return the schedule for a specified time interval.

The name of the method when called through XML-RPC is "displaySchedule".

The expected parameter is an XML-RPC structure, with the following members:

• sessionId - string - the session ID obtained via the login() method of the authentication client
• from - datetime - the start of the interval to list schedule from, inclusive.
• to - datetime - the end of the interval to list schedule from, non-inclusive.

The XML-RPC function returns an XML-RPC array, containing a structure for each scheduled item in the interval. An array of size 0 means there are not scheduled entries. Each structure is as follows:

• id - int - the id of the scheduled entry
• playlistId - string - the id of the playlist associated with the entry
• start - datetime - the start of the scheduled item
• end - datetime - the end of the scheduled item

The playlistId parameter is a string containing the hexadecimal value of the playlist ID. It is up to 8 characters long, representing a value between 0 and 2^31-1, inclusive.

In case of an error, a standard XML-RPC fault response is generated, and a { faultCode, faultString } structure is returned. The possible errors are:

• 1101 - invalid argument format
• 1102 - missing or invalid 'from' argument
• 1103 - missing or invalid 'to' argument
• 1120 - missing session ID argument

Author:

Author

fgerlits

Version:

Revision

2645

Definition at line 117 of file DisplayScheduleMethod.h.

Public Member Functions
	DisplayScheduleMethod (void) throw ()
	A default constructor, for testing purposes.
	DisplayScheduleMethod (Ptr< XmlRpc::XmlRpcServer >::Ref xmlRpcServer) throw ()
	Constuctor that registers the method with the server right away.
void	execute (XmlRpc::XmlRpcValue ¶meters, XmlRpc::XmlRpcValue &returnValue) throw (XmlRpc::XmlRpcException)
	Execute the display schedule command on the Scheduler daemon.

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::DisplayScheduleMethod::DisplayScheduleMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 136 of file DisplayScheduleMethod.h.

DisplayScheduleMethod::DisplayScheduleMethod

(

Ptr< XmlRpc::XmlRpcServer >::Ref

xmlRpcServer

)

throw ()

Constuctor that registers the method with the server right away.

Parameters:

xmlRpcServer

the XML-RPC server to register with.

Definition at line 84 of file DisplayScheduleMethod.cxx.

---

Member Function Documentation

void DisplayScheduleMethod::execute	(	XmlRpc::XmlRpcValue &	parameters,
		XmlRpc::XmlRpcValue &	returnValue
	)			throw (XmlRpc::XmlRpcException)

Execute the display schedule command on the Scheduler daemon.

Parameters:

	parameters	XML-RPC function call parameters
	returnValue	the return value of the call (out parameter)

Definition at line 95 of file DisplayScheduleMethod.cxx.

---

The documentation for this class was generated from the following files:

• DisplayScheduleMethod.h
• DisplayScheduleMethod.cxx

---