com.jivesoftware.community.objecttype
Interface MoveContentProvider<T extends JiveContentObject>

All Known Implementing Classes:

MoveMediaContentProvider

public interface MoveContentProvider<T extends JiveContentObject>

Provides implementation details allowing content object types to be moved between containers. Includes the implementation of moving the content, validating whether the content can be moved, and providing UI assistance to support com.jivesoftware.community.action.MoveContentAction displaying details of the validation error

See Also:

com.jivesoftware.community.action.MoveContentAction

Nested Class Summary

static class

MoveContentProvider.MoveValidationResult

Method Summary

MoveContentProvider.MoveValidationResult	canMoveContent(T toMove, JiveContainer target) Returns a MoveContentProvider.MoveValidationResult with the value of true if the content object to be moved is valid to be moved from its current container to the target container.
String	getPageDescriptionKey() Returns the i18n key to use to retrieve the text for the move content page description.
String	getPageTitleKey() Returns the i18n key to use to retrieve the text for the move content page title.
void	moveContent(T toMove, JiveContainer target) Moves the given content object from its current location to the target container

Method Detail

canMoveContent

MoveContentProvider.MoveValidationResult canMoveContent(T toMove,
                                                        JiveContainer target)

Returns a MoveContentProvider.MoveValidationResult with the value of true if the content object to be moved is valid to be moved from its current container to the target container. Returns a MoveContentProvider.MoveValidationResult with a value of false and a validationMessageKey containing an i18n key mapping to a description of the validation error.

Parameters:

toMove - content object to be moved

target - container to move content object into

Returns:

true if the content object can validly be moved

moveContent

void moveContent(T toMove,
                 JiveContainer target)
                 throws UnauthorizedException,
                        RejectedException

Moves the given content object from its current location to the target container

Parameters:

toMove - content object to be moved

target - container to move content object into

Throws:

UnauthorizedException - if the effective user doesn't have rights to move the content to the target container

RejectedException - if the move is rejected

getPageTitleKey

String getPageTitleKey()

Returns the i18n key to use to retrieve the text for the move content page title. Use by getPageTitle in com.jivesoftware.community.action.MoveContentAction. If null is returned a default key is retrieved.

Returns:

an i18n key matching the text for the page title

getPageDescriptionKey

String getPageDescriptionKey()

Returns the i18n key to use to retrieve the text for the move content page description. Use by getPageDescription in com.jivesoftware.community.action.MoveContentAction.

Returns:

an i18n key matching the text for the page description