com.jivesoftware.community.media.type
Class MediaNotificationProvider

java.lang.Object
  com.jivesoftware.community.media.type.MediaNotificationProvider

All Implemented Interfaces:

ContentNotificationProvider<Media>

public class MediaNotificationProvider
extends Object
implements ContentNotificationProvider<Media>

Provides details necessary to fill in a template to construct a message to send this media object type content to another user (generally) as an e-mail message. Currently used by com.jivesoftware.community.action.SendContentNotification action

See Also:

com.jivesoftware.community.action.SendContentNotification

Constructor Summary

MediaNotificationProvider()

Method Summary

String	getAttachmentName(Media media) Return the name of the given jiveObject to be used if it is included as an attachment to a message (email)
long	getAttachmentSize(Media media) Return the size of the bundled item being attached to the message
String	getObjectTitle(Media media) The method should return the plain title, subject, or name of this content.
boolean	isAttachmentAvailable() Returns whether or not the content notification form (Send As Email form) should offer the option to include an attachment of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaNotificationProvider

public MediaNotificationProvider()

Method Detail

getObjectTitle

public String getObjectTitle(Media media)

Description copied from interface: ContentNotificationProvider

The method should return the plain title, subject, or name of this content. For most implementations of JiveContentObject, this method should return the plain subject. Otherwise it might return the name of this content or some other descriptor.

Specified by:

getObjectTitle in interface ContentNotificationProvider<Media>

Parameters:

media - to retrieve the title from

Returns:

a title for this content

isAttachmentAvailable

public boolean isAttachmentAvailable()

Description copied from interface: ContentNotificationProvider

Returns whether or not the content notification form (Send As Email form) should offer the option to include an attachment of the object. If it makes sense to attach a pdf of the rendered html of the content, return true here.

Specified by:

isAttachmentAvailable in interface ContentNotificationProvider<Media>

Returns:

whether or not the content notification form should offer the option to include an attachment

getAttachmentName

public String getAttachmentName(Media media)

Description copied from interface: ContentNotificationProvider

Return the name of the given jiveObject to be used if it is included as an attachment to a message (email)

Specified by:

getAttachmentName in interface ContentNotificationProvider<Media>

Parameters:

media - having its content attached

Returns:

a name for the jiveObject when inserted as an (email) attachment

getAttachmentSize

public long getAttachmentSize(Media media)

Description copied from interface: ContentNotificationProvider

Return the size of the bundled item being attached to the message

Specified by:

getAttachmentSize in interface ContentNotificationProvider<Media>

Parameters:

media - having its content attached

Returns:

size of the attachment