|
CONGO AppServer | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectregistrants
an XMLRPC class to handle registrant specific calls.
| Constructor Summary | |
registrants()
|
|
| Method Summary | |
java.lang.Object |
browseRegistrants(int skipcount,
int numrows,
int cid,
java.lang.String regtype,
java.lang.String status)
Browse registrants based on some simple criteria. |
int |
clearNotification(java.util.Hashtable histinfo)
Clear the notification flag on a specific registrant's history. |
int |
createHistory(java.util.Hashtable histinfo)
Create a history entry for a registrant. |
java.lang.Object |
createLocation(java.util.Hashtable locinfo)
Create a new Location entry for a registrant. |
java.lang.Object |
createRegistrant(java.util.Hashtable reginfo)
Create a new registrant |
java.lang.Object |
delLocation(int regID,
java.lang.String loctype,
java.lang.String locname)
Delete a location entry from a registrant. |
java.lang.Object |
editLocation(java.util.Hashtable locinfo)
Edit a Location entry for a registrant. |
java.lang.Object |
getAllHistorybyActivity(int rid,
int cid,
java.lang.String actCode)
|
java.lang.Object |
getAllLocationByID(int regID)
Return a list of all the Location information for a specific registrant. |
java.lang.Object |
getAllLocationName()
Return a list of locations that can be set. |
java.lang.Object |
getAllLocationType()
Return a list of location types. |
static java.lang.Object |
getAllProperties(int regID)
Retrieve a list of properties that can be set for a specific registrant. |
static java.lang.Object |
getAllProperties(int regID,
int cidID)
Retrieve a list of properties that can be set for a registrant for a specific conference ID. |
static java.lang.Object |
getHistory(int rid,
int cid)
Return an array of hashes describing the history of a registrant as pertains to a specific conference. |
static java.lang.Object |
getHistorybyActivity(int rid,
int cid,
java.lang.String actCode)
Searches the history of a registrant for specific activity, within a cetrain conference. |
static java.lang.Object |
getHistoryByID(int tid)
|
static java.lang.Object |
getLocationByID(int regID,
java.lang.String loctype,
java.lang.String locname)
Retrieve a Location object based on registrant, location type, and name; If locname is blank, just retrieve the first entry marked as primary. |
java.lang.Object |
getMatchNotices(int cid,
java.lang.String fname,
java.lang.String lname,
java.lang.String bname)
|
java.lang.Object |
getRegistrantbyHandle(java.lang.String regHandle)
Return a Registrant hash referenced by Registrant 'handle' (eg 'badgename') |
static java.lang.Object |
getRegistrantbyID(int regID)
Return a Registrant referenced by Registrant ID |
java.lang.Object |
getRegistrantList(int cid)
Returns an array of hashes listing all registrants subscribed to a specified conference. |
static java.lang.Object |
getRegistrantProperty(int regID,
int confID,
java.lang.String propertyname)
Return a property associated with a specific registrant. |
java.lang.Object |
getRegistrantsByField(java.lang.String company,
java.lang.String lastname,
java.lang.String firstname,
java.lang.String handle)
Returns an array of hashes listing all registrants who match substrings within specified fields. |
java.lang.Object |
getRegistrantsByLocation(java.lang.String search,
java.lang.String type,
int exact)
Returns an array of hashes listing all registrants who match substrings within specified location fields. |
java.lang.Object |
getRegistrantsBySearch(java.lang.String search,
int extra)
Returns an array of hashes listing all registrants who match substrings within specified fields. |
java.util.Hashtable |
getState(int regID,
int confID)
Get the full state of a registrant in one call. |
java.lang.Object |
getSubscriptions(int regID)
Return a list of conferences a registrant is subscribed to |
java.lang.Object |
getTransactionList(java.lang.String colname,
int searchval)
Returns an array of hashes showing the result of a transaction lookup. |
static boolean |
isBadged(int regID,
int confID)
Check to see if a registrant is badged |
static boolean |
isCheckedin(int regID,
int confID)
Check to see if a registrant is checkedin |
static boolean |
isRegistered(int regID,
int confID)
Check to see if a registrant is actually registered for a conference, by checking for a REGISTERED entry in the history table for them. |
static boolean |
isSubscribed(int regID,
int confID)
Check to see if a registrant is subscribed to a specific conference. |
java.lang.Object |
setBadgename(int regID,
java.lang.String newval)
Set the badge name for a registrant. |
java.lang.Object |
setCompany(int regID,
java.lang.String newval)
Set the company name for a registrant. |
java.lang.Object |
setFirstname(int regID,
java.lang.String newval)
Set the first name for a registrant. |
java.lang.Object |
setLastname(int regID,
java.lang.String newval)
Set the last name for a registrant. |
java.lang.Object |
setPassword(int regID,
java.lang.String newval)
Set the password for a registrant. |
java.lang.Object |
setRegistrantProperty(int rid,
int cid,
java.lang.String newproperty,
java.lang.String newvalue)
Sets a specific property for a registrant. |
boolean |
subscribe(int regID,
int confID)
Subscribe a registrant to a conference. |
boolean |
transferRegistrant(int fromId,
int toId,
int cid)
Transfer a registration. |
boolean |
unsubscribe(int regID,
int confID)
UnSubscribe a registrant to a conference. |
int |
voidRegistration(int regID,
int cid,
java.lang.String comment)
Void a registrant |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public registrants()
| Method Detail |
public static java.lang.Object getHistorybyActivity(int rid,
int cid,
java.lang.String actCode)
rid - the Registrant ID to search forcid - the Conference to search foractCode - the Activity code to search for
public java.lang.Object getAllHistorybyActivity(int rid,
int cid,
java.lang.String actCode)
public java.lang.Object getMatchNotices(int cid,
java.lang.String fname,
java.lang.String lname,
java.lang.String bname)
public static java.lang.Object getRegistrantProperty(int regID,
int confID,
java.lang.String propertyname)
regID - the Registrant ID to look upconfID - the Conference ID to referencepropertyname - which property to check
public static java.lang.Object getRegistrantbyID(int regID)
regID - the Registrant ID to search for
public java.lang.Object delLocation(int regID,
java.lang.String loctype,
java.lang.String locname)
regID - - the Registrant ID to modifyloctype - - the location type (MAIL,PHONE,SNAIL, etc)locname - - the name of the particular location (HOME, WORK, etc)
public static java.lang.Object getLocationByID(int regID,
java.lang.String loctype,
java.lang.String locname)
regID - The registrant to search forloctype - The location type (MAIL, PHONE, SNAIL, etc)locname - The location tag name (HOME, WORK, OTHER)
public static java.lang.Object getAllProperties(int regID)
regID - the Registrant ID to retrieve
public static java.lang.Object getAllProperties(int regID,
int cidID)
public java.lang.Object getAllLocationByID(int regID)
regID - the Registrant ID to retrieve
public java.lang.Object getAllLocationName()
public java.lang.Object getAllLocationType()
public java.lang.Object getRegistrantbyHandle(java.lang.String regHandle)
regHandle - The handle or badge name to look for
public java.lang.Object createRegistrant(java.util.Hashtable reginfo)
reginfo - Hashtable containing:
public static boolean isSubscribed(int regID,
int confID)
regID - The registrant ID to checkconfID - The conference ID to check
public static boolean isRegistered(int regID,
int confID)
regID - The registrant ID to checkconfID - The conference ID to look them up in
public static boolean isCheckedin(int regID,
int confID)
regID - The registrant ID to checkconfID - The conference ID to look them up in
public static boolean isBadged(int regID,
int confID)
regID - The registrant ID to checkconfID - The conference ID to look them up in
public boolean subscribe(int regID,
int confID)
regID - Registrant ID to subscribeconfID - The conference to subscribe them to
public java.util.Hashtable getState(int regID,
int confID)
regID - Registrant ID to look upconfID - The conference to check on.
public boolean unsubscribe(int regID,
int confID)
regID - Registrant ID to subscribeconfID - The conference to subscribe them to
public boolean transferRegistrant(int fromId,
int toId,
int cid)
fromId - reg ID to transfer fromtoId - reg ID to transfer tocid - Conference IDpublic java.lang.Object getSubscriptions(int regID)
regID - the Registrant ID to retrieve
public java.lang.Object createLocation(java.util.Hashtable locinfo)
locinfo - A hashtable containing:
public java.lang.Object editLocation(java.util.Hashtable locinfo)
locinfo - A hashtable containing:
public java.lang.Object getRegistrantList(int cid)
cid - The conference ID to list.
public java.lang.Object getRegistrantsByField(java.lang.String company,
java.lang.String lastname,
java.lang.String firstname,
java.lang.String handle)
public java.lang.Object getRegistrantsBySearch(java.lang.String search,
int extra)
search - Text to be searched forextra - Should other tables be searched as well? (takes longer)
public java.lang.Object getRegistrantsByLocation(java.lang.String search,
java.lang.String type,
int exact)
search - Text to be searched fortype - 'ALL', or particular location 'type'.exact - If true, only match on exact/full text.
public static java.lang.Object getHistory(int rid,
int cid)
rid - Registrant IDcid - Conference ID
public static java.lang.Object getHistoryByID(int tid)
public int createHistory(java.util.Hashtable histinfo)
histinfo - Hashtable (see below)
Structure of hashtable passing in data:| hist_actcode | hist_arg1 | hist_arg2 | hist_comment | Description |
|---|---|---|---|---|
| BADGED | null | null | Badge printed | A badge was printed |
| CHANGE | old value | new value | What field or item changed | A change to a registrant record, such as name or location |
| CHECKEDIN | null | null | Checked in | A registrant arrived at the event and checked in |
| COMP | regtype | type of comp | WHo is comping this | A free or 'comped' registration note. hist_tid should match regrequest and registration |
| LABEL | null | null | Label printed | A label was pritned |
| NEWREG | null | null | Account created | A registrant was added to the system |
| NOTE | null | null | The note text | A freeform note or comment |
| NOTICE | null | null | The text to be displayed | An alert to be popped up on the terminal of the operator, |
| NOTICE_ACK | null | null | A comment by the operator | The notice (a NOTICE entry) has been acknowledged, and can proceed |
| REGREQUEST | regtype | payment amount | Registrant requested | A new registrant request |
| REGISTERED | regtype | payment amount | Registration complete | A completed registration. hist_tid should match regrequest |
| PROCESSED | null | null | Transaction complete | A pending transaction has completed, see hist_tid for reference ID |
| SUB | null | null | Subcribed | Subscribed registrant to conference 'hist_cid' |
| UNSUB | null | null | Unsubscribed | Unsubscribed registrant from conference 'hist_cid' |
public int clearNotification(java.util.Hashtable histinfo)
histinfo - Hashtable (see below)
Structure of hashtable passing in data:
public java.lang.Object setRegistrantProperty(int rid,
int cid,
java.lang.String newproperty,
java.lang.String newvalue)
rid - Registrant IDcid - Conference ID (if this is '0', this property is set for all events)newproperty - The name of the property being setnewvalue - The value of this property. For true/false, use 0=false, 1=true
public java.lang.Object setPassword(int regID,
java.lang.String newval)
regID - Registrant IDnewval - The new password
public java.lang.Object setLastname(int regID,
java.lang.String newval)
regID - Registrant IDnewval - The new lastname
public java.lang.Object setFirstname(int regID,
java.lang.String newval)
regID - Registrant IDnewval - The new firstname
public java.lang.Object setCompany(int regID,
java.lang.String newval)
regID - Registrant IDnewval - The new company name
public java.lang.Object setBadgename(int regID,
java.lang.String newval)
regID - Registrant IDnewval - The new badge name
public java.lang.Object getTransactionList(java.lang.String colname,
int searchval)
colname - The name of the column to search. This can be hid, rid, tid, or ptype.searchval - The text to search for within the specified column.
public java.lang.Object browseRegistrants(int skipcount,
int numrows,
int cid,
java.lang.String regtype,
java.lang.String status)
skipcount - How many rows to 'skip' before returning data. Used when a client app needs
to 'skip' forward or back groups of registratns.numrows - The number of rows to return in the result.cid - Conference ID to search inregtype - What registration typestatus - The 'status' of the registrant. This should be 'any', 'sub', 'reg', 'badged', or 'checkedin'.
public int voidRegistration(int regID,
int cid,
java.lang.String comment)
regID - Registrant IDcid - Conference IDcomment - Comment on the void
|
CONGO AppServer | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||