com.engiweb.profilemanager.common.interfaces

Interface IApplication

All Superinterfaces:

com.engiweb.toolkit.interfaces.IEjb

public interface IApplication
extends com.engiweb.toolkit.interfaces.IEjb

The IApplication interface allows a client to retrieve and manage all information about application objects

Author:

CrossIdeas developer group

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Copyright

Method Summary

Modifier and Type	Method and Description
void	addExtRoleChild(com.engiweb.pm.entity.BeanList<EntitlementBean> entitlementBeanList, EntitlementBean parentExtRole, java.lang.String cod_oper, java.lang.String token, java.lang.String realm)
void	addProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean, ApplicationBean applicationBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a list of properties to an application
void	delete(ApplicationBean applicationBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Deletes an existing application
void	deleteExternalRole(EntitlementBean entitlementBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm)
void	deleteFuntionalityType(FunctionalityTypeBean funtcTypeBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Deletes an existing functionality type
com.engiweb.pm.entity.BeanList<ApplicationBean>	find(ApplicationBean applicationBean, PropertyBean propertyBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of applications filtered by a passed ApplicationBean object and a PropertyBean
com.engiweb.pm.entity.BeanList<EntitlementBean>	findEntitlement(EntitlementBean entitlementBean, ApplicationBean applicationBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of entitlements assigned to an application
com.engiweb.pm.entity.BeanList<EntitlementBean>	findEntitlementByFunctType(EntitlementBean entitlementBean, FunctionalityTypeBean functBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of entitlement assigned to an functionality type
com.engiweb.pm.entity.BeanList<EntitlementBean>	findEntitlementByGroup(EntitlementBean entitlementBean, GroupBean groupBean, HierarchyBean hierarchyBean, ApplicationBean applicationBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of entitlemens assigned to an application in the given group
com.engiweb.pm.entity.BeanList<EntitlementBean>	findEntitlementByOrgUnit(EntitlementBean entitlementBean, OrgUnitBean ouBean, ApplicationBean applicationBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Deprecated. Replaced by findEntitlementByGroup(EntitlementBean, GroupBean, HierarchyBean, ApplicationBean, boolean, Paging, String, String) Returns a list of entitlemens assigned to an application in the given organization unit
com.engiweb.pm.entity.BeanList<EntitlementBean>	findExtRole(EntitlementBean entitlementBean, ApplicationBean applicationBean, java.lang.Boolean isFulFilled, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) This method find External Roles.
com.engiweb.pm.entity.BeanList<FunctionalityTypeBean>	findFunctionalityType(FunctionalityTypeBean functTypeBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of functionality types filtered by a passed FunctionalityTypeBean object
com.engiweb.pm.entity.BeanList<GroupBean>	findGroup(GroupBean groupBean, HierarchyBean hierarchyBean, ApplicationBean applicationBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm)
GroupCBean	findGroupHier(EntitlementBean entitlementBean, GroupBean groupFilterBean, HierarchyBean hierarchyBean, GroupBean groupStartBean, ApplicationBean applicationBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns groups in hierarchy with the selected filters
com.engiweb.pm.entity.BeanList<ApplicationBean>	findMissingApplicationForUser(ApplicationBean applicationBean, UserBean userBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of applications that have not yet been assigned to the user
com.engiweb.pm.entity.BeanList<EntitlementBean>	findMissingEntitlementForGroup(EntitlementBean entitlementBean, ApplicationBean applicationBean, GroupBean groupBean, HierarchyBean hierarchyBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm)
com.engiweb.pm.entity.BeanList<EntitlementBean>	findMissingEntitlementForOU(EntitlementBean entitlementBean, ApplicationBean applicationBean, OrgUnitBean ouBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Deprecated. Replaced by IApplication#findMissingEntitlementForGroup(EntitlementBean, ApplicationBean, GroupBean, Paging, String, String)
com.engiweb.pm.entity.BeanList<EntitlementBean>	findMissingEntitlementsForUser(EntitlementBean entitlementBean, ApplicationBean applicationBean, UserBean userBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of entitlemens that have not yet been assigned to the user
com.engiweb.pm.entity.BeanList<FunctionalityTypeBean>	findNoAdministrativeFuncType(FunctionalityTypeBean functTypeBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of functionality types filtered by no administrative application and a passed FunctionalityTypeBean object
com.engiweb.pm.entity.BeanList<?>	findOU(OrgUnitBean orgUnitBean, ApplicationBean applicationBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Deprecated. Replaced by findGroup(GroupBean, HierarchyBean, ApplicationBean, Paging, String, String) Return a list organization unit with entitlements assigned to an application
OrgUnitCBean	findOuHier(EntitlementBean entitlementBean, OrgUnitBean orgUnitFilterBean, OrgUnitBean orgUnitStartBean, ApplicationBean applicationBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Deprecated. Replaced by findGroupHier(EntitlementBean, GroupBean, HierarchyBean, GroupBean, ApplicationBean, Paging, String, String) Returns organization units in hierarchy with the selected filters
com.engiweb.pm.entity.BeanList<PropertyBean>	findProperty(PropertyBean propertyBean, ApplicationBean applicationBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of properties assigned to an application
com.engiweb.pm.entity.BeanList<UserBean>	findUser(UserBean userBean, GroupBean groupBean, HierarchyBean hierarchyBean, ApplicationBean applicationBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of users assigned to an application in the given group
com.engiweb.pm.entity.BeanList<UserBean>	findUser(UserBean userBean, OrgUnitBean ouBean, ApplicationBean applicationBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Deprecated. Replaced by findUser(UserBean, GroupBean, HierarchyBean, ApplicationBean, boolean, Paging, String, String) Returns a list of users assigned to an application in the given organization unit
void	fulfillEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> bl, java.lang.String codOper, java.lang.String token, java.lang.String realm)
ApplicationBean	insert(ApplicationBean applicationBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a new application if it not exists yet.
EntitlementBean	insertExternalRole(EntitlementBean entitlementBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) This method creates an External Role.
FunctionalityTypeBean	insertFuntionalityType(FunctionalityTypeBean funtcTypeBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a new functionality type if it not exists yet.
void	modifyProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean, ApplicationBean applicationBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Updates a list of properties of an application
void	removeExtRoleChild(EntitlementBean childEntitlement, EntitlementBean parentExtRole, java.lang.String cod_oper, java.lang.String token, java.lang.String realm)
void	removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean, ApplicationBean applicationBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Removes a list of properties from an application
void	unFulfillEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> bl, java.lang.String codOper, java.lang.String token, java.lang.String realm)
ApplicationBean	update(ApplicationBean applicationBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Updates an existing application
FunctionalityTypeBean	updateFuntionalityType(FunctionalityTypeBean functTypeBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Updates an existing functionality type

Methods inherited from interface com.engiweb.toolkit.interfaces.IEjb

checkAB

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

Copyright

See Also:

Constant Field Values

Method Detail

insert

ApplicationBean insert(ApplicationBean applicationBean,
                       java.lang.String cod_oper,
                       java.lang.String token,
                       java.lang.String realm)
                throws com.engiweb.toolkit.common.BackendException

Adds a new application if it not exists yet.

Parameters:

applicationBean - ApplicationBean to insert (mandatory). The application name is a mandatory field.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Returns:

ApplicationBean created

Throws:

com.engiweb.toolkit.common.BackendException

update

ApplicationBean update(ApplicationBean applicationBean,
                       java.lang.String cod_oper,
                       java.lang.String token,
                       java.lang.String realm)
                throws com.engiweb.toolkit.common.BackendException

Updates an existing application

Parameters:

applicationBean - ApplicationBean to update (mandatory).It must be present and uniquely defined.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Returns:

ApplicationBean modified

Throws:

com.engiweb.toolkit.common.BackendException

delete

void delete(ApplicationBean applicationBean,
            java.lang.String cod_oper,
            java.lang.String token,
            java.lang.String realm)
     throws com.engiweb.toolkit.common.BackendException

Deletes an existing application

Parameters:

applicationBean - ApplicationBean to update (mandatory).It must be present and uniquely defined.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

find

com.engiweb.pm.entity.BeanList<ApplicationBean> find(ApplicationBean applicationBean,
                                                     PropertyBean propertyBean,
                                                     com.engiweb.pm.entity.Paging paging,
                                                     java.lang.String token,
                                                     java.lang.String realm)
                                              throws com.engiweb.toolkit.common.BackendException

Returns a list of applications filtered by a passed ApplicationBean object and a PropertyBean

Parameters:

applicationBean - ApplicationBean if null no filter is applied, otherwise the passed object is used as filter

propertyBean - PropertyBean if null no filter is applied, otherwise the passed object is used as filter

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of ApplicationBean

Throws:

com.engiweb.toolkit.common.BackendException

insertFuntionalityType

FunctionalityTypeBean insertFuntionalityType(FunctionalityTypeBean funtcTypeBean,
                                             java.lang.String cod_oper,
                                             java.lang.String token,
                                             java.lang.String realm)
                                      throws com.engiweb.toolkit.common.BackendException

Adds a new functionality type if it not exists yet.

Parameters:

funtcTypeBean - FunctionalityTypeBean to insert (mandatory). The functionality type name is a mandatory field.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Returns:

FunctionalityTypeBean created

Throws:

com.engiweb.toolkit.common.BackendException

updateFuntionalityType

FunctionalityTypeBean updateFuntionalityType(FunctionalityTypeBean functTypeBean,
                                             java.lang.String cod_oper,
                                             java.lang.String token,
                                             java.lang.String realm)
                                      throws com.engiweb.toolkit.common.BackendException

Updates an existing functionality type

Parameters:

functTypeBean - FunctionalityTypeBean to update (mandatory).It must be present and uniquely defined.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Returns:

FunctionalityTypeBean modified

Throws:

com.engiweb.toolkit.common.BackendException

deleteFuntionalityType

void deleteFuntionalityType(FunctionalityTypeBean funtcTypeBean,
                            java.lang.String cod_oper,
                            java.lang.String token,
                            java.lang.String realm)
                     throws com.engiweb.toolkit.common.BackendException

Deletes an existing functionality type

Parameters:

funtcTypeBean - FunctionalityTypeBean to delete (mandatory).It must be present and uniquely defined.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

findFunctionalityType

com.engiweb.pm.entity.BeanList<FunctionalityTypeBean> findFunctionalityType(FunctionalityTypeBean functTypeBean,
                                                                            com.engiweb.pm.entity.Paging paging,
                                                                            java.lang.String token,
                                                                            java.lang.String realm)
                                                                     throws com.engiweb.toolkit.common.BackendException

Returns a list of functionality types filtered by a passed FunctionalityTypeBean object

Parameters:

functTypeBean - if null no filter is applied, otherwise the passed object is used as filter

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of FunctionalityTypeBean

Throws:

com.engiweb.toolkit.common.BackendException

findNoAdministrativeFuncType

com.engiweb.pm.entity.BeanList<FunctionalityTypeBean> findNoAdministrativeFuncType(FunctionalityTypeBean functTypeBean,
                                                                                   com.engiweb.pm.entity.Paging paging,
                                                                                   java.lang.String token,
                                                                                   java.lang.String realm)
                                                                            throws com.engiweb.toolkit.common.BackendException

Returns a list of functionality types filtered by no administrative application and a passed FunctionalityTypeBean object

Parameters:

functTypeBean - if null no filter is applied, otherwise the passed object is used as filter

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of FunctionalityTypeBean

Throws:

com.engiweb.toolkit.common.BackendException

addProperties

void addProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                   ApplicationBean applicationBean,
                   java.lang.String cod_oper,
                   java.lang.String token,
                   java.lang.String realm)
            throws com.engiweb.toolkit.common.BackendException

Adds a list of properties to an application

Parameters:

blPropertyBean - BeanList of PropertyBean to add to application

applicationBean - ApplicationBean to add the properties. It must be present and uniquely defined.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

modifyProperties

void modifyProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                      ApplicationBean applicationBean,
                      java.lang.String cod_oper,
                      java.lang.String token,
                      java.lang.String realm)
               throws com.engiweb.toolkit.common.BackendException

Updates a list of properties of an application

Parameters:

blPropertyBean - BeanList of PropertyBean to update to application.

applicationBean - ApplicationBean with the properties that must be updates. It must be present and uniquely defined.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

removeProperties

void removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                      ApplicationBean applicationBean,
                      java.lang.String cod_oper,
                      java.lang.String token,
                      java.lang.String realm)
               throws com.engiweb.toolkit.common.BackendException

Removes a list of properties from an application

Parameters:

blPropertyBean - BeanList of PropertyBean to remove from application.

applicationBean - ApplicationBean with the properties that must be removed. It must be present and uniquely defined.

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

findProperty

com.engiweb.pm.entity.BeanList<PropertyBean> findProperty(PropertyBean propertyBean,
                                                          ApplicationBean applicationBean,
                                                          com.engiweb.pm.entity.Paging paging,
                                                          java.lang.String token,
                                                          java.lang.String realm)
                                                   throws com.engiweb.toolkit.common.BackendException

Returns a list of properties assigned to an application

Parameters:

propertyBean - if null no filter is applied, otherwise the passed object is used as filter

applicationBean - ApplicationBean with the properties that must be searched. It must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of FunctionalityTypeBean

Throws:

com.engiweb.toolkit.common.BackendException

findEntitlement

com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entitlementBean,
                                                                ApplicationBean applicationBean,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                java.lang.String token,
                                                                java.lang.String realm)
                                                         throws com.engiweb.toolkit.common.BackendException

Returns a list of entitlements assigned to an application

Parameters:

entitlementBean - if null no filter is applied, otherwise the passed object is used as filter

applicationBean - ApplicationBean with the entitlements that must be searched. It must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of EntitlementBean

Throws:

com.engiweb.toolkit.common.BackendException

fulfillEntitlement

void fulfillEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> bl,
                        java.lang.String codOper,
                        java.lang.String token,
                        java.lang.String realm)
                 throws com.engiweb.toolkit.common.BackendException

Throws:

com.engiweb.toolkit.common.BackendException

unFulfillEntitlement

void unFulfillEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> bl,
                          java.lang.String codOper,
                          java.lang.String token,
                          java.lang.String realm)
                   throws com.engiweb.toolkit.common.BackendException

Throws:

com.engiweb.toolkit.common.BackendException

findMissingApplicationForUser

com.engiweb.pm.entity.BeanList<ApplicationBean> findMissingApplicationForUser(ApplicationBean applicationBean,
                                                                              UserBean userBean,
                                                                              com.engiweb.pm.entity.Paging paging,
                                                                              java.lang.String token,
                                                                              java.lang.String realm)
                                                                       throws com.engiweb.toolkit.common.BackendException

Returns a list of applications that have not yet been assigned to the user

Parameters:

applicationBean - if null no filter is applied, otherwise the passed object is used as filter

userBean - UserBean must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

Un BeanList di ApplicationBean

Throws:

com.engiweb.toolkit.common.BackendException

findMissingEntitlementsForUser

com.engiweb.pm.entity.BeanList<EntitlementBean> findMissingEntitlementsForUser(EntitlementBean entitlementBean,
                                                                               ApplicationBean applicationBean,
                                                                               UserBean userBean,
                                                                               com.engiweb.pm.entity.Paging paging,
                                                                               java.lang.String token,
                                                                               java.lang.String realm)
                                                                        throws com.engiweb.toolkit.common.BackendException

Returns a list of entitlemens that have not yet been assigned to the user

Parameters:

entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter

applicationBean - ApplicationBean if null no filter is applied, otherwise the passed object is used as filter

userBean - UserBean must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

Un BeanList di EntitlementBean

Throws:

com.engiweb.toolkit.common.BackendException

findMissingEntitlementForOU

@Deprecated
com.engiweb.pm.entity.BeanList<EntitlementBean> findMissingEntitlementForOU(EntitlementBean entitlementBean,
                                                                                        ApplicationBean applicationBean,
                                                                                        OrgUnitBean ouBean,
                                                                                        com.engiweb.pm.entity.Paging paging,
                                                                                        java.lang.String token,
                                                                                        java.lang.String realm)
                                                                                 throws com.engiweb.toolkit.common.BackendException

Deprecated. Replaced by IApplication#findMissingEntitlementForGroup(EntitlementBean, ApplicationBean, GroupBean, Paging, String, String)

Parameters:

entitlementBean -

applicationBean -

ouBean -

paging -

token -

realm -

Returns:

Throws:

com.engiweb.toolkit.common.BackendException

findMissingEntitlementForGroup

com.engiweb.pm.entity.BeanList<EntitlementBean> findMissingEntitlementForGroup(EntitlementBean entitlementBean,
                                                                               ApplicationBean applicationBean,
                                                                               GroupBean groupBean,
                                                                               HierarchyBean hierarchyBean,
                                                                               com.engiweb.pm.entity.Paging paging,
                                                                               java.lang.String token,
                                                                               java.lang.String realm)
                                                                        throws com.engiweb.toolkit.common.BackendException

Parameters:

entitlementBean -

applicationBean -

groupBean -

hierarchyBean -

paging -

token -

realm -

Returns:

Throws:

com.engiweb.toolkit.common.BackendException

findEntitlementByOrgUnit

@Deprecated
com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementByOrgUnit(EntitlementBean entitlementBean,
                                                                                     OrgUnitBean ouBean,
                                                                                     ApplicationBean applicationBean,
                                                                                     boolean hier,
                                                                                     com.engiweb.pm.entity.Paging paging,
                                                                                     java.lang.String token,
                                                                                     java.lang.String realm)
                                                                              throws com.engiweb.toolkit.common.BackendException

Deprecated. Replaced by findEntitlementByGroup(EntitlementBean, GroupBean, HierarchyBean, ApplicationBean, boolean, Paging, String, String) Returns a list of entitlemens assigned to an application in the given organization unit

Parameters:

entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter

ouBean - OrgUnitBean if null no filter is applied, otherwise the passed object is used as filter

applicationBean - ApplicationBean must be present and uniquely defined.

hier - true if search should be made in hierarchy starting from organization unit, false otherwise

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of EntitlementBean

Throws:

com.engiweb.toolkit.common.BackendException

findEntitlementByGroup

com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementByGroup(EntitlementBean entitlementBean,
                                                                       GroupBean groupBean,
                                                                       HierarchyBean hierarchyBean,
                                                                       ApplicationBean applicationBean,
                                                                       boolean hier,
                                                                       com.engiweb.pm.entity.Paging paging,
                                                                       java.lang.String token,
                                                                       java.lang.String realm)
                                                                throws com.engiweb.toolkit.common.BackendException

Returns a list of entitlemens assigned to an application in the given group

Parameters:

entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter

groupBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter

hierarchyBean - HierarchyBean must be present and uniquely defined.

applicationBean - ApplicationBean must be present and uniquely defined.

hier - true if search should be made in hierarchy starting from group, false otherwise

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of EntitlementBean

Throws:

com.engiweb.toolkit.common.BackendException

findUser

@Deprecated
com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                              OrgUnitBean ouBean,
                                                              ApplicationBean applicationBean,
                                                              boolean hier,
                                                              com.engiweb.pm.entity.Paging paging,
                                                              java.lang.String token,
                                                              java.lang.String realm)
                                                       throws com.engiweb.toolkit.common.BackendException

Deprecated. Replaced by findUser(UserBean, GroupBean, HierarchyBean, ApplicationBean, boolean, Paging, String, String) Returns a list of users assigned to an application in the given organization unit

Parameters:

userBean - UserBean if null no filter is applied, otherwise the passed object is used as filter

ouBean - OrgUnitBean if null no filter is applied, otherwise the passed object is used as filter

applicationBean - ApplicationBean must be present and uniquely defined.

hier - true if search should be made in hierarchy starting from organization unit, false otherwise

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

findUser

com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  GroupBean groupBean,
                                                  HierarchyBean hierarchyBean,
                                                  ApplicationBean applicationBean,
                                                  boolean hier,
                                                  com.engiweb.pm.entity.Paging paging,
                                                  java.lang.String token,
                                                  java.lang.String realm)
                                           throws com.engiweb.toolkit.common.BackendException

Returns a list of users assigned to an application in the given group

Parameters:

userBean - UserBean if null no filter is applied, otherwise the passed object is used as filter

grouBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter

hierarchyBean - HierarchyBean must be present and uniquely defined.

applicationBean - ApplicationBean must be present and uniquely defined.

hier - true if search should be made in hierarchy starting from group, false otherwise

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

findEntitlementByFunctType

com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementByFunctType(EntitlementBean entitlementBean,
                                                                           FunctionalityTypeBean functBean,
                                                                           com.engiweb.pm.entity.Paging paging,
                                                                           java.lang.String token,
                                                                           java.lang.String realm)
                                                                    throws com.engiweb.toolkit.common.BackendException

Returns a list of entitlement assigned to an functionality type

Parameters:

entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter

funtionality - type FunctionalityTypeBean must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of EntitlementBean

Throws:

com.engiweb.toolkit.common.BackendException

findOU

@Deprecated
com.engiweb.pm.entity.BeanList<?> findOU(OrgUnitBean orgUnitBean,
                                                     ApplicationBean applicationBean,
                                                     com.engiweb.pm.entity.Paging paging,
                                                     java.lang.String token,
                                                     java.lang.String realm)
                                              throws com.engiweb.toolkit.common.BackendException

Deprecated. Replaced by findGroup(GroupBean, HierarchyBean, ApplicationBean, Paging, String, String) Return a list organization unit with entitlements assigned to an application

Parameters:

orgUnitBean - OrgUnitBean if null no filter is applied, otherwise the passed object is used as filter

applicationBean - ApplicationBean must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of OrgUnitBean

Throws:

java.lang.Exception

com.engiweb.toolkit.common.BackendException

findGroup

com.engiweb.pm.entity.BeanList<GroupBean> findGroup(GroupBean groupBean,
                                                    HierarchyBean hierarchyBean,
                                                    ApplicationBean applicationBean,
                                                    com.engiweb.pm.entity.Paging paging,
                                                    java.lang.String token,
                                                    java.lang.String realm)
                                             throws com.engiweb.toolkit.common.BackendException

Parameters:

groupBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter

hierarchyBean - HierarchyBean must be present and uniquely defined.

applicationBean - ApplicationBean must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of GroupBean

Throws:

java.lang.Exception

com.engiweb.toolkit.common.BackendException

findOuHier

@Deprecated
OrgUnitCBean findOuHier(EntitlementBean entitlementBean,
                                    OrgUnitBean orgUnitFilterBean,
                                    OrgUnitBean orgUnitStartBean,
                                    ApplicationBean applicationBean,
                                    com.engiweb.pm.entity.Paging paging,
                                    java.lang.String token,
                                    java.lang.String realm)
                             throws com.engiweb.toolkit.common.BackendException

Deprecated. Replaced by findGroupHier(EntitlementBean, GroupBean, HierarchyBean, GroupBean, ApplicationBean, Paging, String, String) Returns organization units in hierarchy with the selected filters

Parameters:

entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter

orgUnitFilterBean - OrgUnitBean if null no filter is applied, otherwise the passed object is used as filter

orgUnitStartBean - starting organization unit. If not null must be present and uniquely defined.

applicationBean - ApplicationBean must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

OrgUnitCBean

Throws:

com.engiweb.toolkit.common.BackendException

findGroupHier

GroupCBean findGroupHier(EntitlementBean entitlementBean,
                         GroupBean groupFilterBean,
                         HierarchyBean hierarchyBean,
                         GroupBean groupStartBean,
                         ApplicationBean applicationBean,
                         com.engiweb.pm.entity.Paging paging,
                         java.lang.String token,
                         java.lang.String realm)
                  throws com.engiweb.toolkit.common.BackendException

Returns groups in hierarchy with the selected filters

Parameters:

entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter

groupFilterBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter

hierarchyBean - HierarchyBean must be present and uniquely defined.

groupStartBean - starting group. If not null must be present and uniquely defined.

applicationBean - ApplicationBean must be present and uniquely defined.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

OrgUnitCBean

Throws:

com.engiweb.toolkit.common.BackendException

insertExternalRole

EntitlementBean insertExternalRole(EntitlementBean entitlementBean,
                                   java.lang.String cod_oper,
                                   java.lang.String token,
                                   java.lang.String realm)
                            throws com.engiweb.toolkit.common.BackendException

This method creates an External Role. Ideas usually uses permissions to represent the authorization state of users. Eventually Ideas can manage External Roles if target system needs to keep trace about business roles that generated the permission assignment. In that case and Functionality Type is forced to be ISIM (ID=2) and Target is forced to be ISIM, too. (Multiple target management can be added in further develops)

Parameters:

entitlementBean -

Returns:

Throws:

com.engiweb.toolkit.common.BackendException

deleteExternalRole

void deleteExternalRole(EntitlementBean entitlementBean,
                        java.lang.String cod_oper,
                        java.lang.String token,
                        java.lang.String realm)
                 throws com.engiweb.toolkit.common.BackendException

Parameters:

entitlementBean -

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

addExtRoleChild

void addExtRoleChild(com.engiweb.pm.entity.BeanList<EntitlementBean> entitlementBeanList,
                     EntitlementBean parentExtRole,
                     java.lang.String cod_oper,
                     java.lang.String token,
                     java.lang.String realm)
              throws com.engiweb.toolkit.common.BackendException

Parameters:

entitlementBeanList -

parentExtRole -

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

removeExtRoleChild

void removeExtRoleChild(EntitlementBean childEntitlement,
                        EntitlementBean parentExtRole,
                        java.lang.String cod_oper,
                        java.lang.String token,
                        java.lang.String realm)
                 throws com.engiweb.toolkit.common.BackendException

Parameters:

childEntitlement -

parentExtRole -

cod_oper - String Code operation. If null PM generates it automatically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

findExtRole

com.engiweb.pm.entity.BeanList<EntitlementBean> findExtRole(EntitlementBean entitlementBean,
                                                            ApplicationBean applicationBean,
                                                            java.lang.Boolean isFulFilled,
                                                            com.engiweb.pm.entity.Paging paging,
                                                            java.lang.String token,
                                                            java.lang.String realm)
                                                     throws com.engiweb.toolkit.common.BackendException

This method find External Roles.

Parameters:

entitlementBean -

applicationBean -

isFulfilled -

Returns:

Throws:

com.engiweb.toolkit.common.BackendException