Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


oracle.webcenter.spaces.operations
Interface GroupSpaceOpsHandlerPlugin

All Known Implementing Classes:
BaseGroupSpaceOpsHandlerPlugin

public interface GroupSpaceOpsHandlerPlugin

This class represents the group spaces CRUD related operations. This class is an interface for CRUD related operations for the group space. 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
 boolean duringCreateGroupSpace(SpaceTemplate baseTemplate, Space space, SpaceCreationOptions option)
          This API represents all the steps that are required to be performed when the create space is in progress and this step will be performed after the preplugin and will run in parallel with the create space process.
 boolean postCreateGroupSpace(SpaceTemplate baseTemplate, Space space)
          This API represents all the steps that are required to be performed after creating the group space by different plugins.
 boolean postCreateGroupSpace(SpaceTemplate baseTemplate, Space space, SpaceCreationOptions option)
          This API represents all the steps that are required to be performed after creating the group space by different plugins.
 boolean postDeleteGroupSpace(Space space)
          This API represents all the steps that are required to be performed after deleting the group space by different plugins.
 boolean postRenameGroupSpace(java.lang.String oldSpaceName, java.lang.String newSpaceName)
          This API represents all the steps that are required to be performed after renaming the group space by different plugins.
 boolean preCreateGroupSpace(SpaceTemplate baseTemplate, Space space)
          This API represents all the steps that are required to be performed before creating the group space by different plugins.
 boolean preDeleteGroupSpace(Space space)
          This API represents all the steps that are required to be performed before deleting the group space by different plugins.
 boolean preRenameGroupSpace(java.lang.String oldSpaceName, java.lang.String newSpaceName)
          This API represents all the steps that are required to be performed before renaming the group space by different plugins.
 boolean rollbackCreateGroupSpace(SpaceTemplate baseTemplate, Space space)
          This API does the rollback of postCreate of Group Space.
 boolean rollbackDeleteGroupSpace(Space space)
          This API does the rollback of postDelete of Group Space.
 boolean rollbackRenameGroupSpace(java.lang.String oldSpaceName, java.lang.String newSpaceName)
          This API does the rollback of postRename of Group Space.

 

Method Detail

preCreateGroupSpace

boolean preCreateGroupSpace(SpaceTemplate baseTemplate,
                            Space space)
                            throws GroupSpaceOpsException
This API represents all the steps that are required to be performed before creating the group space by different plugins. In this step, it is expected that the implementation performs the basic validation before creating a group space.
Parameters:
baseTemplate - Base Template Name
space - Space Name
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored

postCreateGroupSpace

boolean postCreateGroupSpace(SpaceTemplate baseTemplate,
                             Space space)
                             throws GroupSpaceOpsException
This API represents all the steps that are required to be performed after creating the group space by different plugins. In this step, it is expected that the implementation performs the actual operation once the group space is created.
Parameters:
baseTemplate - Base Template Name
space - Space Name
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored

postCreateGroupSpace

boolean postCreateGroupSpace(SpaceTemplate baseTemplate,
                             Space space,
                             SpaceCreationOptions option)
                             throws GroupSpaceOpsException
This API represents all the steps that are required to be performed after creating the group space by different plugins. In this step, it is expected that the implementation performs the actual operation once the group space is created.
Parameters:
baseTemplate - Base Template Name
space - The new Space being created
option - SpaceCreationOptions contains values like accesslevels, displayName etc which will be set during space creation
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpaceOpsIgnorableException when the errors can be ignored

duringCreateGroupSpace

boolean duringCreateGroupSpace(SpaceTemplate baseTemplate,
                               Space space,
                               SpaceCreationOptions option)
                               throws GroupSpaceOpsException
This API represents all the steps that are required to be performed when the create space is in progress and this step will be performed after the preplugin and will run in parallel with the create space process.
Parameters:
baseTemplate - Base Template Name
space - Space Name
option - SpaceCreationOptions contains values like accesslevels, displayName etc which will be set during space creation
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpaceOpsIgnorableException when the errors can be ignored

rollbackCreateGroupSpace

boolean rollbackCreateGroupSpace(SpaceTemplate baseTemplate,
                                 Space space)
                                 throws GroupSpaceOpsRollbackException
This API does the rollback of postCreate of Group Space. This should be called after post create. The implementation of this method must perform the rollback for create group space. It should roll back all the steps.
Parameters:
baseTemplate - Base Template Name
space - Space Name
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored
GroupSpaceOpsRollbackException

preDeleteGroupSpace

boolean preDeleteGroupSpace(Space space)
                            throws GroupSpaceOpsException
This API represents all the steps that are required to be performed before deleting the group space by different plugins. In this step, it is expected that the implementation performs the basic validation before deleting a group space
Parameters:
space - Space
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored Throws GroupSpacesRollbackException when the roll back fails. This exception can be ignored

postDeleteGroupSpace

boolean postDeleteGroupSpace(Space space)
                             throws GroupSpaceOpsException
This API represents all the steps that are required to be performed after deleting the group space by different plugins. In this step, it is expected that the implementation performs the actual operation once the group space is deleted.
Parameters:
space - Space
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored

rollbackDeleteGroupSpace

boolean rollbackDeleteGroupSpace(Space space)
                                 throws GroupSpaceOpsRollbackException
This API does the rollback of postDelete of Group Space. This should be called after post delete. The implementation of this method must perform the rollback for create group space. It should roll back all the steps.
Parameters:
space - Space
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored Throws GroupSpacesRollbackException when the roll back fails. This exception can be ignored
GroupSpaceOpsRollbackException

preRenameGroupSpace

boolean preRenameGroupSpace(java.lang.String oldSpaceName,
                            java.lang.String newSpaceName)
                            throws GroupSpaceOpsException
This API represents all the steps that are required to be performed before renaming the group space by different plugins. In this step, it is expected that the implementation performs the basic validation before renaming a group space
Parameters:
oldSpaceName - Old Space Name
newSpaceName - New Space Name
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored

postRenameGroupSpace

boolean postRenameGroupSpace(java.lang.String oldSpaceName,
                             java.lang.String newSpaceName)
                             throws GroupSpaceOpsException
This API represents all the steps that are required to be performed after renaming the group space by different plugins. In this step, it is expected that the implementation performs the actual operation once the group space is renamed.
Parameters:
oldSpaceName - Old Space Name
newSpaceName - New Space Name
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored

rollbackRenameGroupSpace

boolean rollbackRenameGroupSpace(java.lang.String oldSpaceName,
                                 java.lang.String newSpaceName)
                                 throws GroupSpaceOpsException
This API does the rollback of postRename of Group Space. This should be called after post Rename. The implementation of this method must perform the rollback for rename group space. It should roll back all the steps.
Parameters:
oldSpaceName - Old Space Name
newSpaceName - New Space Name
Throws:
GroupSpaceOpsException - Throws GroupSpaceOpsException when pre-configuration fails. Throws GroupSpacesOpsIgnorableException when the errors can be ignored Throws GroupSpacesRollbackException when the roll back fails. This exception can be ignored

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.