com.jivesoftware.community.objecttype
Interface ContentNotificationProvider<T extends JiveObject>

All Known Implementing Classes:

MediaNotificationProvider

public interface ContentNotificationProvider<T extends JiveObject>

Provides details necessary to fill in a template to construct a message to send this 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

Method Summary

String	getAttachmentName(T jiveObject) Return the name of the given jiveObject to be used if it is included as an attachment to a message (email)
long	getAttachmentSize(T jiveObject) Return the size of the bundled item being attached to the message
String	getObjectTitle(T jiveObject) 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.

Method Detail

getObjectTitle

String getObjectTitle(T jiveObject)

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.

Parameters:

jiveObject - to retrieve the title from

Returns:

a title for this content

isAttachmentAvailable

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. If it makes sense to attach a pdf of the rendered html of the content, return true here.

Returns:

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

getAttachmentName

String getAttachmentName(T jiveObject)

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

Parameters:

jiveObject - having its content attached

Returns:

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

getAttachmentSize

long getAttachmentSize(T jiveObject)

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

Parameters:

jiveObject - having its content attached

Returns:

size of the attachment