|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OXContextPluginInterface
Method Summary | |
---|---|
void |
change(Context ctx,
Credentials auth)
Define the operations which should be done before the real change process. |
void |
changeModuleAccess(Context ctx,
java.lang.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. |
java.lang.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 |
java.lang.String |
getAccessCombinationName(Context ctx,
Credentials auth)
Define the operations which should be done before the real context getAccessCombinationName process. |
java.util.List<OXCommonExtension> |
getData(java.util.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. |
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)
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 |
---|
void change(Context ctx, Credentials auth) throws PluginException
ctx
- auth
-
PluginException
Context preCreate(Context ctx, User admin_user, Credentials auth) throws PluginException
ctx
- admin_user
- auth
-
Context
object must be returned. If nothing is done
in the implementing method, the context object given in
ctx
should be returned.
PluginException
Context postCreate(Context ctx, User admin_user, UserModuleAccess access, Credentials auth) throws PluginException
ctx
- admin_user
- access
- auth
-
Context
object must be returned. If nothing is done
in the implementing method, the context object given in
ctx
should be returned.
PluginException
void delete(Context ctx, Credentials auth) throws PluginException
ctx
- auth
-
PluginException
void disable(Context ctx, Credentials auth) throws PluginException
ctx
- auth
-
PluginException
void disableAll(Credentials auth) throws PluginException
auth
-
PluginException
void enable(Context ctx, Credentials auth) throws PluginException
ctx
- auth
-
PluginException
void enableAll(Credentials auth) throws PluginException
auth
-
PluginException
java.util.List<OXCommonExtension> getData(java.util.List<Context> ctx, Credentials auth) throws PluginException
ctx
- auth
-
List
containing OXCommonExtension
objects,
this can be null.
PluginException
SQLQueryExtension list(java.lang.String search_pattern, Credentials auth) throws PluginException
#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.
search_pattern
- auth
-
PluginException
void changeModuleAccess(Context ctx, UserModuleAccess access, Credentials auth) throws PluginException
ctx
- access
- auth
-
PluginException
void changeModuleAccess(Context ctx, java.lang.String access_combination_name, Credentials auth) throws PluginException
ctx
- access_combination_name
- auth
-
PluginException
void downgrade(Context ctx, Credentials auth) throws PluginException
ctx
- auth
-
PluginException
java.lang.String getAccessCombinationName(Context ctx, Credentials auth) throws PluginException
ctx
- auth
-
PluginException
UserModuleAccess getModuleAccess(Context ctx, Credentials auth) throws PluginException
ctx
- auth
-
PluginException
java.lang.Boolean checkMandatoryMembersContextCreate(Context ctx) throws PluginException
ctx
-
PluginException
|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |