API Documentation

Classes

EventDocument

Functions

manage_addEvent , getAllTypes

Event Document

Classes

class EventDocument

A structured text document with information geared towards website headlines and events. Information such as an event date, show and hide dates are stored by the document.

CatalogAware - will catalog inside of a ZCatalog named MasterEventsCatalog in the context. It will also catalog itself with all Purdue Event Managers it is inside of.

__module__ = __builtin__

Methods

getAllTypes():

Return all available types for Event Documents at location of Purdue Event Document.

inMaster():

return 1 if changes to this event should be updated in the master

unindex_object():

A common method to allow Findables to unindex themselves.

renderBody(REQUEST=None):

Render the body without wrapping the document

getScheme():

Return the scheme for the templated fields defined in the Purdue Event Template

getEventManagers():

Return a list of Purdue Event Managers this Event is inside of

index_object():

Catalog in the default catalog as well as any EventManagers it is inside

manage_editEvents(title, redirect_url, data, REQUEST=None):

Update the contents of a Event Document

__call__(client=None, REQUEST={}, RESPONSE=None, **kw):

Render the Event Document given a client object, REQUEST mapping, Response, and keyword arguments.

summary(num=100):

Return a summary of the text content of of the object.

document_src():

Return unrendered StructuredText for the document

PrincipiaSearchSource():

Support for searching the documents contents, title, and id

Functions

manage_addEvent(context, id, title=, event_date=, show_date=, hide_date=, type=, masterCatalog=1, REQUEST=None, submit=None):

Add a Event Document

submit is the value of the submit button if it is Add and Edit the user gets redirected to the user form.

masterCatalog is 1 if the the object should be cataloged with the master

getAllTypes(context):

returns a list containing all of types defined by the Purdue Event Managers in the context.

For example if called by a method from

/EventManager1/Folder1/EventManager2/Folder2/method

any types defined in EventManager1 or EventManager2 will be returned