Class conference

java.lang.Object
  conference

public class conference

extends java.lang.Object

an XMLRPC class to handle conference specific calls.

Version:

$Id: conference.java,v 1.31 2005/01/05 17:05:00 shevett Exp $

Author:

Dave Belfer Shevett - dbs@stonekeep.com

Constructor Summary

conference()

Method Summary

java.lang.Object	conferenceList(int rid) Retrieve conference details by its ID (cid)
int	createConference(java.lang.String newConference, java.lang.String credentialUsername, java.lang.String credentialPassword) Create a new conference starting with just the name
java.lang.Object	createRegtype(int confID, java.lang.String newName, java.lang.String newDescription, java.lang.String newCost, java.lang.String newExpiration) Create a new registration type.
java.lang.Object	deleteRegtype(int confID, java.lang.String regType) Delete a registration type
static java.lang.Object	fetchConferencebyID(int cid) Retrieve conference details by its ID (cid)
java.lang.Object	populateConference(int cid, java.lang.String fileName, java.lang.String credentialUsername, java.lang.String credentialPassword) Load new registrant data from a flat file on the filesystem, loading it into a specified new conference.
static java.lang.Object	regtypesList(int cid) Return the list of available registration types
java.lang.Object	setConferenceComment(int confID, java.lang.String newcomment) Set a conference comment
java.lang.Object	setConferenceEmail(int confID, java.lang.String newemail) Set the conference email address
java.lang.Object	setConferenceEnd(int confID, java.lang.String newend) Set the conference end date
java.lang.Object	setConferenceLocation(int confID, java.lang.String newname) Set a conference location
java.lang.Object	setConferenceName(int confID, java.lang.String newname) Set a conference name
java.lang.Object	setConferenceStart(int confID, java.lang.String newstart) Set the conference start date
java.lang.Object	setConferenceStylesheet(int confID, java.lang.String newstylesheet) Set the conference stylesheet
java.lang.Object	setConferenceWebsite(int confID, java.lang.String newwebsite) Set the conference website
java.lang.Object	setConfigProperty(int confID, java.util.Hashtable pInfo) Modify an existing configuration property
java.lang.Object	setRegtypeCost(int confID, java.lang.String regType, double newValue) Set a regtype Cost
static java.lang.Object	setRegtypeDescription(int confID, java.lang.String regType, java.lang.String newValue) Set a regtype Description
java.lang.Object	setRegtypeExpire(int confID, java.lang.String regType, java.lang.String newValue) Set a regtype Expiration

Methods inherited from class java.lang.Object

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

Constructor Detail

conference

public conference()

Method Detail

createConference

public int createConference(java.lang.String newConference,
                            java.lang.String credentialUsername,
                            java.lang.String credentialPassword)

Create a new conference starting with just the name

Parameters:

newConference - the new conference name (this can be changed

credentialUsername - The credentials username.

credentialPassword - The credentials username. later with the 'setConferenceName' method)

Returns:

conferenceNumber If successful, return the number assigned to the conference. If there's a problem, return -1.

populateConference

public java.lang.Object populateConference(int cid,
                                           java.lang.String fileName,
                                           java.lang.String credentialUsername,
                                           java.lang.String credentialPassword)

Load new registrant data from a flat file on the filesystem, loading it into a specified new conference.

Parameters:

cid - The conference ID to use for the target of the load

fileName - The FQDN of the filename to load in. This must be in CD format.

credentialUsername - The credentials username.

credentialPassword - The credentials username.

Returns:

Hashtable containing:

If the function fails:

Integer errorCode - 1
String errorString - The reason for the failure.

fetchConferencebyID

public static java.lang.Object fetchConferencebyID(int cid)

Retrieve conference details by its ID (cid)

Parameters:

cid - the Conference to search for

Returns:

Hashtable containing:

Integer confCID - returns -1 if there is no such conference.
String confName - Name of the conference
String confLocation - Location
String confStart - Date (string form) of the conference start
String confEnd - Date (string form) of the conferenc end
String confComment - Comment field - freeform text
String confWebsite - The convention's website
String confStylesheet - Stylesheet used for rendering templates

conferenceList

public java.lang.Object conferenceList(int rid)

Retrieve conference details by its ID (cid)

Parameters:

rid - Which conference to pull information from (currently ignored)

Returns:

Hashtable containing:

Integer rowcount - The number of rows in the result set Hashtable rowdata - A hashtable containing one row per conference

Structure of rowdata

Integer confCID - the conference ID
String confName - Name of the conference
String confLocation - Where the conference is being held
String confStart - The starting date
String confEnd - The ending date

setConferenceName

public java.lang.Object setConferenceName(int confID,
                                          java.lang.String newname)

Set a conference name

Parameters:

confID - Which conference to alter

newname - The new conference name

Returns:

always returns 1

setConferenceLocation

public java.lang.Object setConferenceLocation(int confID,
                                              java.lang.String newname)

Set a conference location

Parameters:

confID - Which conference to alter

newname - The new conference location

Returns:

always returns 1

setConferenceComment

public java.lang.Object setConferenceComment(int confID,
                                             java.lang.String newcomment)

Set a conference comment

Parameters:

confID - Which conference to alter

newcomment - The new conference comment. This is the full text describing the conference

Returns:

always returns 1

setConferenceStart

public java.lang.Object setConferenceStart(int confID,
                                           java.lang.String newstart)

Set the conference start date

Parameters:

confID - Which conference to alter

newstart - The new conference start date

Returns:

always returns 1

setConferenceEnd

public java.lang.Object setConferenceEnd(int confID,
                                         java.lang.String newend)

Set the conference end date

Parameters:

confID - Which conference to alter

newend - The new conference end date

Returns:

always returns 1

setConferenceWebsite

public java.lang.Object setConferenceWebsite(int confID,
                                             java.lang.String newwebsite)

Set the conference website

Parameters:

confID - Which conference to alter

newwebsite - The new conference website name

Returns:

always returns 1

setConferenceStylesheet

public java.lang.Object setConferenceStylesheet(int confID,
                                                java.lang.String newstylesheet)

Set the conference stylesheet

Parameters:

confID - Which conference to alter

newstylesheet - The new conference stylesheet

Returns:

always returns 1

setConferenceEmail

public java.lang.Object setConferenceEmail(int confID,
                                           java.lang.String newemail)

Set the conference email address

Parameters:

confID - Which conference to alter

newemail - The new conference email address

Returns:

always returns 1

regtypesList

public static java.lang.Object regtypesList(int cid)

Return the list of available registration types

Parameters:

cid - Which conference to list types for

Returns:

Hashtable containing:

Integer rowcount - The number of rows in the result set Vector rowdata - A hashtable containing one row per registration type

Structure of rowdata

Integer regCID - The conference ID
String regName - The registration name ('weekend')
String regDesc - The registration description ('Weekend Pass')
Float regCost - How much the registration costs.
String regExpire - Datestamp the registration expires
Integer regCount - How many people are registered under this type

createRegtype

public java.lang.Object createRegtype(int confID,
                                      java.lang.String newName,
                                      java.lang.String newDescription,
                                      java.lang.String newCost,
                                      java.lang.String newExpiration)

Create a new registration type.

Parameters:

confID - what conference this regtype is associated with

newName - the new registration type (must be unique)

newDescription - A short description of the type, to be displayed to the user

newCost - How much this registration costs

newExpiration - The date this reg type is valid until

Returns:

Hashtable containing:

If the function succeeds:

Integer errorCode - 0
String errorString - 'Success'

If the function fails:

Integer errorCode - 1
String errorString - The reason for the failure.

setRegtypeDescription

public static java.lang.Object setRegtypeDescription(int confID,
                                                     java.lang.String regType,
                                                     java.lang.String newValue)

Set a regtype Description

Parameters:

confID - Which conference

regType - Which registration type

newValue - The new regtype description

Returns:

Hashtable containing:

If the function succeeds:

Integer errorCode - 0
String errorString - 'Success'

If the function fails:

Integer errorCode - 1
String errorString - The reason for the failure.

setRegtypeCost

public java.lang.Object setRegtypeCost(int confID,
                                       java.lang.String regType,
                                       double newValue)

Set a regtype Cost

Parameters:

confID - Which conference

regType - Which registration type

newValue - The new Cost

Returns:

Hashtable containing:

If the function succeeds:

Integer errorCode - 0
String errorString - 'Success'

If the function fails:

Integer errorCode - 1
String errorString - The reason for the failure.

setRegtypeExpire

public java.lang.Object setRegtypeExpire(int confID,
                                         java.lang.String regType,
                                         java.lang.String newValue)

Set a regtype Expiration

Parameters:

confID - Which conference

regType - Which registration type

newValue - The new Expiration date (String format: yyyy-mm-dd hh:mm:ss)

Returns:

Hashtable containing:

If the function succeeds:

Integer errorCode - 0
String errorString - 'Success'

If the function fails:

Integer errorCode - 1
String errorString - The reason for the failure.

deleteRegtype

public java.lang.Object deleteRegtype(int confID,
                                      java.lang.String regType)

Delete a registration type

Parameters:

confID - Which conference

regType - Which registration type

Returns:

Hashtable containing:

If the function succeeds:

Integer errorCode - 0
String errorString - 'Success'

If the function fails:

Integer errorCode - 1
String errorString - The reason for the failure.

setConfigProperty

public java.lang.Object setConfigProperty(int confID,
                                          java.util.Hashtable pInfo)

Modify an existing configuration property

Parameters:

confID - Which conference

pInfo - Hashtable containing the property information, looking like:

String pname
String ptype
String pdefault
int pprompt
Float pcost

Returns:

Hashtable containing:

If the function succeeds:

Integer errorCode - 0
String errorString - 'Success'

If the function fails:

Integer errorCode - 1
String errorString - The reason for the failure.