| org.sakaiproject.api.app.podcasts.PodcastService
All known Subclasses: org.sakaiproject.component.app.podcasts.PodcastServiceImpl,
| PodcastService | | public interface PodcastService (Code) | | |
| Method Summary | |
| public void | addPodcast(String title, Date displayDate, String description, byte[] body, String filename, String contentType)
| | public boolean | allowAccess(String id)
| | public boolean | canUpdateSite(String siteId)
Determines if user can modify the site. | | public boolean | canUpdateSite()
Determines if user can modify the site. | | public void | cancelContentCollection(ContentCollectionEdit cce)
| | public List | checkDISPLAY_DATE(List resourcesList)
Will check if any podcasts were added in Resources and do not have their DISPLAY_DATE property set. | | public boolean | checkForActualPodcasts()
| | public boolean | checkPodcastFolder()
Determines if podcast folder is part of Resources of site. | | public void | commitContentCollection(ContentCollectionEdit contentCollectionEdit)
Commit the changes made to the ContentCollection. | | public List | filterPodcasts(List resourcesList)
| | public ContentResourceEdit | getAResource(String resourceId)
Returns an editable resource if ID exists. | | public ContentCollection | getContentCollection(String siteId)
Returns the ContentCollection that contains the podcasts. | | public ContentCollectionEdit | getContentCollectionEditable(String siteId)
Returns the ContentCollection that contains the podcasts. | | public Date | getGMTdate(long date)
| | public int | getOptions()
Gets whether the podcast folder is Publicly viewable or not. | | public String | getPodcastFileURL(String resourceId)
| | public List | getPodcasts()
| | public List | getPodcasts(String siteID)
| | public String | getSiteId()
| | public String | getUserId()
| | public String | getUserName()
| | public boolean | hasPerm(String function)
| | public boolean | isPublic(String siteId)
| | public void | removePodcast(String resourceId)
| | public String | retrievePodcastFolderId(String siteId)
Returns podcast folder id using either 'podcasts' or 'Podcasts'. | | public void | reviseOptions(boolean option)
| | public void | revisePodcast(String resourceId, String title, Date date, String description, byte[] body, String filename)
Returns an editable resource if ID exists. | | public void | setContentHostingService(ContentHostingService chs)
| | public void | setDISPLAY_DATE(ResourceProperties rp)
| | public void | setToolManager(ToolManager tm)
|
| COLLECTION_PODCASTS | | final public static String COLLECTION_PODCASTS(Code) | | This string can be used to find the service in the service manager.
|
| COLLECTION_PODCASTS_ALT | | final public static String COLLECTION_PODCASTS_ALT(Code) | | This string can be used as an alternate method to finding the podcasts folder
|
| COLLECTION_PODCASTS_DESCRIPTION | | final public static String COLLECTION_PODCASTS_DESCRIPTION(Code) | | This string gives description for podcasts folder *
|
| COLLECTION_PODCASTS_FEED | | final public static String COLLECTION_PODCASTS_FEED(Code) | | This string used as part of URL for podcast feed *
|
| COLLECTION_PODCASTS_TITLE | | final public static String COLLECTION_PODCASTS_TITLE(Code) | | This string used for Title of the podcast collection *
|
| DELETE_ANY_PERMISSIONS | | final public static String DELETE_ANY_PERMISSIONS(Code) | | |
| DELETE_OWN_PERMISSIONS | | final public static String DELETE_OWN_PERMISSIONS(Code) | | |
| DISPLAY_DATE | | final public static String DISPLAY_DATE(Code) | | This string is the name of the property used when displaying and sorting the podcasts *
|
| DISPLAY_TITLE | | final public static String DISPLAY_TITLE(Code) | | This string is the name of the property for the title of a podcast in the feed *
|
| NEW_PERMISSIONS | | final public static String NEW_PERMISSIONS(Code) | | |
| PODCASTS_SERVICE_NAME | | final public static String PODCASTS_SERVICE_NAME(Code) | | This string gives the Service name (class w/ package prefix) for podcast service *
|
| READ_PERMISSIONS | | final public static String READ_PERMISSIONS(Code) | | |
| REVISE_ANY_PERMISSIONS | | final public static String REVISE_ANY_PERMISSIONS(Code) | | |
| REVISE_OWN_PERMISSIONS | | final public static String REVISE_OWN_PERMISSIONS(Code) | | |
| UPDATE_PERMISSIONS | | final public static String UPDATE_PERMISSIONS(Code) | | This string gives the update function (permission) string for checking permissions *
|
| addPodcast | | public void addPodcast(String title, Date displayDate, String description, byte[] body, String filename, String contentType) throws OverQuotaException, ServerOverloadException, InconsistentException, IdInvalidException, IdLengthException, PermissionException, IdUniquenessException(Code) | | Does the actual adding of podcast to Resources
Parameters:
title - User specified title for the podcast
Parameters:
displayDate - Date when podcast will be available for viewing
Parameters:
description - User specified description for the podcast
Parameters:
body - The actual contents of the podcast
Parameters:
filename - The filename of the podcast being saved |
| allowAccess | | public boolean allowAccess(String id)(Code) | | Determines if authenticated user has 'read' access to podcast collection folder
Parameters:
id - The id for the podcast collection folderTRUE - has read access, FALSE - does not |
| canUpdateSite | | public boolean canUpdateSite(String siteId)(Code) | | Determines if user can modify the site. Used by feed.
boolean true if user can modify, false otherwise |
| canUpdateSite | | public boolean canUpdateSite()(Code) | | Determines if user can modify the site. Used within the tool.
boolean true if user can modify, false otherwise |
| cancelContentCollection | | public void cancelContentCollection(ContentCollectionEdit cce)(Code) | | Cancels attempt at changing this collection (releases the lock)
Parameters:
cce - The ContentCollectionEdit that is not to be changed |
| checkDISPLAY_DATE | | public List checkDISPLAY_DATE(List resourcesList)(Code) | | Will check if any podcasts were added in Resources and do not have their DISPLAY_DATE property set.
Parameters:
resourcesList - The List of podcasts to check List of updated podcasts |
| checkForActualPodcasts | | public boolean checkForActualPodcasts() throws PermissionException(Code) | | Determines if there are actual podcasts in the folder
true if there are actual podcasts, false otherwise |
| checkPodcastFolder | | public boolean checkPodcastFolder() throws InUseException, PermissionException(Code) | | Determines if podcast folder is part of Resources of site.
If not, creates it.
true if folder exists/created, false otherwise. |
| commitContentCollection | | public void commitContentCollection(ContentCollectionEdit contentCollectionEdit)(Code) | | Commit the changes made to the ContentCollection.
Parameters:
contentCollectionEdit - The ContentCollection object that needs to be commited. |
| filterPodcasts | | public List filterPodcasts(List resourcesList)(Code) | | Only add podcast resources whose DISPLAY_DATE is today or earlier
Parameters:
resourcesList - List of podcasts List of podcasts whose DISPLAY_DATE is today or before |
| getGMTdate | | public Date getGMTdate(long date)(Code) | | Takes the date String passed in and converts it to a Date object
using GMT time
Parameters:
date - A long value representing the date to be converted`Date object created |
| getOptions | | public int getOptions()(Code) | | Gets whether the podcast folder is Publicly viewable or not.
int 0 = Public 1 = Site |
| getPodcastFileURL | | public String getPodcastFileURL(String resourceId) throws PermissionException, IdUnusedException(Code) | | Returns the full URL of the file from ContentHostingService
Parameters:
resourceId - The ID for the file whose URL is wanted String The full URL for the file |
| getSiteId | | public String getSiteId()(Code) | | Returns SiteId for the site this tool is a part of
String of the site id |
| getUserId | | public String getUserId()(Code) | | Returns UserId for the current user
String of the user ID |
| getUserName | | public String getUserName()(Code) | | Returns user display name for current user
String of the user display name |
| hasPerm | | public boolean hasPerm(String function)(Code) | | Determines if user has the function (permission) passed in
boolean true if user has function (permission), false otherwise. |
| isPublic | | public boolean isPublic(String siteId)(Code) | | Returns whether site is Public (true) or Site (false)
Parameters:
siteId - |
| retrievePodcastFolderId | | public String retrievePodcastFolderId(String siteId) throws PermissionException(Code) | | Returns podcast folder id using either 'podcasts' or 'Podcasts'. If it
does not exist in either form, will create it.
Parameters:
siteId - The site to search String containing the complete id for the podcast folder
throws:
PermissionException - |
| reviseOptions | | public void reviseOptions(boolean option)(Code) | | Changes whether the podcast folder is public/private
Parameters:
option - int that sets the public/private option |
| setContentHostingService | | public void setContentHostingService(ContentHostingService chs)(Code) | | Used to inject the ContentHostingService
Parameters:
chs - The application's ContentHostingService |
| setDISPLAY_DATE | | public void setDISPLAY_DATE(ResourceProperties rp)(Code) | | Sets the DISPLAY_DATE property of a podcast to CREATION_DATE
Parameters:
rp - The ResourceProperties of the podcast to set |
| setToolManager | | public void setToolManager(ToolManager tm)(Code) | | Used to inject the ToolManager
Parameters:
tm - The application's ToolManager |
|
|