oracle.webcenter.spaces.operations.templates

Interface GroupSpaceTemplateOpsHandlerPlugin

public interface GroupSpaceTemplateOpsHandlerPlugin

This class represents the group space template CRUD related operations. This class is an interface for CRUD related operations for the group space template. It contains three different types of methods,which represent different stages of the transaction. pre/post and rollback. Pre - operation must perform all the validation related checks, post - operation would do all the important steps whereas rollback-operation performs rollbacking of the post-operation.

Method Summary

Modifier and Type	Method and Description
boolean	postCreateGroupSpaceTemplate(Space baseSpace, SpaceTemplate template) This API represents all the steps that are required to be performed after creating the group space template by different plugins.
boolean	postDeleteGroupSpaceTemplate(SpaceTemplate template) This API represents all the steps that are required to be performed after deleting the group space template by different plugins.
boolean	preCreateGroupSpaceTemplate(Space baseSpace, SpaceTemplate template) This API represents all the steps that are required to be performed before creating the group space template by different plugins.
boolean	preDeleteGroupSpaceTemplate(SpaceTemplate template) This API represents all the steps that are required to be performed before deleting the group space template by different plugins.
boolean	rollbackCreateGroupSpaceTemplate(Space baseSpace, SpaceTemplate template) This API does the rollback of postCreate of Group Space Template.
boolean	rollbackDeleteGroupSpaceTemplate(SpaceTemplate template) This API does the rollback of postDelete of Group Space Template.

Method Detail

preCreateGroupSpaceTemplate

boolean preCreateGroupSpaceTemplate(Space baseSpace,
                                    SpaceTemplate template)
                             throws GroupSpaceOpsException

This API represents all the steps that are required to be performed before creating the group space template by different plugins. In this step, it is expected that the implementation performs the basic validation before creating a group space template.

Parameters:

baseSpace - Base Group Space

template - Template being created

Throws:

GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails.

postCreateGroupSpaceTemplate

boolean postCreateGroupSpaceTemplate(Space baseSpace,
                                     SpaceTemplate template)
                              throws GroupSpaceOpsException

This API represents all the steps that are required to be performed after creating the group space template by different plugins. In this step, it is expected that the implementation performs the actual operation once the group space template is created.

Parameters:

baseSpace - Base Group Space Object

template - New template being created

Throws:

GroupSpaceOpsExcieption - Throws GroupSpaceOpsException when pre-configuration fails.

GroupSpaceOpsException

rollbackCreateGroupSpaceTemplate

boolean rollbackCreateGroupSpaceTemplate(Space baseSpace,
                                         SpaceTemplate template)
                                  throws GroupSpaceOpsRollbackException

This API does the rollback of postCreate of Group Space Template. This should be called after post create. The implementation of this method must perform the rollback for create group space template. It should roll back all the steps.

Parameters:

baseSpace - Base Group Space Object

template - Space Template Object

Throws:

GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails.

GroupSpaceOpsRollbackException

preDeleteGroupSpaceTemplate

boolean preDeleteGroupSpaceTemplate(SpaceTemplate template)
                             throws GroupSpaceOpsException

This API represents all the steps that are required to be performed before deleting the group space template by different plugins. In this step, it is expected that the implementation performs the basic validation before deleting a group space template

Parameters:

template - SpaceTemplate

Throws:

GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesRollbackException when the roll back fails. This exception can be ignored

postDeleteGroupSpaceTemplate

boolean postDeleteGroupSpaceTemplate(SpaceTemplate template)
                              throws GroupSpaceOpsException

This API represents all the steps that are required to be performed after deleting the group space template by different plugins. In this step, it is expected that the implementation performs the actual operation once the group space template is deleted.

Parameters:

template - SpaceTemplate

Throws:

GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails.

rollbackDeleteGroupSpaceTemplate

boolean rollbackDeleteGroupSpaceTemplate(SpaceTemplate template)
                                  throws GroupSpaceOpsRollbackException

This API does the rollback of postDelete of Group Space Template. This should be called after post delete. The implementation of this method must perform the rollback for delete group space template. It should roll back all the steps.

Parameters:

template - SpaceTemplate

Throws:

GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesRollbackException when the roll back fails. This exception can be ignored

GroupSpaceOpsRollbackException