org.sakaiproject.api.app.presentation
Interface PresentationManager

All Known Implementing Classes:
PrLegacyManager

public interface PresentationManager

Author:
Mark Norton TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Method Summary
 boolean advanceShow(Presentation pres)
          Advance a slide show on a presentation
 boolean allowUpdate(Presentation pres)
           
 boolean backShow(Presentation pres)
          Reverse a slide show on a presentation
 void clearPresentationCache()
           
 Slide getCurrentSlide(Presentation pres)
          Get current slide for a show
 int getCurrentSlideNumber(Presentation pres)
          Get current slide number for a show
 String getHomeReference()
          Get a Sakai reference to the presentation area - returns null on any type of failure.
 org.osid.id.IdManager getIdManager()
           
 String getModificationDate(Presentation pres)
          Get the Modification Date as a String
 List getPresentations()
          Return an interator which lists all known presentations.
 String getReference(Presentation pres)
          Get a Sakai reference to a particular presentation - returns null on any type of failure.
 boolean isShowing(Presentation pres)
          Determine if the show is currently showing
 boolean rewindShow(Presentation pres)
          Rewind a slide show on a presentation
 void setIdManager(org.osid.id.IdManager im)
           
 boolean startShow(Presentation pres)
          Start a slide show on a presentation
 boolean stopShow(Presentation pres)
          Stop a slide show on a presentation
 

Method Detail

getIdManager

public org.osid.id.IdManager getIdManager()

setIdManager

public void setIdManager(org.osid.id.IdManager im)

allowUpdate

public boolean allowUpdate(Presentation pres)

startShow

public boolean startShow(Presentation pres)
Start a slide show on a presentation


stopShow

public boolean stopShow(Presentation pres)
Stop a slide show on a presentation


rewindShow

public boolean rewindShow(Presentation pres)
Rewind a slide show on a presentation


advanceShow

public boolean advanceShow(Presentation pres)
Advance a slide show on a presentation


backShow

public boolean backShow(Presentation pres)
Reverse a slide show on a presentation


isShowing

public boolean isShowing(Presentation pres)
Determine if the show is currently showing


getCurrentSlide

public Slide getCurrentSlide(Presentation pres)
Get current slide for a show


getCurrentSlideNumber

public int getCurrentSlideNumber(Presentation pres)
Get current slide number for a show


getModificationDate

public String getModificationDate(Presentation pres)
Get the Modification Date as a String


getPresentations

public List getPresentations()
                      throws IdUnusedException,
                             TypeException,
                             PermissionException
Return an interator which lists all known presentations.

Throws:
IdUnusedException
TypeException
PermissionException

getHomeReference

public String getHomeReference()
Get a Sakai reference to the presentation area - returns null on any type of failure.


getReference

public String getReference(Presentation pres)
Get a Sakai reference to a particular presentation - returns null on any type of failure.


clearPresentationCache

public void clearPresentationCache()