com.jivesoftware.community.media
Class MediaObjectType

java.lang.Object
  com.jivesoftware.community.media.MediaObjectType

All Implemented Interfaces:

FavoritableType, ProxiedMediaType, BanEnabledType, CommentableType, ContainableType, ContentObjectType, FilteredContentEnabledType, FilteredIndexableType, IndexableType, PermissionEnabledObjectType, ProxiedType, RecentActivityEnabledType, RecentContentEnabledType, RecentHistoryEnabledType, TaggableType, VisibleType, WatchableType

public abstract class MediaObjectType
extends Object
implements ContainableType, ContentObjectType, VisibleType, CommentableType, FavoritableType, RecentHistoryEnabledType, TaggableType, RecentContentEnabledType, RecentActivityEnabledType, FilteredIndexableType, WatchableType, PermissionEnabledObjectType, ProxiedMediaType, BanEnabledType

Base object type for multimedia providing default implementations for content type framework behavior.

Field Summary

protected CommentableTypeInfoProvider	commentableTypeInfoProvider
protected ContainableTypeInfoProvider	containableTypeInfoProvider
protected MediaContainableTypeManager	containableTypeManager
protected MediaNotificationProvider	contentNotificationProvider
protected FavoriteInfoProvider	favoriteInfoProvider
protected MediaFilteredContentProvider	filteredContentProvider
protected MediaManager	mediaManager
protected MediaManagerImpl	mediaManagerImpl
protected MediaObjectTypeRegistry<Map<Class<? extends Media>,String>>	mediaObjectTypeRegistry
protected ModerationStrategy	moderationStrategy
protected MoveContentProvider	moveContentProvider
protected ObjectTypeManager	objectTypeManager
protected PermissionInfoProvider	permissionInfoProvider
protected MediaProxyInfoProvider	proxyInfoProvider
protected MediaRecentHistoryProvider	recentHistoryProvider
protected TaggableTypeInfoProvider	taggableTypeInfoProvider
protected TypeUIProvider	typeUIProvider
protected UserBarProvider	userBarProvider
protected UserContainerManager	userContainerManager
protected MediaWatchInfoProvider	watchInfoProvider

Constructor Summary

MediaObjectType()

Method Summary

boolean	canViewType()
boolean	equals(Object o)
CommentableTypeInfoProvider	getCommentableTypeInfoProvider() Gets a provider class which exposes methods describing how objects of this object type can provide the comment system with data the subsystem needs for accomplishing comment-related behavior on the behalf of the object.
ContainableTypeInfoProvider	getContainableTypeInfoProvider() Returns a class which describes the types of containers this containable type may be contained within, and the rules governing that relationship.
MediaContainableTypeManager	getContainableTypeManager() Returns a manager that will perform some actions on the containable objects.
MediaNotificationProvider	getContentNotificationProvider()
<O extends JiveObject,T extends JiveObjectType> FavoriteInfoProvider<O,T>	getFavoriteInfoProvider() Returns a provider with details on favoriting specific to this type.
MediaFilteredContentProvider	getFilteredContentProvider() Gets a provider class used for helping the appplication lists of object of this type.
MediaManager	getMediaManager()
MediaManagerImpl	getMediaManagerImpl()
MediaObjectTypeRegistry	getMediaObjectTypeRegistry()
ModerationStrategy	getModerationStrategy()
MoveContentProvider	getMoveContentProvider()
ObjectTypeManager	getObjectTypeManager()
PermissionInfoProvider	getPermissionInfoProvider() Returns a provider with details on permissions specific to this type.
MediaProxyInfoProvider	getProxyInfoProvider() A ProxyInfoProvider is a convenience meant to aid in retrieving information about any proxy implementation associate with the object type implementation.
MediaRecentHistoryProvider	getRecentHistoryProvider() Gets a provider class used for helping the appplication furnish recent history for the object type.
TaggableTypeInfoProvider	getTaggableTypeInfoProvider() Gets a provider class which exposes methods describing how objects of this object type can provide the tag system with data the subsystem needs for accomplishing tag-related behavior on the behalf of the object.
TypeUIProvider	getTypeUIProvider() Gets a provider class used for helping the appplication render the jive object of this object type.
UserBarProvider	getUserBarProvider() Gets a provider class used for customizing the userbar dropdowns.
UserContainerManager	getUserContainerManager()
MediaWatchInfoProvider	getWatchInfoProvider() Returns a provider allowing the type to integrate with the watch subsystem.
protected void	registerMediaType(Class<? extends Media> mediaType, String objectTypeName) Registers the specified media type and it's object type name, so that type providers that apply to all media types will apply to a given implmentation of MediaObjectType.
void	setCommentableTypeInfoProvider(CommentableTypeInfoProvider commentableTypeInfoProvider)
void	setContainableTypeInfoProvider(ContainableTypeInfoProvider containableTypeInfoProvider)
void	setContainableTypeManager(MediaContainableTypeManager containableTypeManager)
void	setContentNotificationProvider(MediaNotificationProvider contentNotificationProvider)
void	setFavoriteInfoProvider(FavoriteInfoProvider favoriteInfoProvider)
void	setFilteredContentProvider(MediaFilteredContentProvider filteredContentProvider)
void	setMediaManager(MediaManager mediaManager)
void	setMediaManagerImpl(MediaManagerImpl mediaManagerImpl)
void	setMediaObjectTypeRegistry(MediaObjectTypeRegistry<Map<Class<? extends Media>,String>> mediaObjectTypeRegistry)
void	setModerationStrategy(ModerationStrategy moderationStrategy)
void	setMoveContentProvider(MoveContentProvider moveContentProvider)
void	setObjectTypeManager(ObjectTypeManager objectTypeManager)
void	setPermissionInfoProvider(PermissionInfoProvider permissionInfoProvider)
void	setProxyInfoProvider(MediaProxyInfoProvider proxyInfoProvider)
void	setRecentHistoryProvider(MediaRecentHistoryProvider recentHistoryProvider)
void	setTaggableTypeInfoProvider(TaggableTypeInfoProvider taggableTypeProvider)
void	setTypeUIProvider(TypeUIProvider typeUIProvider)
void	setUserBarProvider(UserBarProvider userBarProvider)
void	setUserContainerManager(UserContainerManager userContainerManager)
void	setWatchInfoProvider(MediaWatchInfoProvider provider)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jivesoftware.community.objecttype.ContentObjectType

getContentObjectTypeInfoProvider

Methods inherited from interface com.jivesoftware.community.favorites.type.FavoritableType

isFavoriteViewable

Methods inherited from interface com.jivesoftware.community.objecttype.RecentContentEnabledType

getRecentContentInfoProvider

Methods inherited from interface com.jivesoftware.community.objecttype.RecentActivityEnabledType

getRecentActivityInfoProvider

Methods inherited from interface com.jivesoftware.community.objecttype.IndexableType

getIndexInfoProvider

Methods inherited from interface com.jivesoftware.community.objecttype.BanEnabledType

getBanInfoProvider

Field Detail

commentableTypeInfoProvider

protected CommentableTypeInfoProvider commentableTypeInfoProvider

typeUIProvider

protected TypeUIProvider typeUIProvider

taggableTypeInfoProvider

protected TaggableTypeInfoProvider taggableTypeInfoProvider

mediaManager

protected MediaManager mediaManager

mediaManagerImpl

protected MediaManagerImpl mediaManagerImpl

userBarProvider

protected UserBarProvider userBarProvider

moderationStrategy

protected ModerationStrategy moderationStrategy

recentHistoryProvider

protected MediaRecentHistoryProvider recentHistoryProvider

filteredContentProvider

protected MediaFilteredContentProvider filteredContentProvider

mediaObjectTypeRegistry

protected MediaObjectTypeRegistry<Map<Class<? extends Media>,String>> mediaObjectTypeRegistry

objectTypeManager

protected ObjectTypeManager objectTypeManager

containableTypeInfoProvider

protected ContainableTypeInfoProvider containableTypeInfoProvider

favoriteInfoProvider

protected FavoriteInfoProvider favoriteInfoProvider

containableTypeManager

protected MediaContainableTypeManager containableTypeManager

userContainerManager

protected UserContainerManager userContainerManager

watchInfoProvider

protected MediaWatchInfoProvider watchInfoProvider

permissionInfoProvider

protected PermissionInfoProvider permissionInfoProvider

proxyInfoProvider

protected MediaProxyInfoProvider proxyInfoProvider

contentNotificationProvider

protected MediaNotificationProvider contentNotificationProvider

moveContentProvider

protected MoveContentProvider moveContentProvider

Constructor Detail

MediaObjectType

public MediaObjectType()

Method Detail

getContainableTypeInfoProvider

public ContainableTypeInfoProvider getContainableTypeInfoProvider()

Description copied from interface: ContainableType

Returns a class which describes the types of containers this containable type may be contained within, and the rules governing that relationship. Must return a non-null value.

Specified by:

getContainableTypeInfoProvider in interface ContainableType

Returns:

a class which describes the types of containers this containable type may be contained within, and the rules governing that relationship.

registerMediaType

protected void registerMediaType(Class<? extends Media> mediaType,
                                 String objectTypeName)

Registers the specified media type and it's object type name, so that type providers that apply to all media types will apply to a given implmentation of MediaObjectType. Implementations that want pre-existing type behavior should register themselves on init

Parameters:

mediaType - - the interface or implemenation to register

objectTypeName - - the value returned by getName of the object type implementation

getCommentableTypeInfoProvider

public CommentableTypeInfoProvider getCommentableTypeInfoProvider()

Description copied from interface: CommentableType

Gets a provider class which exposes methods describing how objects of this object type can provide the comment system with data the subsystem needs for accomplishing comment-related behavior on the behalf of the object.

Specified by:

getCommentableTypeInfoProvider in interface CommentableType

Returns:

an information provider for the CommentableType.

setCommentableTypeInfoProvider

public final void setCommentableTypeInfoProvider(CommentableTypeInfoProvider commentableTypeInfoProvider)

getTypeUIProvider

public TypeUIProvider getTypeUIProvider()

Description copied from interface: VisibleType

Gets a provider class used for helping the appplication render the jive object of this object type. Must return a not-null value.

Specified by:

getTypeUIProvider in interface VisibleType

Returns:

the UI provider.

setTypeUIProvider

public final void setTypeUIProvider(TypeUIProvider typeUIProvider)

getTaggableTypeInfoProvider

public TaggableTypeInfoProvider getTaggableTypeInfoProvider()

Description copied from interface: TaggableType

Gets a provider class which exposes methods describing how objects of this object type can provide the tag system with data the subsystem needs for accomplishing tag-related behavior on the behalf of the object.

Specified by:

getTaggableTypeInfoProvider in interface TaggableType

Returns:

The provider object.

setTaggableTypeInfoProvider

public final void setTaggableTypeInfoProvider(TaggableTypeInfoProvider taggableTypeProvider)

getMediaManager

public MediaManager getMediaManager()

setMediaManager

public final void setMediaManager(MediaManager mediaManager)

getMediaManagerImpl

public MediaManagerImpl getMediaManagerImpl()

setMediaManagerImpl

public final void setMediaManagerImpl(MediaManagerImpl mediaManagerImpl)

getUserBarProvider

public UserBarProvider getUserBarProvider()

Description copied from interface: VisibleType

Gets a provider class used for customizing the userbar dropdowns. If returns null, the system will assume that there is no userbar customization for type, or it has been customized elsewhere (i.e. ui-components.xml, or in plugin.xml).

Specified by:

getUserBarProvider in interface VisibleType

Returns:

setUserBarProvider

public final void setUserBarProvider(UserBarProvider userBarProvider)

getModerationStrategy

public ModerationStrategy getModerationStrategy()

setModerationStrategy

public final void setModerationStrategy(ModerationStrategy moderationStrategy)

getRecentHistoryProvider

public MediaRecentHistoryProvider getRecentHistoryProvider()

Description copied from interface: RecentHistoryEnabledType

Gets a provider class used for helping the appplication furnish recent history for the object type. Must return a not-null value.

Specified by:

getRecentHistoryProvider in interface RecentHistoryEnabledType

Returns:

the UI provider.

setRecentHistoryProvider

public final void setRecentHistoryProvider(MediaRecentHistoryProvider recentHistoryProvider)

getFilteredContentProvider

public MediaFilteredContentProvider getFilteredContentProvider()

Description copied from interface: FilteredContentEnabledType

Gets a provider class used for helping the appplication lists of object of this type. Must return a not-null value.

Specified by:

getFilteredContentProvider in interface FilteredContentEnabledType

Returns:

the UI provider.

setFilteredContentProvider

public final void setFilteredContentProvider(MediaFilteredContentProvider filteredContentProvider)

getMediaObjectTypeRegistry

public MediaObjectTypeRegistry getMediaObjectTypeRegistry()

setMediaObjectTypeRegistry

public final void setMediaObjectTypeRegistry(MediaObjectTypeRegistry<Map<Class<? extends Media>,String>> mediaObjectTypeRegistry)

getObjectTypeManager

public ObjectTypeManager getObjectTypeManager()

setObjectTypeManager

public final void setObjectTypeManager(ObjectTypeManager objectTypeManager)

getUserContainerManager

public UserContainerManager getUserContainerManager()

setUserContainerManager

public void setUserContainerManager(UserContainerManager userContainerManager)

setWatchInfoProvider

public final void setWatchInfoProvider(MediaWatchInfoProvider provider)

getWatchInfoProvider

public MediaWatchInfoProvider getWatchInfoProvider()

Description copied from interface: WatchableType

Returns a provider allowing the type to integrate with the watch subsystem.

Specified by:

getWatchInfoProvider in interface WatchableType

Returns:

a provider allowing the type to integrate with the watch subsystem.

getFavoriteInfoProvider

public <O extends JiveObject,T extends JiveObjectType> FavoriteInfoProvider<O,T> getFavoriteInfoProvider()

Description copied from interface: FavoritableType

Returns a provider with details on favoriting specific to this type.

Specified by:

getFavoriteInfoProvider in interface FavoritableType

Returns:

a provider with details on favoriting specific to this type.

setFavoriteInfoProvider

public final void setFavoriteInfoProvider(FavoriteInfoProvider favoriteInfoProvider)

setContainableTypeManager

public final void setContainableTypeManager(MediaContainableTypeManager containableTypeManager)

getContainableTypeManager

public MediaContainableTypeManager getContainableTypeManager()

Description copied from interface: ContainableType

Returns a manager that will perform some actions on the containable objects. This will return null on these legacy types that do not support this manager:

• BlogContentType
• DocumentContType
• ForumThreadContentType
• TaskContentType

Any new content type must return a valid instance.

Specified by:

getContainableTypeManager in interface ContainableType

Returns:

A manager that will perform some actions on the containable objects.

canViewType

public boolean canViewType()

setContainableTypeInfoProvider

public void setContainableTypeInfoProvider(ContainableTypeInfoProvider containableTypeInfoProvider)

getPermissionInfoProvider

public PermissionInfoProvider getPermissionInfoProvider()

Description copied from interface: PermissionEnabledObjectType

Returns a provider with details on permissions specific to this type.

Specified by:

getPermissionInfoProvider in interface PermissionEnabledObjectType

Returns:

a provider with details on permissions specific to this type.

setPermissionInfoProvider

public void setPermissionInfoProvider(PermissionInfoProvider permissionInfoProvider)

getProxyInfoProvider

public MediaProxyInfoProvider getProxyInfoProvider()

Description copied from interface: ProxiedType

A ProxyInfoProvider is a convenience meant to aid in retrieving information about any proxy implementation associate with the object type implementation.

Specified by:

getProxyInfoProvider in interface ProxiedMediaType

Specified by:

getProxyInfoProvider in interface ProxiedType

Returns:

the proxy info provider

setProxyInfoProvider

public void setProxyInfoProvider(MediaProxyInfoProvider proxyInfoProvider)

getContentNotificationProvider

public MediaNotificationProvider getContentNotificationProvider()

setContentNotificationProvider

public void setContentNotificationProvider(MediaNotificationProvider contentNotificationProvider)

getMoveContentProvider

public MoveContentProvider getMoveContentProvider()

setMoveContentProvider

public void setMoveContentProvider(MoveContentProvider moveContentProvider)

equals

public boolean equals(Object o)

Overrides:

equals in class Object