com.engiweb.profilemanager.common.interfaces

Interface IEntitlement

  • All Superinterfaces:
    com.engiweb.toolkit.interfaces.IEjb

    public interface IEntitlement
extends com.engiweb.toolkit.interfaces.IEjb
    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,
                                                                java.lang.String token,
                                                                java.lang.String realm)
                                                         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,
                                                                java.lang.String token,
                                                                java.lang.String realm)
                                                         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
        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,
                                                                TaskBean taskBean,
                                                                boolean taskHier,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                java.lang.String token,
                                                                java.lang.String realm)
                                                         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
        taskBean - TaskBean if null no filter is applied, otherwise the passed object is used as filter
        taskHier - boolean: enable a hierarchical search on tasks
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • insertEntitlement

        EntitlementBean insertEntitlement(EntitlementBean entitlementBean,
                                  java.lang.String cod_oper,
                                  java.lang.String token,
                                  java.lang.String realm)
                           throws com.engiweb.toolkit.common.BackendException
        Add a new entitlement.
        Parameters:
        entitlementBean - EntitlementBean to add (mandatory)
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        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,
                                  java.lang.String cod_oper,
                                  java.lang.String token,
                                  java.lang.String realm)
                           throws com.engiweb.toolkit.common.BackendException
        Updates an existing entitlement.
        Parameters:
        entitlementBean - EntitlementBean to update (mandatory)
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        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,
                       java.lang.String cod_oper,
                       java.lang.String token,
                       java.lang.String realm)
                throws com.engiweb.toolkit.common.BackendException
        Deletes an existing entitlement.
        Parameters:
        entitlementBean - the entitlement bean
        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 - the backend exception EntitlementBean to delete (mandatory).It must be present and uniquely defined.

      • addEntitlementChild

        void addEntitlementChild(EntitlementBean entitlementBean,
                         EntitlementBean entitlementParentBean,
                         java.lang.String cod_oper,
                         java.lang.String token,
                         java.lang.String realm)
                  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 parent bean (Mandatory)
        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 - the backend exception

      • addEntitlementChild

        void addEntitlementChild(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                         EntitlementBean entitlementParentBean,
                         java.lang.String cod_oper,
                         java.lang.String token,
                         java.lang.String realm)
                  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 to add (Manadatory)
        entitlementParentBean - EntitlementBean parent (mandatory)
        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 - the backend exception

      • findEntitlementChild

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementChild(EntitlementBean entitlementBean,
                                                                     EntitlementBean entitlementParentBean,
                                                                     com.engiweb.pm.entity.Paging paging,
                                                                     java.lang.String token,
                                                                     java.lang.String realm)
                                                              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 parent bean. Mandatory and well defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        the bean list
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • removeEntitlementChild

        void removeEntitlementChild(EntitlementBean entitlementBean,
                            EntitlementBean entitlementParentBean,
                            java.lang.String cod_oper,
                            java.lang.String token,
                            java.lang.String realm)
                     throws com.engiweb.toolkit.common.BackendException
        Removes an entitlement as child of another one.
        Parameters:
        entitlementBean - EntitlementBean to remove (Mandatory)
        entitlementParentBean - EntitlementBean parent (Mandatory)
        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 - the backend exception

      • removeEntitlementChild

        void removeEntitlementChild(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                            EntitlementBean entitlementParentBean,
                            java.lang.String cod_oper,
                            java.lang.String token,
                            java.lang.String realm)
                     throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlement as child of another one.
        Parameters:
        blEntitlementBean - BeanList of EntitlementBean to remove (Mandatory)
        entitlementParentBean - tEntitlementBean parent (Mandatory)
        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 - the backend exception

      • findEntitlementParent

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementParent(EntitlementBean entitlementBean,
                                                                      com.engiweb.pm.entity.Paging paging,
                                                                      java.lang.String token,
                                                                      java.lang.String realm)
                                                               throws com.engiweb.toolkit.common.BackendException
        Returns all first level parents of an entitlement.
        Parameters:
        entitlementBean - EntitlementBean 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 EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • findProperties

        com.engiweb.pm.entity.BeanList<PropertyBean> findProperties(PropertyBean propBean,
                                                            EntitlementBean entitlementBean,
                                                            java.lang.String cod_oper,
                                                            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 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.
        cod_oper - String Code operation. If null PM generates it automatically
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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,
                   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 entitlement.
        Parameters:
        blPropertyBean - BeanList of PropertyBean to add to an entitlement bean
        entitlementBean - EntitlementBean to which properties must be assigned.
        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 - the backend exception

      • removeProperties

        void removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                      EntitlementBean entitlementBean,
                      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 entitlement.
        Parameters:
        blPropertyBean - BeanList of PropertyBean to remome from an entitlement bean
        entitlementBean - EntitlementBean from which properties must be removed.
        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 - the backend exception

      • checkHierarchy

        int checkHierarchy(EntitlementBean entitlementBean,
                   EntitlementBean entitlementParentBean,
                   java.lang.String cod_oper,
                   java.lang.String token,
                   java.lang.String realm)
            throws com.engiweb.toolkit.common.BackendException
        Check if there are loops o problems about the hierarchy of two entitlements.
        Parameters:
        entitlementBean - EntitlementBean
        entitlementParentBean - EntitlementBean parent
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Returns:
        int 0 if everything is right. An exception otherwise
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • setPublishedEntitlement

        void setPublishedEntitlement(EntitlementBean entitlementBean,
                             boolean publish,
                             java.lang.String cod_oper,
                             java.lang.String token,
                             java.lang.String realm)
                      throws com.engiweb.toolkit.common.BackendException
        Set an entitlement as published or unpublished.
        Parameters:
        entitlementBean - EntitlementBean to be set as puplished/unpublished
        publish - true if the entitlement must be published, false otherwise
        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 - the backend exception

      • findUser

        com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  EntitlementBean entitlementBean,
                                                  GroupBean groupBean,
                                                  HierarchyBean hierarchyBean,
                                                  com.engiweb.pm.entity.Paging paging,
                                                  java.lang.String token,
                                                  java.lang.String realm)
                                           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
        hierarchyBean - HierarchyBean mandatory
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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,
                                                  com.engiweb.pm.entity.Paging paging,
                                                  java.lang.String token,
                                                  java.lang.String realm)
                                           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.
        delegated - Boolean search only for user having the role as delegated if true, directly assigned if false. If null it doesn't filter
        groupBean - GroupBean
        hierarchyBean - HierarchyBean mandatory
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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,
                                                                    java.lang.String token,
                                                                    java.lang.String realm)
                                                             throws com.engiweb.toolkit.common.BackendException
        Deprecated. 
        Returns organization unit having an entitlement.
        Parameters:
        orgUnitBean - OrgUnitBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned organizational unit are to be retrieved.
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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,
                                                    java.lang.String token,
                                                    java.lang.String realm)
                                             throws com.engiweb.toolkit.common.BackendException
        Returns a group having having an entitlement.
        Parameters:
        groupBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter
        hierarchyBean - HierarchyBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned group are to be retrieved. Mandatory.
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of GroupBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • findGroup

        com.engiweb.pm.entity.BeanList<GroupBean> findGroup(GroupBean groupBean,
                                                    EntitlementBean entitlementBean,
                                                    UserBean userBean,
                                                    com.engiweb.pm.entity.Paging paging,
                                                    java.lang.String token,
                                                    java.lang.String realm)
                                             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
        token - String Authorization string
        realm - String Realm name
        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,
                                                            java.lang.String token,
                                                            java.lang.String realm)
                                                     throws com.engiweb.toolkit.common.BackendException
        Returns ProfileBean starting from a published entitlement.
        Parameters:
        proBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned profiles are to be retrieved.
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of ProfileBean
        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,
                                                                java.lang.String token,
                                                                java.lang.String realm)
                                                         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 whose assigned application are to be retrieved.
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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,
                                                                         java.lang.String token,
                                                                         java.lang.String realm)
                                                                  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
        token - String Authorization string
        realm - String Realm name
        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 token,
                                                                       java.lang.String realm)
                                                                throws com.engiweb.toolkit.common.BackendException
        Deprecated. 
        Returns users having a fixed profile into an organization unit.
        Parameters:
        userBean - UsertBean if null no filter is applied, otherwise the passed object is used as filter
        ouBean - OrgUnitBean if null no filter is applied, otherwise it must be well defined
        entitlementBean - EntitlementBean whose assigned user are to be retrieved.
        hier - true if research must be performed hierarchically, false otherwise
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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 token,
                                                           java.lang.String realm)
                                                    throws com.engiweb.toolkit.common.BackendException
        Returns users having a fixed profile
        Parameters:
        userBean - UsertBean if null no filter is applied, otherwise the passed object is used as filter
        groupBean - GroupBean if null no filter is applied, otherwise it must be well defined
        hierarchyBean - HierarchyBean is mandatory when the GroupBean is used as a filter.
        entitlementBean - EntitlementBean whose assigned user are to be retrieved.
        hier - 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
        token - String Authorization string
        realm - String Realm name
        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 token,
                                                                       java.lang.String realm)
                                                                throws com.engiweb.toolkit.common.BackendException
        Deprecated. 
        Returns users having a list of profiles.
        Parameters:
        userBean - UsertBean if null no filter is applied, otherwise the passed object is used as filter
        ouBean - OrgUnitBean if null no filter is applied, otherwise it must be well defined
        blEntitlementBean - BeanList of EntitlementBean whose assigned user are to be retrieved.
        hier - if ouBean is not null, it specifies if the research must be done in hierarchy or not
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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 token,
                                                           java.lang.String realm)
                                                    throws com.engiweb.toolkit.common.BackendException
        Returns users having a list of profiles.
        Parameters:
        userBean - UsertBean if null no filter is applied, otherwise the passed object is used as filter
        groupBean - GroupBean if null no filter is applied, otherwise it must be well defined
        hierarchyBean - HierarchyBean is mandatory when the GroupBean is used as a filter.
        blEntitlementBean - BeanList of EntitlementBean whose assigned user are to be retrieved.
        hier - if GroupBean 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
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging

      • deleteEntitlement

        void deleteEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                       java.lang.String codOper,
                       java.lang.String token,
                       java.lang.String realm)
                throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlements.
        Parameters:
        blEntitlementBean - BeanList of EntitlementBean to remove
        codOper - the cod oper
        token - String Authorization string
        realm - String Realm name
        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,
                                                               java.lang.String token,
                                                               java.lang.String realm)
                                                        throws com.engiweb.toolkit.common.BackendException
        Returns published entitlements having a property.
        Parameters:
        entitlementBean - the entitlement bean
        propertyBean - the property bean
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the pM security exception EntitlementBean It must be present and uniquely defined PropertyBean It must be present and uniquely defined Paging

      • findEntitlementObjExt

        com.engiweb.pm.entity.BeanList<EntitlementObjExtBean> findEntitlementObjExt(EntitlementObjExtBean entitlementObjExtBean,
                                                                            EntitlementBean entitlementBean,
                                                                            com.engiweb.pm.entity.Paging paging,
                                                                            java.lang.String token,
                                                                            java.lang.String realm)
                                                                     throws com.engiweb.toolkit.common.BackendException
        Find entitlement obj ext.
        Parameters:
        entitlementObjExtBean - EntitlementObjExtBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned external object are to be retrieved.
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        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,
                                                                         java.lang.String token,
                                                                         java.lang.String realm)
                                                                  throws com.engiweb.toolkit.common.BackendException
        Find entitlement by profile.
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementProfileBean - EntitlementBean profile whose assigned entitlement object are to be retrieved.
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception

      • revertEntitlementHistory

        void revertEntitlementHistory(EntitlementBean entitlementBean,
                              java.lang.String token,
                              java.lang.String realm)
                       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 whose history must be revert
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException

      • signOffEntitlement

        void signOffEntitlement(EntitlementBean entitlementBean,
                        java.lang.String token,
                        java.lang.String realm)
                 throws com.engiweb.toolkit.common.BackendException
        Parameters:
        entitlementBean -
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException

      • findDependency

        com.engiweb.pm.entity.BeanList<EntitlementBean> findDependency(EntitlementBean filterEntBean,
                                                               EntitlementBean entitlementBean,
                                                               com.engiweb.pm.entity.Paging paging,
                                                               java.lang.String token,
                                                               java.lang.String realm)
                                                        throws com.engiweb.toolkit.common.BackendException
        Parameters:
        filterEntBean -
        entitlementBean -
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        Throws:
        com.engiweb.toolkit.common.BackendException

      • addDependency

        void addDependency(java.util.List<EntitlementBean> listDependencyBean,
                   EntitlementBean entitlementBean,
                   com.engiweb.pm.entity.Paging paging,
                   java.lang.String token,
                   java.lang.String realm)
            throws com.engiweb.toolkit.common.BackendException
        Parameters:
        listDependencyBean -
        entitlementBean -
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException

      • removeDependency

        void removeDependency(java.util.List<EntitlementBean> listDependencyBean,
                      EntitlementBean entitlementBean,
                      com.engiweb.pm.entity.Paging paging,
                      java.lang.String token,
                      java.lang.String realm)
               throws com.engiweb.toolkit.common.BackendException
        Parameters:
        listDependencyBean -
        entitlementBean -
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException

      • addUser

        void addUser(java.util.List<UserBean> listUserBean,
             EntitlementBean entitlementBean,
             java.util.List<com.engiweb.pm.web.bean.AbstractBean> listResources,
             boolean visibilityViolation,
             java.lang.String codOper,
             java.lang.String token,
             java.lang.String realm)
      throws com.engiweb.toolkit.common.BackendException
        Add administrative role and resources to users
        Parameters:
        listUserBean -
        entitlementBean -
        listResources -
        visibilityViolation -
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException

      • insertFamily

        JobRoleFamilyBean insertFamily(JobRoleFamilyBean familyBean,
                               java.lang.String cod_oper,
                               java.lang.String token,
                               java.lang.String realm)
                        throws com.engiweb.toolkit.common.BackendException
        Parameters:
        familyBean -
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Returns:
        Throws:
        com.engiweb.toolkit.common.BackendException

      • updateFamily

        void updateFamily(JobRoleFamilyBean familyBean,
                  java.lang.String cod_oper,
                  java.lang.String token,
                  java.lang.String realm)
           throws com.engiweb.toolkit.common.BackendException
        Parameters:
        familyBean -
        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

      • deleteFamily

        void deleteFamily(JobRoleFamilyBean familyBean,
                  java.lang.String cod_oper,
                  java.lang.String token,
                  java.lang.String realm)
           throws com.engiweb.toolkit.common.BackendException
        Parameters:
        familyBean -
        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

      • findFamily

        com.engiweb.pm.entity.BeanList<JobRoleFamilyBean> findFamily(JobRoleFamilyBean familyBean,
                                                             com.engiweb.pm.entity.Paging paging,
                                                             java.lang.String token,
                                                             java.lang.String realm)
                                                      throws com.engiweb.toolkit.common.BackendException
        Parameters:
        familyBean -
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        Throws:
        com.engiweb.toolkit.common.BackendException

      • findPermissionWithRights

        com.engiweb.pm.entity.BeanList<EntitlementBean> findPermissionWithRights(EntitlementBean permissionBean,
                                                                         EntitlementBean parentBean,
                                                                         com.engiweb.pm.entity.Paging paging,
                                                                         java.lang.String token,
                                                                         java.lang.String realm)
                                                                  throws com.engiweb.toolkit.common.BackendException
        Parameters:
        permissionBean -
        parentBean -
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        Throws:
        com.engiweb.toolkit.common.BackendException

      • findFlatFulfilledChilds

        com.engiweb.pm.entity.BeanList<EntitlementBean> findFlatFulfilledChilds(EntitlementBean proBean,
                                                                        EntitlementBean entitlementBean,
                                                                        com.engiweb.pm.entity.Paging paging,
                                                                        java.lang.String token,
                                                                        java.lang.String realm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Returns EntitlementBean starting from a published entitlement.
        Parameters:
        proBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean whose assigned profiles are to be retrieved.
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception Paging
Skip navigation links