com.openexchange.admin.plugins
Interface OXContextPluginInterface

public interface OXContextPluginInterface

Author:

choeger

Method Summary

void	change(Context ctx, Credentials auth) Define the operations which should be done before the real change process.
void	changeModuleAccess(Context ctx, String access_combination_name, Credentials auth) Define the operations which should be done before the real context changeModuleAccess process.
void	changeModuleAccess(Context ctx, UserModuleAccess access, Credentials auth) Define the operations which should be done before the real context changeModuleAccess process.
Boolean	checkMandatoryMembersContextCreate(Context ctx) Define if the mandatory members for a context create should be checked or not
void	delete(Context ctx, Credentials auth) Define the operations which should be done before the real context delete process.
void	disable(Context ctx, Credentials auth) Define the operations which should be done before the real context disable process.
void	disableAll(Credentials auth) Define the operations which should be done before the real context disableAll process.
void	downgrade(Context ctx, Credentials auth) Define the operations which should be done before the real context downgrade process.
void	enable(Context ctx, Credentials auth) Define the operations which should be done before the real context enable process.
void	enableAll(Credentials auth) Define the operations which should be done instead of the enableAll process if the credentials given are those from the master admin
	filter(Credentials auth) Return a Filter to optionally filter out contexts
String	getAccessCombinationName(Context ctx, Credentials auth) Define the operations which should be done before the real context getAccessCombinationName process.
List<OXCommonExtension>	getData(List<Context> ctx, Credentials auth) Define the operations which should be done after the real context getData process.
UserModuleAccess	getModuleAccess(Context ctx, Credentials auth) Define the operations which should be done before the real context getModuleAccess process.
	list(String search_pattern, Credentials auth) Return a Filter to load plugin specific data or null in case no specific data available
Context	postCreate(Context ctx, User admin_user, UserModuleAccess access, Credentials auth) Define the operations which should be done after the real context creation process.
Context	preCreate(Context ctx, User admin_user, Credentials auth) Define the operations which should be done before the real context creation process.

Method Detail

change

void change(Context ctx,
            Credentials auth)
            throws PluginException

Define the operations which should be done before the real change process.

Parameters:

ctx -

auth -

Throws:

PluginException

preCreate

Context preCreate(Context ctx,
                  User admin_user,
                  Credentials auth)
                  throws PluginException

Define the operations which should be done before the real context creation process.

Parameters:

ctx -

admin_user -

auth -

Returns:

An Context object must be returned. If nothing is done in the implementing method, the context object given in ctx should be returned.

Throws:

PluginException

postCreate

Context postCreate(Context ctx,
                   User admin_user,
                   UserModuleAccess access,
                   Credentials auth)
                   throws PluginException

Define the operations which should be done after the real context creation process.

Parameters:

ctx -

admin_user -

access -

auth -

Returns:

An Context object must be returned. If nothing is done in the implementing method, the context object given in ctx should be returned.

Throws:

PluginException

delete

void delete(Context ctx,
            Credentials auth)
            throws PluginException

Define the operations which should be done before the real context delete process.

Parameters:

ctx -

auth -

Throws:

PluginException

disable

void disable(Context ctx,
             Credentials auth)
             throws PluginException

Define the operations which should be done before the real context disable process.

Parameters:

ctx -

auth -

Throws:

PluginException

disableAll

void disableAll(Credentials auth)
                throws PluginException

Define the operations which should be done before the real context disableAll process.

Parameters:

auth -

Throws:

PluginException

enable

void enable(Context ctx,
            Credentials auth)
            throws PluginException

Define the operations which should be done before the real context enable process.

Parameters:

ctx -

auth -

Throws:

PluginException

enableAll

void enableAll(Credentials auth)
               throws PluginException

Define the operations which should be done instead of the enableAll process if the credentials given are those from the master admin

Parameters:

auth -

Throws:

PluginException

getData

List<OXCommonExtension> getData(List<Context> ctx,
                                Credentials auth)
                                throws PluginException

Define the operations which should be done after the real context getData process. Note that the real context getData process will only be called if the context object wasn't filled by a list operation before.

Parameters:

ctx -

auth -

Returns:

A List containing OXCommonExtension objects, this can be null.

Throws:

PluginException

list

 list(String search_pattern,
           Credentials auth)
           throws PluginException

Return a Filter to load plugin specific data or null in case no specific data available

Parameters:

search_pattern -

auth -

Returns:

Throws:

PluginException

filter

 filter(Credentials auth)
             throws PluginException

Return a Filter to optionally filter out contexts

Parameters:

auth -

Returns:

Throws:

PluginException

changeModuleAccess

void changeModuleAccess(Context ctx,
                        UserModuleAccess access,
                        Credentials auth)
                        throws PluginException

Define the operations which should be done before the real context changeModuleAccess process.

Parameters:

ctx -

access -

auth -

Throws:

PluginException

changeModuleAccess

void changeModuleAccess(Context ctx,
                        String access_combination_name,
                        Credentials auth)
                        throws PluginException

Define the operations which should be done before the real context changeModuleAccess process.

Parameters:

ctx -

access_combination_name -

auth -

Throws:

PluginException

downgrade

void downgrade(Context ctx,
               Credentials auth)
               throws PluginException

Define the operations which should be done before the real context downgrade process.

Parameters:

ctx -

auth -

Throws:

PluginException

getAccessCombinationName

String getAccessCombinationName(Context ctx,
                                Credentials auth)
                                throws PluginException

Define the operations which should be done before the real context getAccessCombinationName process.

Parameters:

ctx -

auth -

Returns:

Currently not used, so can be null

Throws:

PluginException

getModuleAccess

UserModuleAccess getModuleAccess(Context ctx,
                                 Credentials auth)
                                 throws PluginException

Define the operations which should be done before the real context getModuleAccess process.

Parameters:

ctx -

auth -

Returns:

Currently not used, so can be null

Throws:

PluginException

checkMandatoryMembersContextCreate

Boolean checkMandatoryMembersContextCreate(Context ctx)
                                           throws PluginException

Define if the mandatory members for a context create should be checked or not

Parameters:

ctx -

Returns:

If null or false are set, the check is ommitted otherwise the check is made

Throws:

PluginException