com.engiweb.profilemanager.common.interfaces

Interface IEntitlementDirect

  • All Superinterfaces:
    common.direct.IDirect

    public interface IEntitlementDirect
extends common.direct.IDirect
    The IEntitlement interface allows a client to retrieve and manage all information about entitlement objects Entitlement identifies a structured set of �rights� assigned to a generic User for access to the resource of an Organization. An Entitlement can be of three different typologies:
    • Profile
    • ITRole possibly composed by:
      • IT Role
      • Profile
    • Business Role possibly composed by:
      • Business Role
      • IT Role
      • ProfileIT Role Profile
    Author:
    CrossIdeas developer group

    • Method Detail

      • findEntitlement

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entitlementBean,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                boolean includeBusinessRole,
                                                                com.engiweb.pm.dao.db.DAO dao)
                                                         throws com.engiweb.toolkit.common.BackendException
        Returns the entitlements filtered by a passed EntitlementBean object. If the filter have application setting is possible to exclude BusinessRole from the result, passing false to the includeBusinessRole parameter
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        paging - Paging
        includeBusinessRole - true: business role are included into search, false otherwise
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findEntitlement

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entitlementBean,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                com.engiweb.pm.dao.db.DAO dao)
                                                         throws com.engiweb.toolkit.common.BackendException
        Returns the entitlements filtered by a passed EntitlementBean object.
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findEntitlement

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entitlementBean,
                                                                java.util.List<ApplicationBean> applicationBeans,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                com.engiweb.pm.dao.db.DAO dao)
                                                         throws com.engiweb.toolkit.common.BackendException
        Returns the entitlements filtered by a passed EntitlementBean object.
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        applicationBeans - the application beans as filter
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findEntitlement

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entitlementBean,
                                                                java.util.List<ApplicationBean> applicationBeans,
                                                                TaskBean taskBean,
                                                                boolean taskHier,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                com.engiweb.pm.dao.db.DAO dao)
                                                         throws com.engiweb.toolkit.common.BackendException
        Returns the entitlements filtered by a passed EntitlementBean object.
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        applicationBeans - the application beans as filter
        taskBean - TaskBean if null no filter is applied, otherwise the passed object is used as filter
        taskHier - boolean specifies if hierarchical search
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • insertEntitlement

        EntitlementBean insertEntitlement(EntitlementBean entitlementBean,
                                  com.engiweb.pm.dao.db.DAO dao)
                           throws com.engiweb.toolkit.common.BackendException
        Add a new entitlement.
        Parameters:
        entitlementBean - EntitlementBean the entitlement to add (mandatory)
        dao - DAO the connection dao
        Returns:
        EntitlementBean created
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception EntitlementBean to insert (mandatory).It must be present and uniquely defined.

      • updateEntitlement

        EntitlementBean updateEntitlement(EntitlementBean entitlementBean,
                                  com.engiweb.pm.dao.db.DAO dao)
                           throws com.engiweb.toolkit.common.BackendException
        Updates an existing entitlement.
        Parameters:
        entitlementBean - EntitlementBean the entitlement to update (mandatory)
        dao - DAO the connection dao
        Returns:
        EntitlementBean modified
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception EntitlementBean to update (mandatory).It must be present and uniquely defined.

      • deleteEntitlement

        void deleteEntitlement(EntitlementBean entitlementBean,
                       com.engiweb.pm.dao.db.DAO dao)
                throws com.engiweb.toolkit.common.BackendException
        Deletes an existing entitlement.
        Parameters:
        entitlementBean - EntitlementBean the entitlement to delete (mandatory)
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception EntitlementBean to delete (mandatory).It must be present and uniquely defined.

      • addEntitlementChild

        void addEntitlementChild(EntitlementBean entitlementBean,
                         EntitlementBean entitlementParentBean,
                         com.engiweb.pm.dao.db.DAO dao)
                  throws com.engiweb.toolkit.common.BackendException
        Adds an entitlement to another one as its child. A JOBROLE can contains:
        • JOBROLE
        • ITROLE
        • PROFILE
        An ITROLE can contains:
        • ITROLE
        • PROFILE
        A PROFILE can contains
        • PROFILE
        Parameters:
        entitlementBean - EntitlementBean to add as child of another one. It must be present and uniquely defined
        entitlementParentBean - EntitlementBean the entitlement parent (mandatory)
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • addEntitlementChild

        void addEntitlementChild(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                         EntitlementBean entitlementParentBean,
                         com.engiweb.pm.dao.db.DAO dao)
                  throws com.engiweb.toolkit.common.BackendException
        Adds a list of entitlement to another one as its child. A JOBROLE can contains:
        • JOBROLE
        • ITROLE
        • PROFILE
        An ITROLE can contains:
        • ITROLE
        • PROFILE
        A PROFILE can contains
        • PROFILE
        *
        Parameters:
        blEntitlementBean - BeanList of EntitlementBean entitlement list to add (mandatory)
        entitlementParentBean - EntitlementBean the entitlement parent (mandatory)
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findEntitlementChild

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementChild(EntitlementBean entitlementBean,
                                                                     EntitlementBean entitlementParentBean,
                                                                     com.engiweb.pm.entity.Paging paging,
                                                                     com.engiweb.pm.dao.db.DAO dao)
                                                              throws com.engiweb.toolkit.common.BackendException
        Returns childs of an entitlement.
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementParentBean - EntitlementBean the entitlement parent. Mandatory and well defined
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • removeEntitlementChild

        void removeEntitlementChild(EntitlementBean entitlementBean,
                            EntitlementBean entitlementParentBean,
                            com.engiweb.pm.dao.db.DAO dao)
                     throws com.engiweb.toolkit.common.BackendException
        Removes an entitlement as child of another one.
        Parameters:
        entitlementBean - EntitlementBean the entitlement to remove (mandatory)
        entitlementParentBean - EntitlementBean the entitlement parent (mandatory)
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • removeEntitlementChild

        void removeEntitlementChild(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                            EntitlementBean entitlementParentBean,
                            com.engiweb.pm.dao.db.DAO dao)
                     throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlement as child of another one.
        Parameters:
        blEntitlementBean - BeanList of EntitlementBean the list of entitlement to remove (mandatory)
        entitlementParentBean - EntitlementBean the entitlement parent (mandatory)
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findEntitlementParent

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementParent(EntitlementBean filterBean,
                                                                      EntitlementBean entitlementBean,
                                                                      com.engiweb.pm.entity.Paging paging,
                                                                      com.engiweb.pm.dao.db.DAO dao)
                                                               throws com.engiweb.toolkit.common.BackendException
        Returns all first level parents of an entitlement.
        Parameters:
        filterBean - EntitlementBean the filter
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findProperties

        com.engiweb.pm.entity.BeanList<PropertyBean> findProperties(PropertyBean propBean,
                                                            EntitlementBean entitlementBean,
                                                            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 entitlement.
        Parameters:
        propBean - PropertyBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned properties are to be retrieved.
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of PropertyBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • addProperties

        void addProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                   EntitlementBean entitlementBean,
                   com.engiweb.pm.dao.db.DAO dao)
            throws com.engiweb.toolkit.common.BackendException
        Adds a list of properties to an entitlement.
        Parameters:
        blPropertyBean - BeanList of PropertyBean the list of properties to add
        entitlementBean - EntitlementBean the entitlement to which properties must be assigned.
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • removeProperties

        void removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                      EntitlementBean entitlementBean,
                      com.engiweb.pm.dao.db.DAO dao)
               throws com.engiweb.toolkit.common.BackendException
        Removes a list of properties from an entitlement.
        Parameters:
        blPropertyBean - BeanList of PropertyBean the list properties to remove
        entitlementBean - EntitlementBean the entitlement frome which properties must be removed
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • checkHierarchy

        int checkHierarchy(java.lang.Long entitlementId,
                   java.lang.Long entitlementParentId,
                   com.engiweb.pm.dao.db.DAO dao)
            throws com.engiweb.toolkit.common.BackendException
        Check if there are loops o problems about the hierarchy of two entitlements.
        Parameters:
        entitlementId - Long the entitlement id
        entitlementParentId - Long the entitlement parent id
        dao - DAO the coonection dao
        Returns:
        int 0 if everything is right. An exception otherwise
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • publishEntitlement

        void publishEntitlement(EntitlementBean entitlementBean,
                        java.lang.String lastModUser,
                        com.engiweb.pm.dao.db.DAO dao)
                 throws com.engiweb.toolkit.common.BackendException
        Set an entitlement as published or unpublished.
        Parameters:
        entitlementBean - EntitlementBean the entitlement to be set as puplished
        lastModUser - String the last mod user
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • unPublishEntitlement

        void unPublishEntitlement(EntitlementBean entitlementBean,
                          com.engiweb.pm.dao.db.DAO dao)
                   throws com.engiweb.toolkit.common.BackendException
        Unpublish entitlement.
        Parameters:
        entitlementBean - EntitlementBean the entitlement to be set as unpublished
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findUser

        @Deprecated
com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                              EntitlementBean entitlementBean,
                                                              OrgUnitBean ouBean,
                                                              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. 
        Returns user having an entitlement.
        Parameters:
        userBean - UserBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned users are to be retrieved.
        ouBean - OrgUnitBean the org unit
        hier - boolean: if true research must be performed hierarchically, false otherwise
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findUser

        com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  EntitlementBean entitlementBean,
                                                  GroupBean groupBean,
                                                  HierarchyBean hierarchyBean,
                                                  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 user having an entitlement.
        Parameters:
        userBean - UserBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned users are to be retrieved.
        groupBean - GroupBean the group with hierarchy as organizational unit
        hier - boolean: if true research must be performed hierarchically, false otherwise
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findUser

        com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  EntitlementBean entitlementBean,
                                                  java.lang.Boolean delegated,
                                                  GroupBean groupBean,
                                                  HierarchyBean hierarchyBean,
                                                  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 user having an entitlement.
        Parameters:
        userBean - UserBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned users are to be retrieved.
        groupBean - GroupBean the group with hierarchy as organizational unit
        delegated - Boolean search only for user having the role as delegated if true, directly assigned if false. If null it doesn't filter
        hier - boolean: if true research must be performed hierarchically, false otherwise
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findGroups

        com.engiweb.pm.entity.BeanList<GroupBean> findGroups(GroupBean groupBean,
                                                     UserBean userBean,
                                                     EntitlementBean entitlementBean,
                                                     com.engiweb.pm.entity.Paging paging,
                                                     com.engiweb.pm.dao.db.DAO dao)
                                              throws com.engiweb.toolkit.common.BackendException
        Returns groups in which a user has an entitlement.
        Parameters:
        groupBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter
        userBean - UserBean whose we want to find the groups in which he has the role
        entitlementBean - EntitlementBean whose assigned users are to be retrieved.
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findOrgUnit

        @Deprecated
com.engiweb.pm.entity.BeanList<OrgUnitBean> findOrgUnit(OrgUnitBean orgUnitBean,
                                                                    EntitlementBean entitlementBean,
                                                                    com.engiweb.pm.entity.Paging paging,
                                                                    com.engiweb.pm.dao.db.DAO dao)
                                                             throws com.engiweb.toolkit.common.BackendException
        Deprecated. 
        Returns organization unti having an entitlement.
        Parameters:
        orgUnitBean - OrgUnitBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean the entitlement
        paging - Paging the paging
        dao - DAO the coonection dao
        Returns:
        BeanList of OrgUnitBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findGroup

        com.engiweb.pm.entity.BeanList<GroupBean> findGroup(GroupBean groupBean,
                                                    HierarchyBean hierarchyBean,
                                                    EntitlementBean entitlementBean,
                                                    com.engiweb.pm.entity.Paging paging,
                                                    com.engiweb.pm.dao.db.DAO dao)
                                             throws com.engiweb.toolkit.common.BackendException
        Returns a group having an entitlement.
        Parameters:
        groupBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter
        hierarchyBean - HierarchyBean is mandatory when the GroupBean is used as a filter.
        entitlementBean - EntitlementBean the entitlement
        paging - Paging the paging
        dao - DAO the coonection dao
        Returns:
        BeanList of GroupBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findProfile

        com.engiweb.pm.entity.BeanList<EntitlementBean> findProfile(EntitlementBean proBean,
                                                            EntitlementBean entitlementBean,
                                                            com.engiweb.pm.entity.Paging paging,
                                                            com.engiweb.pm.dao.db.DAO dao)
                                                     throws com.engiweb.toolkit.common.BackendException
        Returns profile starting from a published entitlement.
        Parameters:
        proBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean the entitlement
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findApplication

        com.engiweb.pm.entity.BeanList<ApplicationBean> findApplication(ApplicationBean appBean,
                                                                EntitlementBean entitlementBean,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                com.engiweb.pm.dao.db.DAO dao)
                                                         throws com.engiweb.toolkit.common.BackendException
        Returns applications related to a published entitlement.
        Parameters:
        appBean - ApplicationBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean the entitlement
        paging - Paging the paging
        dao - DAO the connectoin dao
        Returns:
        BeanList of ApplicationBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findEntitlementPublished

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementPublished(EntitlementBean entitlementBean,
                                                                         com.engiweb.pm.entity.Paging paging,
                                                                         com.engiweb.pm.dao.db.DAO dao)
                                                                  throws com.engiweb.toolkit.common.BackendException
        Returns published entitlements.
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        paging - Paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception EntitlementBean if null no filter is applied, otherwise the passed object is used as filter

      • findUserByProfile

        @Deprecated
com.engiweb.pm.entity.BeanList<UserBean> findUserByProfile(UserBean userBean,
                                                                       OrgUnitBean ouBean,
                                                                       EntitlementBean entitlementBean,
                                                                       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. 
        Returns users having a fixed entitlement (profile) into an organization unit.
        Parameters:
        userBean - UserBean the user, if null no filter is applied, otherwise the passed object is used as filter
        ouBean - OrgUnitBean the organization unit, if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean the entitlement
        hier - boolean: true if research must be performed hierarchically, false otherwise
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception UserBean if null no filter is applied, otherwise the passed object is used as filter OrganizationalUnit if null no filter is applied, otherwise the passed object is used as filter EntitlementBean It must be present and uniquely defined Paging

      • findUserByProfile

        @Deprecated
com.engiweb.pm.entity.BeanList<UserBean> findUserByProfile(UserBean userBean,
                                                                       GroupBean groupBean,
                                                                       HierarchyBean hierarchyBean,
                                                                       EntitlementBean entitlementBean,
                                                                       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. 
        Returns users having a fixed entitlement (profile) into an organization unit.
        Parameters:
        userBean - UserBean the user, 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 is mandatory when the GroupBean is used as a filter.
        entitlementBean - EntitlementBean the entitlement
        hier - boolean: true if research must be performed hierarchically, false otherwise
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception UserBean if null no filter is applied, otherwise the passed object is used as filter OrganizationalUnit if null no filter is applied, otherwise the passed object is used as filter EntitlementBean It must be present and uniquely defined Paging

      • findUserByProfile

        com.engiweb.pm.entity.BeanList<UserBean> findUserByProfile(UserBean userBean,
                                                           GroupBean groupBean,
                                                           HierarchyBean hierarchyBean,
                                                           EntitlementBean entitlementBean,
                                                           boolean hier,
                                                           java.lang.Boolean delegated,
                                                           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 users having a fixed entitlement (profile) into an organization unit.
        Parameters:
        userBean - UserBean the user, 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 is mandatory when the GroupBean is used as a filter.
        entitlementBean - EntitlementBean the entitlement
        hier - boolean: true if research must be performed hierarchically, false otherwise
        delegated - if true return only user having the profile contained in delegated roles, if false in direct assigned role , if null both
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception UserBean if null no filter is applied, otherwise the passed object is used as filter OrganizationalUnit if null no filter is applied, otherwise the passed object is used as filter EntitlementBean It must be present and uniquely defined Paging

      • findUserByProfile

        @Deprecated
com.engiweb.pm.entity.BeanList<UserBean> findUserByProfile(UserBean userBean,
                                                                       OrgUnitBean ouBean,
                                                                       com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                                                                       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. 
        Returns users having a list of entilement (profiles).
        Parameters:
        userBean - UserBean the user, if null no filter is applied, otherwise the passed object is used as filter
        ouBean - OrgUnitBean the organization unit, if null no filter is applied, otherwise the passed object is used as filter
        blEntitlementBean - BeanList of EntitlementBean whose assigned user are to be retrieved.
        hier - boolean: if ouBean is not null, it specifies if the research must be done in hierarchy or not
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findUserByProfile

        @Deprecated
com.engiweb.pm.entity.BeanList<UserBean> findUserByProfile(UserBean userBean,
                                                                       GroupBean groupBean,
                                                                       HierarchyBean hierarchyBean,
                                                                       com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                                                                       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. 
        Returns users having a list of entilement (profiles).
        Parameters:
        userBean - UserBean the user, 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 is mandatory when the GroupBean is used as a filter.
        blEntitlementBean - BeanList of EntitlementBean whose assigned user are to be retrieved.
        hier - boolean: if ouBean is not null, it specifies if the research must be done in hierarchy or not
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findUserByProfile

        com.engiweb.pm.entity.BeanList<UserBean> findUserByProfile(UserBean userBean,
                                                           GroupBean groupBean,
                                                           HierarchyBean hierarchyBean,
                                                           com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                                                           boolean hier,
                                                           java.lang.Boolean delegated,
                                                           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 users having a list of entilement (profiles).
        Parameters:
        userBean - UserBean the user, 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 is mandatory when the GroupBean is used as a filter.
        blEntitlementBean - BeanList of EntitlementBean whose assigned user are to be retrieved.
        hier - boolean: if ouBean is not null, it specifies if the research must be done in hierarchy or not
        delegated - if true return only user having the profile contained in delegated roles, if false in direct assigned role , if null both
        paging - Paging the paging
        code_scope - String the code scope
        dao - DAO the connection dao
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • deleteEntitlement

        void deleteEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                       com.engiweb.pm.dao.db.DAO dao)
                throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlements.
        Parameters:
        blEntitlementBean - BeanList of EntitlementBean the list of entitlement
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findByProperty

        com.engiweb.pm.entity.BeanList<EntitlementBean> findByProperty(EntitlementBean entitlementBean,
                                                               PropertyBean propertyBean,
                                                               com.engiweb.pm.entity.Paging paging,
                                                               com.engiweb.pm.dao.db.DAO dao)
                                                        throws com.engiweb.toolkit.common.BackendException
        Returns published entitlements having a property.
        Parameters:
        entitlementBean - EntitlementBean the entitlement
        propertyBean - PropertyBean the property
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findEntitlementObjExt

        com.engiweb.pm.entity.BeanList<EntitlementObjExtBean> findEntitlementObjExt(EntitlementObjExtBean entitlementObjExtBean,
                                                                            EntitlementBean entitlementBean,
                                                                            com.engiweb.pm.entity.Paging paging,
                                                                            com.engiweb.pm.dao.db.DAO dao)
                                                                     throws com.engiweb.toolkit.common.BackendException
        Find entitlement obj ext.
        Parameters:
        entitlementObjExtBean - EntitlementObjExtBean the entitlement external object,if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean the entitlement
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementObjExtBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception EntitlementObjExtBean If null no filter is applied, otherwise the passed object is used as filter EntitlementBean It must be present and uniquely defined Paging

      • findEntitlementByProfile

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementByProfile(EntitlementBean entitlementBean,
                                                                         EntitlementBean entitlementProfileBean,
                                                                         com.engiweb.pm.entity.Paging paging,
                                                                         com.engiweb.pm.dao.db.DAO dao)
                                                                  throws com.engiweb.toolkit.common.BackendException
        Find entitlement by onother entitlement (profile).
        Parameters:
        entitlementBean - EntitlementBean the entitlement, if null no filter is applied, otherwise the passed object is used as filter
        entitlementProfileBean - EntitlementBean the entitlement profile
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • revertEntitlementHistory

        void revertEntitlementHistory(EntitlementBean entitlementBean,
                              com.engiweb.pm.dao.db.DAO dao)
                       throws com.engiweb.toolkit.common.BackendException
        Returns the entity to the state of the last revision performed and a rollback the version. Changes made after the operation of revision will be lost, also will be also canceled all changes made to the final revision. The revision is finally Decreased to the previous one, which represents the current state. The lines are removed at History. Then everything returns to the state of the previous revision.
        Parameters:
        entitlementBean - EntitlementBean the entitlement whose history must be revert
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • signOffEntitlement

        void signOffEntitlement(EntitlementBean entitlementBean,
                        com.engiweb.pm.dao.db.DAO dao)
                 throws com.engiweb.toolkit.common.BackendException
        Sign off entitlement.
        Parameters:
        entitlementBean - EntitlementBean the entitlement
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findDependency

        com.engiweb.pm.entity.BeanList<EntitlementBean> findDependency(EntitlementBean filterEntBean,
                                                               EntitlementBean entitlementBean,
                                                               com.engiweb.pm.entity.Paging paging,
                                                               com.engiweb.pm.dao.db.DAO dao)
                                                        throws com.engiweb.toolkit.common.BackendException
        Find dependency of an entitlement.
        Parameters:
        filterEntBean - EntitlementBean the filter entitlement
        entitlementBean - EntitlementBean the entitlement which want dependency
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • addDependency

        void addDependency(java.util.List<EntitlementBean> listDependencyBean,
                   EntitlementBean entitlementBean,
                   com.engiweb.pm.dao.db.DAO dao)
            throws com.engiweb.toolkit.common.BackendException
        Adds list of dependency to an entitlement
        Parameters:
        listDependencyBean - List of EntitlementBean the list of dependency
        entitlementBean - EntitlementBean the entitlement wich want add the list of dependency
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • removeDependency

        void removeDependency(java.util.List<EntitlementBean> listDependencyBean,
                      EntitlementBean entitlementBean,
                      com.engiweb.pm.dao.db.DAO dao)
               throws com.engiweb.toolkit.common.BackendException
        Removes a list of dependency from an entitlement
        Parameters:
        listDependencyBean - List of EntitlementBean the list of dependency
        entitlementBean - EntitlementBean the entitlement
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • addUser

        void addUser(java.util.List<UserBean> listUserBean,
             EntitlementBean entitlementBean,
             java.util.List<com.engiweb.pm.web.bean.AbstractBean> listResources,
             boolean visibilityViolation,
             com.engiweb.pm.dao.db.DAO dao)
      throws com.engiweb.toolkit.common.BackendException
        Add administrative role and resources to a list of users.
        Parameters:
        listUserBean - List of UserBean the list of user
        entitlementBean - EntitlementBean the administrative role to add
        listResources - List of AbstractBean the list of resources to add
        visibilityViolation - boolean: true if is in visibility violation, false otherwise
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • insertFamily

        JobRoleFamilyBean insertFamily(JobRoleFamilyBean familyBean,
                               com.engiweb.pm.dao.db.DAO dao)
                        throws com.engiweb.toolkit.common.BackendException
        Insert family.
        Parameters:
        familyBean - JobRoleFamilyBean the family
        dao - DAO the connection dao
        Returns:
        JobRoleFamilyBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • updateFamily

        void updateFamily(JobRoleFamilyBean familyBean,
                  com.engiweb.pm.dao.db.DAO dao)
           throws com.engiweb.toolkit.common.BackendException
        Update family.
        Parameters:
        familyBean - JobRoleFamilyBean the family
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • deleteFamily

        void deleteFamily(JobRoleFamilyBean familyBean,
                  com.engiweb.pm.dao.db.DAO dao)
           throws com.engiweb.toolkit.common.BackendException
        Delete family.
        Parameters:
        familyBean - JobRoleFamilyBean the family
        dao - DAO the connection dao
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findFamily

        com.engiweb.pm.entity.BeanList<JobRoleFamilyBean> findFamily(JobRoleFamilyBean familyBean,
                                                             com.engiweb.pm.entity.Paging paging,
                                                             com.engiweb.pm.dao.db.DAO dao)
                                                      throws com.engiweb.toolkit.common.BackendException
        Find family.
        Parameters:
        familyBean - JobRoleFamilyBean the family
        paging - Paging the paging
        dao - DAO connection the dao
        Returns:
        BeanList of JobRoleFamilyBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findPermissionWithRights

        com.engiweb.pm.entity.BeanList<EntitlementBean> findPermissionWithRights(EntitlementBean permissionBean,
                                                                         EntitlementBean parentBean,
                                                                         com.engiweb.pm.entity.Paging p,
                                                                         com.engiweb.pm.dao.db.DAO dao)
                                                                  throws com.engiweb.toolkit.common.BackendException
        Find permission with rights.
        Parameters:
        permissionBean - EntitlementBean the permission
        parentBean - EntitlementBean the parent
        p - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findFlatFulfilledChilds

        com.engiweb.pm.entity.BeanList<EntitlementBean> findFlatFulfilledChilds(EntitlementBean proBean,
                                                                        EntitlementBean entitlementBean,
                                                                        com.engiweb.pm.entity.Paging paging,
                                                                        com.engiweb.pm.dao.db.DAO dao)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Returns profile starting from a published entitlement.
        Parameters:
        proBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean the entitlement
        paging - Paging the paging
        dao - DAO the connection dao
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findUser

        com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  EntitlementBean entitlementBean,
                                                  com.engiweb.pm.entity.Paging paging,
                                                  java.lang.String code_scope,
                                                  com.engiweb.pm.dao.db.DAO connDao)
                                           throws com.engiweb.toolkit.common.BackendException
        Throws:
        com.engiweb.toolkit.common.BackendException
Skip navigation links