org.sakaiproject.tool.podcasts

Class podHomeBean

java.lang.Object

org.sakaiproject.tool.podcasts.podHomeBean

public class podHomeBean
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	podHomeBean.DecoratedPodcastBean Bean to store information about a single podcast.

Constructor Summary

Constructors

Constructor and Description
podHomeBean()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getActPodcastsExist() Resources/podcasts exists, but are there any actual podcasts
podHomeBean.DecoratedPodcastBean	getAPodcast(org.sakaiproject.content.api.ContentResource podcastResource, boolean folderHidden) Receives a particular podcast and packages it as a DecoratedPodcastBean
boolean	getCanUpdateSite() Returns boolean if user can update podcasts.
List	getContents() Construct a List of DecoratedPodcastBeans for display on main page
String	getDate()
String	getDescription()
boolean	getDisplayInvalidDateErrMsg() Returns whether an invalid date error message is displayed
boolean	getDisplayNoDateErrMsg() Returns whether a no date error message is displayed
boolean	getDisplayNoFileErrMsg() Returns whether a no file selected error message is displayed
boolean	getDisplayNoTitleErrMsg() Returns whether a no title entered error message is displayed
String	getemail() FUTURE: Returns the notification level set by the user
SelectItem[]	getEmailItems() FUTURE: To display the possible email notification levels
boolean	getErrorOnPage()
String	getFilename()
boolean	getHasAllGroups() Returns TRUE if user has ALLGROUPS permission (or site.upd which supercedes), FALSE if not
boolean	getHasDelAnyPerm()
boolean	getHasDelOwnPerm()
boolean	getHasHidden()
boolean	getHasNewPerm()
boolean	getHasReadPerm()
boolean	getHasReviseAnyPerm()
boolean	getHasReviseOwnPerm()
String	getMaxSizeExceededAlert() Returns the message that a file too large tried to be uploaded.
String	getMessageFromBundle(String key)
String	getMessageFromBundle(String key, Object[] args)
boolean	getPodcastFolderExists() Determines if the podcast folder exists.
boolean	getResourceToolExists() Determines if Resource tool part of the site.
podHomeBean.DecoratedPodcastBean	getSelectedPodcast() Returns the current DecoratedPodcastBean set as selectedPodcast.
String	getTitle()
boolean	getUploadStatus() Returns whether a file too large tried to be uploaded.
String	getURL() Returns the URL to point your podcatcher to in order to grab the feed.
String	getUserName()
boolean	isCanAccessFolder()
boolean	isPodcastFolderHidden() Returns whether the Podcasts folder should be considered HIDDEN in UI
void	podMainListener(ActionEvent e) To set the selectedPodcast DecoratedPodcastBean when Revision and Deletion links are clicked (possibly Download also)
String	processAdd() Performs the actual adding of a podcast.
String	processCancelAdd() Erases bean values since no podcast is to be added.
String	processCancelDelete() Resets selectedPodcast bean since no deletion is to be made
String	processCancelRevise() Resets selectedPodcast bean since no revision is to be made
String	processDeletePodcast() Used to call podcastService to actually delete selected podcast.
void	processFileUpload(ValueChangeEvent event) Creates a BufferedInputStream to get ready to upload file selected.
String	processPermissions() Constructs call to permissions helper and redirects to it to display Podcasts folder permissions page.
String	processRevisePodcast() Gathers information and calls PodcastService to make changes to existing podcast.
void	setDate(String date)
void	setDescription(String description)
void	setDisplayInvalidDateErrMsg(boolean displayInvalidDateErrMsg)
void	setDisplayNoDateErrMsg(boolean displayNoDateErrMsg)
void	setDisplayNoFileErrMsg(boolean displayNoFileErrMsg)
void	setDisplayNoTitleErrMsg(boolean displayNoTitleErrMsg)
void	setemail(String email) FUTURE: Sets the notification level
void	setFilename(String filename)
void	setPodcastPermissionsService(org.sakaiproject.api.app.podcasts.PodcastPermissionsService podcastPermissionsService)
void	setPodcastSelected(String resourceId) Does the actual filling up of the selectedPodcast bean
void	setPodcastService(org.sakaiproject.api.app.podcasts.PodcastService podcastService) Used to inject the podcast service into this bean.
void	setSelectedPodcast(podHomeBean.DecoratedPodcastBean selectedPodcast) Use to set the selectedPodcast object.
void	setTitle(String title)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

podHomeBean

public podHomeBean()

Method Detail

getResourceToolExists

public boolean getResourceToolExists()

Determines if Resource tool part of the site. Needed to store podcasts.

getPodcastFolderExists

public boolean getPodcastFolderExists()

Determines if the podcast folder exists. If it does not, it will attempt to create it.

Returns:

boolean TRUE if folder exists, FALSE otherwise.

getURL

public String getURL()

Returns the URL to point your podcatcher to in order to grab the feed.

Returns:

String The feed URL.

processPermissions

public String processPermissions()

Constructs call to permissions helper and redirects to it to display Podcasts folder permissions page.

setPodcastService

public void setPodcastService(org.sakaiproject.api.app.podcasts.PodcastService podcastService)

Used to inject the podcast service into this bean.

Parameters:

podcastService - The podcast service this bean needs

setPodcastPermissionsService

public void setPodcastPermissionsService(org.sakaiproject.api.app.podcasts.PodcastPermissionsService podcastPermissionsService)

isPodcastFolderHidden

public boolean isPodcastFolderHidden()

Returns whether the Podcasts folder should be considered HIDDEN in UI

getAPodcast

public podHomeBean.DecoratedPodcastBean getAPodcast(org.sakaiproject.content.api.ContentResource podcastResource,
                                           boolean folderHidden)
                                             throws org.sakaiproject.entity.api.EntityPropertyNotDefinedException,
                                                    org.sakaiproject.entity.api.EntityPropertyTypeException

Receives a particular podcast and packages it as a DecoratedPodcastBean

Parameters:

podcastProperties - Contains the ResourceProperties object of a podcast resource

resourceId - The resource ID for the podcast

Returns:

DecoratedPodcastBean The packaged podcast or null and exception if problems

Throws:

org.sakaiproject.entity.api.EntityPropertyNotDefinedException - The property wanted was not found

org.sakaiproject.entity.api.EntityPropertyTypeException - The property (Date/Time) was not a valid one

getContents

public List getContents()

Construct a List of DecoratedPodcastBeans for display on main page

Returns:

List List of DecoratedPodcastBeans that are the podcasts

getActPodcastsExist

public boolean getActPodcastsExist()

Resources/podcasts exists, but are there any actual podcasts

Returns:

boolean TRUE if there are podcasts, FALSE otherwise

podMainListener

public void podMainListener(ActionEvent e)

To set the selectedPodcast DecoratedPodcastBean when Revision and Deletion links are clicked (possibly Download also)

Parameters:

e - ActionEvent object generated by clicking on a link

setPodcastSelected

public void setPodcastSelected(String resourceId)

Does the actual filling up of the selectedPodcast bean

Parameters:

resourceId - Resource ID for the podcast whose link was selected

getSelectedPodcast

public podHomeBean.DecoratedPodcastBean getSelectedPodcast()

Returns the current DecoratedPodcastBean set as selectedPodcast.

setSelectedPodcast

public void setSelectedPodcast(podHomeBean.DecoratedPodcastBean selectedPodcast)

Use to set the selectedPodcast object.

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

getDate

public String getDate()

setDate

public void setDate(String date)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getEmailItems

public SelectItem[] getEmailItems()

FUTURE: To display the possible email notification levels

Returns:

SelectItem [] List of possible email notification levels

getemail

public String getemail()

FUTURE: Returns the notification level set by the user

Returns:

String Returns the current notification level

setemail

public void setemail(String email)

FUTURE: Sets the notification level

Parameters:

email - String representing the notification level

getCanUpdateSite

public boolean getCanUpdateSite()

Returns boolean if user can update podcasts. Used to display modification options on main page.

getHasReadPerm

public boolean getHasReadPerm()

getHasNewPerm

public boolean getHasNewPerm()

getHasReviseAnyPerm

public boolean getHasReviseAnyPerm()

getHasReviseOwnPerm

public boolean getHasReviseOwnPerm()

getHasDelAnyPerm

public boolean getHasDelAnyPerm()

getHasDelOwnPerm

public boolean getHasDelOwnPerm()

getHasAllGroups

public boolean getHasAllGroups()

Returns TRUE if user has ALLGROUPS permission (or site.upd which supercedes), FALSE if not

getHasHidden

public boolean getHasHidden()

getUserName

public String getUserName()

isCanAccessFolder

public boolean isCanAccessFolder()

processFileUpload

public void processFileUpload(ValueChangeEvent event)
                       throws AbortProcessingException

Creates a BufferedInputStream to get ready to upload file selected. Used by Add Podcast and Revise Podcast pages.

Parameters:

event - ValueChangeEvent object generated by selecting a file to upload.

Throws:

AbortProcessingException - Internal processing error attempting to set up BufferedInputStream

processAdd

public String processAdd()

Performs the actual adding of a podcast. Calls PodcastService to actually add the podcast.

Returns:

String Sent to return to main page.

processCancelAdd

public String processCancelAdd()

Erases bean values since no podcast is to be added.

Returns:

String Sent to return to main page.

processRevisePodcast

public String processRevisePodcast()

Gathers information and calls PodcastService to make changes to existing podcast.

processCancelRevise

public String processCancelRevise()

Resets selectedPodcast bean since no revision is to be made

processDeletePodcast

public String processDeletePodcast()

Used to call podcastService to actually delete selected podcast.

processCancelDelete

public String processCancelDelete()

Resets selectedPodcast bean since no deletion is to be made

Returns:

String Sent to return to main page.

getDisplayNoFileErrMsg

public boolean getDisplayNoFileErrMsg()

Returns whether a no file selected error message is displayed

setDisplayNoFileErrMsg

public void setDisplayNoFileErrMsg(boolean displayNoFileErrMsg)

getDisplayNoDateErrMsg

public boolean getDisplayNoDateErrMsg()

Returns whether a no date error message is displayed

setDisplayNoDateErrMsg

public void setDisplayNoDateErrMsg(boolean displayNoDateErrMsg)

getDisplayNoTitleErrMsg

public boolean getDisplayNoTitleErrMsg()

Returns whether a no title entered error message is displayed

setDisplayNoTitleErrMsg

public void setDisplayNoTitleErrMsg(boolean displayNoTitleErrMsg)

getErrorOnPage

public boolean getErrorOnPage()

getDisplayInvalidDateErrMsg

public boolean getDisplayInvalidDateErrMsg()

Returns whether an invalid date error message is displayed

setDisplayInvalidDateErrMsg

public void setDisplayInvalidDateErrMsg(boolean displayInvalidDateErrMsg)

Parameters:

displayInvalidDateErrMsg - The displayInvalidDateErrMsg to set.

getUploadStatus

public boolean getUploadStatus()

Returns whether a file too large tried to be uploaded. (SAK-9822)

getMaxSizeExceededAlert

public String getMaxSizeExceededAlert()

Returns the message that a file too large tried to be uploaded. (SAK-9822)

getMessageFromBundle

public String getMessageFromBundle(String key,
                          Object[] args)

getMessageFromBundle

public String getMessageFromBundle(String key)