LiveSupport::Scheduler::RemoveFromScheduleMethod Class Reference

#include <RemoveFromScheduleMethod.h>

Inheritance diagram for LiveSupport::Scheduler::RemoveFromScheduleMethod:

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

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to remove a scheduled entry.

The name of the method when called through XML-RPC is “removeFromSchedule”.

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
• scheduleEntryId – string – the id of the scheduled entry to remove

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

• 1201 – invalid argument format
• 1202 – missing schedule entry ID argument
• 1203 – schedule entry not found
• 1204 – the entry to be deleted is currently playing
• 1220 – missing session ID argument

Author:

Author

fgerlits

Version:

Revision

2329

Definition at line 96 of file RemoveFromScheduleMethod.h.

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

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::RemoveFromScheduleMethod::RemoveFromScheduleMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 115 of file RemoveFromScheduleMethod.h.

RemoveFromScheduleMethod::RemoveFromScheduleMethod

(

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 82 of file RemoveFromScheduleMethod.cxx.

---

Member Function Documentation

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

Execute the remove from 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 93 of file RemoveFromScheduleMethod.cxx.

---

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

• RemoveFromScheduleMethod.h
• RemoveFromScheduleMethod.cxx

---