com.engiweb.profilemanager.common.interfaces

Interface IApplicationDirect

  • All Superinterfaces:
    common.direct.IDirect

    public interface IApplicationDirect
extends common.direct.IDirect
    The IApplication interface allows a client to retrieve and manage all information about application objects
    Author:
    CrossIdeas developer group

    • Method Detail

      • insert

        ApplicationBean insert(ApplicationBean applicationBean,
                       com.engiweb.pm.dao.db.DAO dao)
                throws com.engiweb.toolkit.common.BackendException
        Adds a new application if it not exists yet.
        Parameters:
        ApplicationBean - applicationBean: ApplicationBean to insert (mandatory). The application name is a mandatory field.
        dao - DAO the connection dao
        Returns:
        ApplicationBean created
        Throws:
        com.engiweb.toolkit.common.BackendException

      • update

        ApplicationBean update(ApplicationBean applicationBean,
                       com.engiweb.pm.dao.db.DAO dao)
                throws com.engiweb.toolkit.common.BackendException
        Updates an existing application
        Parameters:
        ApplicationBean - applicationBean: ApplicationBean to update (mandatory).It must be present and uniquely defined.
        dao - DAO the connection dao
        Returns:
        ApplicationBean modified
        Throws:
        com.engiweb.toolkit.common.BackendException

      • delete

        void delete(ApplicationBean applicationBean,
            com.engiweb.pm.dao.db.DAO dao)
     throws com.engiweb.toolkit.common.BackendException
        Deletes an existing application
        Parameters:
        ApplicationBean - applicationBean: ApplicationBean to update (mandatory).It must be present and uniquely defined.
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException

      • find

        com.engiweb.pm.entity.BeanList<ApplicationBean> find(ApplicationBean applicationBean,
                                                     PropertyBean propertyBean,
                                                     com.engiweb.pm.entity.Paging paging,
                                                     com.engiweb.pm.dao.db.DAO dao)
                                              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 PropertyBean to use as filter
        Paging - paging : Paging
        dao - DAO the connection dao
        Returns:
        BeanList of ApplicationBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • insertFuntionalityType

        FunctionalityTypeBean insertFuntionalityType(FunctionalityTypeBean funtcTypeBean,
                                             com.engiweb.pm.dao.db.DAO dao)
                                      throws com.engiweb.toolkit.common.BackendException
        Adds a new functionality type if it not exists yet.
        Parameters:
        FunctionalityTypeBean - funtcTypeBean:FunctionalityTypeBean to insert (mandatory). The functionality type name is a mandatory field.
        dao - DAO the connection dao
        Returns:
        FunctionalityTypeBean created
        Throws:
        com.engiweb.toolkit.common.BackendException

      • updateFuntionalityType

        FunctionalityTypeBean updateFuntionalityType(FunctionalityTypeBean functTypeBean,
                                             com.engiweb.pm.dao.db.DAO dao)
                                      throws com.engiweb.toolkit.common.BackendException
        Updates an existing functionality type
        Parameters:
        FunctionalityTypeBean - functTypeBean: FunctionalityTypeBean to update (mandatory).It must be present and uniquely defined.
        dao - DAO the connection dao
        Returns:
        FunctionalityTypeBean modified
        Throws:
        com.engiweb.toolkit.common.BackendException

      • deleteFuntionalityType

        void deleteFuntionalityType(FunctionalityTypeBean funtcTypeBean,
                            com.engiweb.pm.dao.db.DAO dao)
                     throws com.engiweb.toolkit.common.BackendException
        Deletes an existing functionality type
        Parameters:
        FunctionalityTypeBean - funtcTypeBean: FunctionalityTypeBean to delete (mandatory).It must be present and uniquely defined.
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException

      • findFunctionalityType

        com.engiweb.pm.entity.BeanList<FunctionalityTypeBean> findFunctionalityType(FunctionalityTypeBean functTypeBean,
                                                                            com.engiweb.pm.entity.Paging paging,
                                                                            com.engiweb.pm.dao.db.DAO dao)
                                                                     throws com.engiweb.toolkit.common.BackendException
        Returns a list of functionality types filtered by a passed FunctionalityTypeBean object
        Parameters:
        FunctionalityTypeBean - functTypeBean: if null no filter is applied, otherwise the passed object is used as filter
        Paging - paging: Paging
        dao - DAO the connection dao
        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,
                                                                                   com.engiweb.pm.dao.db.DAO dao)
                                                                            throws com.engiweb.toolkit.common.BackendException
        Returns a list of functionality types filtered by no administrative application and a passed FunctionalityTypeBean object
        Parameters:
        FunctionalityTypeBean - functTypeBean: if null no filter is applied, otherwise the passed object is used as filter
        Paging - paging: Paging
        dao - DAO the connection dao
        Returns:
        BeanList of FunctionalityTypeBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • addProperties

        void addProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                   ApplicationBean applicationBean,
                   com.engiweb.pm.dao.db.DAO dao)
            throws com.engiweb.toolkit.common.BackendException
        Adds a list of properties to an application
        Parameters:
        BeanList - blPropertyBean: BeanList of PropertyBean to add to application
        ApplicationBean - applicationBean: ApplicationBean to add the properties. It must be present and uniquely defined.
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException

      • modifyProperties

        void modifyProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                      ApplicationBean applicationBean,
                      com.engiweb.pm.dao.db.DAO dao)
               throws com.engiweb.toolkit.common.BackendException
        Updates a list of properties of an application
        Parameters:
        BeanList - blPropertyBean: BeanList of PropertyBean to update to application.
        ApplicationBean - applicationBean: ApplicationBean with the properties that must be updates. It must be present and uniquely defined.
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException

      • removeProperties

        void removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                      ApplicationBean applicationBean,
                      com.engiweb.pm.dao.db.DAO dao)
               throws com.engiweb.toolkit.common.BackendException
        Removes a list of properties from an application
        Parameters:
        BeanList - blPropertyBean: BeanList of PropertyBean to remove from application.
        ApplicationBean - applicationBean: ApplicationBean with the properties that must be removed. It must be present and uniquely defined.
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException

      • findProperty

        com.engiweb.pm.entity.BeanList<PropertyBean> findProperty(PropertyBean propertyBean,
                                                          ApplicationBean applicationBean,
                                                          com.engiweb.pm.entity.Paging paging,
                                                          com.engiweb.pm.dao.db.DAO dao)
                                                   throws com.engiweb.toolkit.common.BackendException
        Returns a list of properties assigned to an application
        Parameters:
        PropertyBean - propertyBean: if null no filter is applied, otherwise the passed object is used as filter
        ApplicationBean - applicationBean: ApplicationBean with the properties that must be searched. It must be present and uniquely defined.
        Paging - paging: Paging
        dao - DAO the connection dao
        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,
                                                                com.engiweb.pm.dao.db.DAO dao)
                                                         throws com.engiweb.toolkit.common.BackendException
        Returns a list of entitlements assigned to an application
        Parameters:
        entitlementBean - 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 the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • findMissingApplicationForUser

        com.engiweb.pm.entity.BeanList<ApplicationBean> findMissingApplicationForUser(ApplicationBean applicationBean,
                                                                              UserBean userBean,
                                                                              com.engiweb.pm.entity.Paging paging,
                                                                              com.engiweb.pm.dao.db.DAO dao)
                                                                       throws com.engiweb.toolkit.common.BackendException
        Returns a list of applications that have not yet been assigned to the user
        Parameters:
        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 the paging
        dao - DAO the connection dao
        Returns:
        BeanList of 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,
                                                                               com.engiweb.pm.dao.db.DAO dao)
                                                                        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 the paging
        dao - DAO the connection dao
        Returns:
        BeanList of 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,
                                                                                        com.engiweb.pm.dao.db.DAO dao)
                                                                                 throws com.engiweb.toolkit.common.BackendException
        Deprecated. Replaced by IApplicationDirect#findMissingEntitlementForGroup(EntitlementBean, ApplicationBean, GroupBean, Paging, DAO) Returns a list of entitlemens that have not yet been assigned to the organization unit
        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
        ouBean - OrgUnitBeanthe organization unit
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findMissingEntitlementForGroup

        com.engiweb.pm.entity.BeanList<EntitlementBean> findMissingEntitlementForGroup(EntitlementBean entitlementBean,
                                                                               ApplicationBean applicationBean,
                                                                               GroupBean groupBean,
                                                                               HierarchyBean hierarchyBean,
                                                                               com.engiweb.pm.entity.Paging paging,
                                                                               com.engiweb.pm.dao.db.DAO dao)
                                                                        throws com.engiweb.toolkit.common.BackendException
        Returns a list of entitlemens that have not yet been assigned to the group
        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
        groupBean - GroupBean the group must be present and uniquely defined
        hierarchyBean - HierarchyBean the group must be present and uniquely defined
        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 code_scope,
                                                                                     com.engiweb.pm.dao.db.DAO dao)
                                                                              throws com.engiweb.toolkit.common.BackendException
        Deprecated. Replaced by IApplicationDirect#findEntitlementByGroup(EntitlementBean, GroupBean, HierarchyBean, ApplicationBean, boolean, Paging, DAO) Returns a list of entitlements 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 - boolean true if search should be made in hierarchy starting from organization unit, false otherwise
        paging - Paging the paging
        code_scope - scope for visibility
        dao - DAO the connection dao
        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 code_scope,
                                                                       com.engiweb.pm.dao.db.DAO dao)
                                                                throws com.engiweb.toolkit.common.BackendException
        Returns a list of entitlements 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
        code_scope - scope for visibility, applicable only for hierarchy with id 1
        dao - DAO the connection dao
        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 code_scope,
                                                              com.engiweb.pm.dao.db.DAO dao)
                                                       throws com.engiweb.toolkit.common.BackendException
        Deprecated. Replaced by findUser(UserBean, OrgUnitBean, ApplicationBean, boolean, Paging, String, DAO) 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 - boolean: true if search should be made in hierarchy starting from organization unit, false otherwise
        paging - Paging the paging
        code_scope - scope for visibility
        dao - DAO the connection dao
        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 code_scope,
                                                  com.engiweb.pm.dao.db.DAO dao)
                                           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
        code_scope - scope for visibility, applicable only for hierarchy with id 1
        dao - DAO the connection dao
        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,
                                                                           com.engiweb.pm.dao.db.DAO dao)
                                                                    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
        functBean - FunctionalityTypeBean must be present and uniquely defined.
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • insertExternalRole

        EntitlementBean insertExternalRole(EntitlementBean entitlementBean,
                                   com.engiweb.pm.dao.db.DAO connDao)
                            throws com.engiweb.toolkit.common.BackendException
        This method creates an External Role. Ideas usually uses permissions to rapresent the authorization state of users. Eventually Ideas can manage External Roles if terget 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 - EntitlementBean external role to add.
        dao - DAO the connection dao
        Returns:
        EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • addExtRoleChild

        void addExtRoleChild(com.engiweb.pm.entity.BeanList<EntitlementBean> entitlementBeanList,
                     EntitlementBean parentExtRole,
                     com.engiweb.pm.dao.db.DAO connDao)
              throws com.engiweb.toolkit.common.BackendException
        Adds the ext role child.
        Parameters:
        entitlementBeanList - BeanList of EntitlementBean the entitlement list
        parentExtRole - EntitlementBean the parent ext role
        connDao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • removeExtRoleChild

        void removeExtRoleChild(EntitlementBean childEntitlementBean,
                        EntitlementBean parentExtRole,
                        com.engiweb.pm.dao.db.DAO connDao)
                 throws com.engiweb.toolkit.common.BackendException
        Removes the ext role child.
        Parameters:
        childEntitlementBean - EntitlementBean the child entitlement
        parentExtRole - EntitlementBean the parent ext role
        connDao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • deleteExternalRole

        void deleteExternalRole(EntitlementBean entitlementBean,
                        com.engiweb.pm.dao.db.DAO connDao)
                 throws com.engiweb.toolkit.common.BackendException
        Delete external role.
        Parameters:
        entitlementBean - EntitlementBean the entitlement
        connDao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findOU

        @Deprecated
com.engiweb.pm.entity.BeanList<?> findOU(OrgUnitBean orgUnitBean,
                                                     ApplicationBean applicationBean,
                                                     com.engiweb.pm.entity.Paging paging,
                                                     com.engiweb.pm.dao.db.DAO dao)
                                              throws com.engiweb.toolkit.common.BackendException
        Deprecated. 
        * @deprecated Replaced by findGroup(GroupBean, HierarchyBean, ApplicationBean, Paging, DAO) Return a list organization unit with entitlements assigned to an application.
        Parameters:
        orgUnitBean - OrgUnitBean the organization unit
        applicationBean - ApplicationBean the application
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of OrgUnitBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findGroup

        com.engiweb.pm.entity.BeanList<GroupBean> findGroup(GroupBean groupBean,
                                                    HierarchyBean hierarchyBean,
                                                    ApplicationBean applicationBean,
                                                    com.engiweb.pm.entity.Paging paging,
                                                    com.engiweb.pm.dao.db.DAO dao)
                                             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
        dao - DAO the connection dao
        Returns:
        BeanList of GroupBean
        Throws:
        java.lang.Exception
        com.engiweb.toolkit.common.BackendException

      • findGroupHier

        GroupCBean findGroupHier(EntitlementBean entitlementBean,
                         GroupBean groupFilterBean,
                         HierarchyBean hierarchyBean,
                         GroupBean groupStartBean,
                         ApplicationBean applicationBean,
                         com.engiweb.pm.entity.Paging paging,
                         com.engiweb.pm.dao.db.DAO dao)
                  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 the paging
        dao - DAO the connection dao
        Returns:
        GroupCBeans
        Throws:
        com.engiweb.toolkit.common.BackendException

      • fulfillEntitlement

        void fulfillEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> bl,
                        com.engiweb.pm.dao.db.DAO dao)
                 throws com.engiweb.toolkit.common.BackendException
        Throws:
        com.engiweb.toolkit.common.BackendException

      • unFulfillEntitlement

        void unFulfillEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> bl,
                          com.engiweb.pm.dao.db.DAO dao)
                   throws com.engiweb.toolkit.common.BackendException
        Throws:
        com.engiweb.toolkit.common.BackendException
Skip navigation links