e4s.application.appmodule
Interface AEP_modifyClient_Intf

All Known Implementing Classes:

AEP_modifyClient_Impl

public interface AEP_modifyClient_Intf

Application exit point: creating or deleting a new client. This AEP is intended to insert or create aditional data into your database, or to validate if a client ID is valid.

See Also:

E4ModuleEditClient.setAEP(e4s.application.appmodule.AEP_modifyClient_Intf)

Method Summary

void	afterDelete(E4DBConnection_Intf con, E4ApplObj_Intf tmpApplobj, E4ApplObj_Intf currApplobj) Called within the delete process, with the possibility to cancel the deletion.
boolean	afterInsert(E4DBConnection_Intf con, E4ApplObj_Intf tmpApplobj, E4ApplObj_Intf applobj) Called within the create process, with the possibility to cancel the creation.
boolean	beforeDelete(E4Fieldset fieldset, E4ApplObj_Intf applobj) Called before the delete process, with the possibility to cancel the deletion.
E4CompanyGroup	defineGroup_ApplicationAdministrator() Get the permission for the application administrator.
E4CompanyGroup	defineGroup_SystemAdministrator() Get the permission for the system administrator.
java.lang.String	getGroupDesignation(E4CompanyGroup group) Get the designation for a new created group.
java.lang.String	getGroupRem(E4CompanyGroup group) Get the remark for a new created group.
E4CompanyGroup[]	getInitGroups() Get the permissions required initially for your application when creating a new client.
E4Label_Intf	validate(E4DBConnection_Intf con, E4ApplObj_Intf tmpApplobj, E4ApplObj_Intf currApplobj) Validate, if a given client can be used.

Method Detail

validate

E4Label_Intf validate(E4DBConnection_Intf con,
                      E4ApplObj_Intf tmpApplobj,
                      E4ApplObj_Intf currApplobj)
                      throws java.lang.Exception

Validate, if a given client can be used. This function is called immediatley after the input form for a new client.

Parameters:

con - the open and active database connection

tmpApplobj - the temporary application object - holding only the new client information, will be required to modify/create new data regarding the new client.

currApplobj - the current application object - might be riquired to gather user information

Returns:

null if o.k. or any message that will be displayed in the validator's field of the client input.

Throws:

java.lang.Exception

afterInsert

boolean afterInsert(E4DBConnection_Intf con,
                    E4ApplObj_Intf tmpApplobj,
                    E4ApplObj_Intf applobj)
                    throws java.lang.Exception

Called within the create process, with the possibility to cancel the creation. Place additional database tasks here that are required on new client creation.

Parameters:

con - the open and active database connection

tmpApplobj - the new input client

applobj - the current application object

Returns:

true if creation shall continue or false for termination

Throws:

java.lang.Exception

beforeDelete

boolean beforeDelete(E4Fieldset fieldset,
                     E4ApplObj_Intf applobj)
                     throws java.lang.Exception

Called before the delete process, with the possibility to cancel the deletion.

Parameters:

fieldset - the client data

applobj - the current application object

Returns:

true if deletion shall continue or false for termination

Throws:

java.lang.Exception

See Also:

AEP_UserDefFunction_Intf

afterDelete

void afterDelete(E4DBConnection_Intf con,
                 E4ApplObj_Intf tmpApplobj,
                 E4ApplObj_Intf currApplobj)
                 throws java.lang.Exception

Called within the delete process, with the possibility to cancel the deletion. Place additional database tasks here that are required on new client creation.

Parameters:

con - the open and active database connection

tmpApplobj - the temporary application object - holding only the new client information, will be required to modify/create new data regarding the new client.

currApplobj - the current application object - might be riquired to gather user information

Throws:

java.lang.Exception

getInitGroups

E4CompanyGroup[] getInitGroups()

Get the permissions required initially for your application when creating a new client.

Returns:

some persmissions required, including #definePermission_SystemAdministrator() and #definePermission_ApplicationAdministrator.

See Also:

E4ModuleEditClient.createClient_Save, #definePermission_SystemAdministrator(), #definePermission_ApplicationAdministrator()

defineGroup_SystemAdministrator

E4CompanyGroup defineGroup_SystemAdministrator()

Get the permission for the system administrator.

Returns:

the group used for creating the system administrator in function E4ModuleEditClient.createClient_Save which must be included in the result of getInitGroups().

See Also:

defineGroup_ApplicationAdministrator()

defineGroup_ApplicationAdministrator

E4CompanyGroup defineGroup_ApplicationAdministrator()

Get the permission for the application administrator.

Returns:

the group used for creating the system administrator in function E4ModuleEditClient.createClient_Save which must be included in the result of getInitGroups().

See Also:

defineGroup_SystemAdministrator()

getGroupDesignation

java.lang.String getGroupDesignation(E4CompanyGroup group)

Get the designation for a new created group.

Returns:

the designation or null if not available

getGroupRem

java.lang.String getGroupRem(E4CompanyGroup group)

Get the remark for a new created group.

Returns:

the remark or null if not available