com.adobe.cq.social.scf

Interface OperationService<T extends OperationExtension,U extends Operation,S>

Type Parameters:

T - the specific type of OperationExtension supported by this service.

U - the specific set of operations supported by this service.

S - the object representing the resource/component that the service was performed on.

All Known Implementing Classes:

AbstractCommentOperationService, AbstractCommunityGroupOperationService, AbstractCommunityMemberGroupProfileOperationService, AbstractEnablementLearningPathModelOperationService, AbstractEnablementResourceModelOperationService, AbstractFollowingOperationService, AbstractForumOperationsService, AbstractNotificationOperationService, AbstractOperationService, com.adobe.cq.social.site.endpoints.AbstractPublishOperationService, AbstractSubscriptionCollectionOperationService

public interface OperationService<T extends OperationExtension,U extends Operation,S>

A service that support OperationExtentions.

Method Summary

Modifier and Type	Method and Description
void	addOperationExtension(T extension) add an OperationExtension to the list of operation extensions used by this service.
InheritedOperationExtensionManager	getInheritedOperationExtensionManager() Get the InheritedOperationExtensionManager which allows parent extension to be executed as part of the operation.
void	performAfterActions(U operation, Session session, S component, java.util.Map<java.lang.String,java.lang.Object> requestParameters) perform all after actions supplied by the added operations extensions for a given operation.
void	performBeforeActions(U operation, Session session, Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParameters) perform all before actions supplied by the added operations extensions for a given operation.
void	removeOperationExtension(T extension) remove an OperationExtension from the list of operation extensions used by this service.

Method Detail

addOperationExtension

void addOperationExtension(T extension)

add an OperationExtension to the list of operation extensions used by this service.

Parameters:

extension - an OperationExtension that will be called before and after operations are performed.

removeOperationExtension

void removeOperationExtension(T extension)

remove an OperationExtension from the list of operation extensions used by this service.

Parameters:

extension - the OperationExtension that should be removed from the list of operation extenstions used by this service.

getInheritedOperationExtensionManager

InheritedOperationExtensionManager getInheritedOperationExtensionManager()

Get the InheritedOperationExtensionManager which allows parent extension to be executed as part of the operation.

Returns:

extensionManager

performBeforeActions

void performBeforeActions(U operation,
                          Session session,
                          Resource resource,
                          java.util.Map<java.lang.String,java.lang.Object> requestParameters)
                   throws OperationException

perform all before actions supplied by the added operations extensions for a given operation.

Parameters:

operation - the operation for which before actions needs to be performed.

session - the session that is being used to perform the operation.

resource - the resource on which the operation is being performed.

requestParameters - the parameters that have been passed as part of the request to perform the operation.

Throws:

OperationException - thrown if any one of the operations extensions throws an exception. This aborts the operations.

performAfterActions

void performAfterActions(U operation,
                         Session session,
                         S component,
                         java.util.Map<java.lang.String,java.lang.Object> requestParameters)
                  throws OperationException

perform all after actions supplied by the added operations extensions for a given operation.

Parameters:

operation - the operation for which after actions needs to be performed.

session - the session that is being used to perform the operation.

component - the resource on which the operation is being performed.

requestParameters - the parameters that have been passed as part of the request to perform the operation.

Throws:

OperationException - thrown if any one of the operations extensions throws an exception.