001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/presentation/tags/sakai_2-4-1/api/src/java/org/sakaiproject/api/app/presentation/PresentationManager.java $
003: * $Id: PresentationManager.java 8659 2006-05-02 03:48:59Z ggolden@umich.edu $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2004, 2005, 2006 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the "License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.api.app.presentation;
021:
022: import java.util.List;
023:
024: import org.sakaiproject.exception.IdUnusedException;
025: import org.sakaiproject.exception.PermissionException;
026: import org.sakaiproject.exception.TypeException;
027:
028: /**
029: * @author Mark Norton
030: */
031: public interface PresentationManager {
032:
033: public boolean allowUpdate(Presentation pres);
034:
035: /**
036: * Start a slide show on a presentation
037: *
038: * @author Charles Severance
039: */
040:
041: public boolean startShow(Presentation pres);
042:
043: /**
044: * Stop a slide show on a presentation
045: *
046: * @author Charles Severance
047: */
048:
049: public boolean stopShow(Presentation pres);
050:
051: /**
052: * Rewind a slide show on a presentation
053: *
054: * @author Charles Severance
055: */
056:
057: public boolean rewindShow(Presentation pres);
058:
059: /**
060: * Advance a slide show on a presentation
061: *
062: * @author Charles Severance
063: */
064:
065: public boolean advanceShow(Presentation pres);
066:
067: /**
068: * Reverse a slide show on a presentation
069: *
070: * @author Charles Severance
071: */
072:
073: public boolean backShow(Presentation pres);
074:
075: /**
076: * Determine if the show is currently showing
077: *
078: * @author Charles Severance
079: */
080:
081: public boolean isShowing(Presentation pres);
082:
083: /**
084: * Get current slide for a show
085: *
086: * @author Charles Severance
087: */
088:
089: public Slide getCurrentSlide(Presentation pres);
090:
091: /**
092: * Get current slide number for a show
093: *
094: * @author Charles Severance
095: */
096:
097: public int getCurrentSlideNumber(Presentation pres);
098:
099: /**
100: * Get the Modification Date as a String
101: *
102: * @author Charles Severance
103: */
104:
105: public String getModificationDate(Presentation pres);
106:
107: /**
108: * Return an interator which lists all known presentations.
109: *
110: * @author Mark Norton
111: */
112: public List getPresentations() throws IdUnusedException,
113: TypeException, PermissionException;
114:
115: /**
116: * Get a Sakai reference to the presentation area - returns null on
117: * any type of failure.
118: *
119: * @author Charles Severance
120: */
121: public String getHomeReference();
122:
123: /**
124: * Get a Sakai reference to a particular presentation - returns null on
125: * any type of failure.
126: *
127: * @author Charles Severance
128: */
129: public String getReference(Presentation pres);
130:
131: public void clearPresentationCache();
132: }
|