com.openexchange.admin.plugins
Interface OXContextPluginInterface
public interface OXContextPluginInterface
- Author:
- choeger
Method Summary |
void |
change(Context ctx,
Credentials auth)
|
void |
changeModuleAccess(Context ctx,
java.lang.String access_combination_name,
Credentials auth)
|
void |
changeModuleAccess(Context ctx,
UserModuleAccess access,
Credentials auth)
|
java.lang.Boolean |
checkMandatoryMembersContextCreate(Context ctx)
|
void |
delete(Context ctx,
Credentials auth)
|
void |
disable(Context ctx,
Credentials auth)
|
void |
disableAll(Credentials auth)
|
void |
downgrade(Context ctx,
Credentials auth)
|
void |
enable(Context ctx,
Credentials auth)
|
void |
enableAll(Credentials auth)
|
java.lang.String |
getAccessCombinationName(Context ctx,
Credentials auth)
|
java.util.List<OXCommonExtension> |
getData(java.util.List<Context> ctx,
Credentials auth)
|
UserModuleAccess |
getModuleAccess(Context ctx,
Credentials auth)
|
SQLQueryExtension |
list(java.lang.String search_pattern,
Credentials auth)
This method only returns how the core list query must be extended, the final data for a context is fetched by
the #getData(Context, Credentials) method which must eventually enhance the data in the context object. |
Context |
postCreate(Context ctx,
User admin_user,
UserModuleAccess access,
Credentials auth)
|
Context |
preCreate(Context ctx,
User admin_user,
Credentials auth)
|
change
void change(Context ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
preCreate
Context preCreate(Context ctx,
User admin_user,
Credentials auth)
throws PluginException
- Throws:
PluginException
postCreate
Context postCreate(Context ctx,
User admin_user,
UserModuleAccess access,
Credentials auth)
throws PluginException
- Throws:
PluginException
delete
void delete(Context ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
disable
void disable(Context ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
disableAll
void disableAll(Credentials auth)
throws PluginException
- Throws:
PluginException
enable
void enable(Context ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
enableAll
void enableAll(Credentials auth)
throws PluginException
- Throws:
PluginException
getData
java.util.List<OXCommonExtension> getData(java.util.List<Context> ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
list
SQLQueryExtension list(java.lang.String search_pattern,
Credentials auth)
throws PluginException
- This method only returns how the core list query must be extended, the final data for a context is fetched by
the
#getData(Context, Credentials)
method which must eventually enhance the data in the context object.
This method must return null if no changes must be made to the core sql query.
- Parameters:
search_pattern
- auth
-
- Returns:
-
- Throws:
PluginException
changeModuleAccess
void changeModuleAccess(Context ctx,
UserModuleAccess access,
Credentials auth)
throws PluginException
- Throws:
PluginException
changeModuleAccess
void changeModuleAccess(Context ctx,
java.lang.String access_combination_name,
Credentials auth)
throws PluginException
- Throws:
PluginException
downgrade
void downgrade(Context ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
getAccessCombinationName
java.lang.String getAccessCombinationName(Context ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
getModuleAccess
UserModuleAccess getModuleAccess(Context ctx,
Credentials auth)
throws PluginException
- Throws:
PluginException
checkMandatoryMembersContextCreate
java.lang.Boolean checkMandatoryMembersContextCreate(Context ctx)
throws PluginException
- Throws:
PluginException