com.engiweb.profilemanager.common.interfaces

Interface IGroup

All Superinterfaces:

com.engiweb.toolkit.interfaces.IEjb

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

The IGroup interface allows a client to retrieve and manage all information about group objects

Author:

CrossIdeas developer group

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	addInNoDefHierGroup(UserBean userBean, GroupBean groupBean, java.lang.String token, java.lang.String realm) Add an existing user (in the ORGANIZATIONAL_UNIT hierarchy) to a group of another hierarchy
void	addProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean, GroupBean groupBean, java.lang.String token, java.lang.String realmAdm) Adds a list of properties to a group
void	addResources(com.engiweb.pm.entity.BeanList<ResourceBean> blResources, GroupBean groupBean, boolean hier, boolean employee, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a list of ResourceBean to a group
void	addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlement, GroupBean groupBean, boolean hier, boolean alignUserToDef, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Deprecated.
void	addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl, GroupBean groupBean, boolean hier, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Add a list of EntitlementBean to an GroupBean
void	addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlement, GroupBean groupBean, com.engiweb.profilemanager.common.util.EntitlementStatusOption entitlementStatusOption, boolean hier, boolean alignUserToDef, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a list of entitlements to a group
void	delete(GroupBean groupBean, HierarchyBean hierarchyBean, boolean hier, java.lang.String token, java.lang.String realm) Deletes an existing group.
void	deleteType(OUTypeBean ouTypeBean, java.lang.String token, java.lang.String realm) Removes an existing group type.
com.engiweb.pm.entity.BeanList<GroupBean>	find(GroupBean groupBean, HierarchyBean hierarchyBean, GroupBean groupStart, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the groups filtered by a passed GroupBean object starting from a start Group.
com.engiweb.pm.entity.BeanList<GroupBean>	find(GroupBean groupBean, HierarchyBean hierarchyBean, GroupBean startGroupBean, TaskBean taskBean, boolean taskHier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the groups filtered by a passed GroupBean object starting from a start Group.
com.engiweb.pm.entity.BeanList<ApplicationBean>	findApplication(ApplicationBean appBean, GroupBean groupBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of applications associated to entitlements belonging to a group
com.engiweb.pm.entity.BeanList<ApplicationBean>	findApplicationByEntitlement(ApplicationBean appBean, EntitlementBean entBean, GroupBean groupBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of applications belonging to a group (punctually or hierarchically) filtered by an entitlement
com.engiweb.pm.entity.BeanList<EntitlementBean>	findEntitlement(EntitlementBean entBean, ApplicationBean appBean, GroupBean groupBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of entitlements belonging to a group (punctually or hierarchically) filtered by an application
com.engiweb.pm.entity.BeanList<GroupBean>	findInHier(GroupBean groupBean, HierarchyBean hierarchyBean, boolean findAdmin, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the children nodes of the passed Group
com.engiweb.pm.entity.BeanList<GroupBean>	findInHier(GroupBean groupBean, HierarchyBean hierarchyBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the children nodes of the passed Group
com.engiweb.pm.entity.BeanList<GroupBean>	findParent(GroupBean groupBean, HierarchyBean hierarchyBean, boolean showAdmin, java.lang.String token, java.lang.String realm) Returns the parent tree of the passed Group.
com.engiweb.pm.entity.BeanList<PropertyBean>	findProperty(PropertyBean propertyBean, GroupBean groupBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realmAdm) Returns a list of properties assigned to a group
com.engiweb.pm.entity.BeanList<ResourceBean>	findResource(ResourceBean resourcBean, GroupBean groupBean, com.engiweb.pm.entity.Paging paging, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Returns the resources filtered by a passed ResourceBean object assigned to a group
com.engiweb.pm.entity.BeanList<GroupBean>	findRoot(HierarchyBean hierarchyBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of hierarchy roots
com.engiweb.pm.entity.BeanList<OUTypeBean>	findType(OUTypeBean ouTypeBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the group types filtered by a passed OUTypeBean object
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 token, java.lang.String realm) Returns a list of users filtered by entitlement belonging to a group or one of its sons (if hier is true)
com.engiweb.pm.entity.BeanList<UserBean>	findUser(UserBean userBean, EntitlementBean entitlementBean, GroupBean groupBean, HierarchyBean hierarchyBean, boolean hier, TaskBean taskBean, boolean taskHier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of users filtered by entitlement belonging to a group or one of its sons (if hier is true)
com.engiweb.pm.entity.BeanList<UserBean>	findUser(UserBean userBean, GroupBean groupBean, HierarchyBean hierarchyBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of users belonging to a group or one of its sons (if hier is true)
GroupBean	insert(GroupBean groupBean, HierarchyBean hierarchyBean, GroupBean groupParentBean, boolean parentEntitlements, boolean parentResources, java.lang.String token, java.lang.String realm) Adds a new group, if it not exists yet, to the group tree.
OUTypeBean	insertType(OUTypeBean ouTypeBean, java.lang.String token, java.lang.String realm) Adds a new organization unit type if it not exists yet.
void	modifyRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl, GroupBean groupBean, com.engiweb.profilemanager.common.util.EntitlementStatusOption entitlementStatusOption, boolean hier, boolean alignUserToDef, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Updates Default, VisibilityViolation and/or enabled property from a list of entitlements belonging to a group
void	modifySOD(GroupBean groupBean, HierarchyBean hierarchyBean, boolean enableSOD, boolean hier, java.lang.String token, java.lang.String realm) Modify SOD on the group punctually or hierarchically
void	removeFromNoDefHierGroup(UserBean userBean, GroupBean groupBean, java.lang.String token, java.lang.String realm) Remove an user from a group belonging to a not default hierarchy (hierarchy id<>1)
void	removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean, GroupBean groupBean, java.lang.String token, java.lang.String realmAdm) Removes a list of properties from an application
void	removeResources(com.engiweb.pm.entity.BeanList<ResourceBean> blResources, GroupBean groupBean, boolean hier, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Removes a list of ResourceBean from a group
void	removeRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl, GroupBean groupBean, boolean hier, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Removes a list of entitlements from a group
GroupBean	update(GroupBean groupBean, GroupBean groupParentBean, java.lang.String token, java.lang.String realm) Updates an existing group
void	updateType(OUTypeBean ouTypeBean, java.lang.String token, java.lang.String realm) Updates an existing organization type

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

checkAB

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

Copyright

See Also:

Constant Field Values

Method Detail

insert

GroupBean insert(GroupBean groupBean,
                 HierarchyBean hierarchyBean,
                 GroupBean groupParentBean,
                 boolean parentEntitlements,
                 boolean parentResources,
                 java.lang.String token,
                 java.lang.String realm)
          throws com.engiweb.toolkit.common.BackendException

Adds a new group, if it not exists yet, to the group tree. Group parent is mandatory.

Parameters:

groupBean - GroupBean to add (mandatory)

hierarchyBean - HierarchyBean mandatory

groupParentBean - GroupBean parent of the new group.It must be present and uniquely defined.

parentEntitlements - If true, all entitlements belonging to parent Group will be assigned to the new child Group

parentResources - If true, all resources belonging to parent Group will be assigned to the new child Group

token - String Authorization string

realm - String Realm name

Returns:

GroupBean added

Throws:

com.engiweb.toolkit.common.BackendException

update

GroupBean update(GroupBean groupBean,
                 GroupBean groupParentBean,
                 java.lang.String token,
                 java.lang.String realm)
          throws com.engiweb.toolkit.common.BackendException

Updates an existing group

Parameters:

groupBean - GroupBean to update (mandatory)

groupParentBean - GroupBean parent of the updated group.It must be present and uniquely defined.

token - String Authorization string

realm - String Realm name

Returns:

GroupBean updated.

Throws:

com.engiweb.toolkit.common.BackendException

delete

void delete(GroupBean groupBean,
            HierarchyBean hierarchyBean,
            boolean hier,
            java.lang.String token,
            java.lang.String realm)
     throws com.engiweb.toolkit.common.BackendException

Deletes an existing group.

Parameters:

groupBean - GroupBean to delete (mandatory). If Group is not a leaf, then all nested Groups will be assigned to its associated parent Group

hierarchyBean - HierarchyBean mandatory

boolean - hier: if true group and its sons will be deleted

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

find

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

Returns the groups filtered by a passed GroupBean object starting from a start Group. Is startGroup is null or not uniquely defined, the start Group is defined according to user visibility

Parameters:

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

hierarchyBean - HierarchyBean manadatory

groupStart - GroupBean Group from which research must be performed. If null or id or code is not set start Group is defined according to user visibility

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of GroupBean

Throws:

com.engiweb.toolkit.common.BackendException

find

com.engiweb.pm.entity.BeanList<GroupBean> find(GroupBean groupBean,
                                               HierarchyBean hierarchyBean,
                                               GroupBean startGroupBean,
                                               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 groups filtered by a passed GroupBean object starting from a start Group. Is startGroup is null or not uniquely defined, the start Group is defined according to user visibility

Parameters:

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

hierarchyBean - HierarchyBean manadatory

groupStart - GroupBean Group from which research must be performed. If null or id or code is not set start Group is defined according to user visibility

taskBean - TaskBean 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 GroupBean

Throws:

com.engiweb.toolkit.common.BackendException

addResources

void addResources(com.engiweb.pm.entity.BeanList<ResourceBean> blResources,
                  GroupBean groupBean,
                  boolean hier,
                  boolean employee,
                  java.lang.String cod_oper,
                  java.lang.String token,
                  java.lang.String realm)
           throws com.engiweb.toolkit.common.BackendException

Adds a list of ResourceBean to a group

Parameters:

blResources - BeanList of ResourceBean to add. Resources must be present and uniquely defined.

groupBean - GroupBean to which add resources. It must be present and uniquely defined.

hier - boolean if true resources will be add to group in hierarchical mode.

employ - boolean if true resources will be assigned to all employments according with passed Group

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

removeResources

void removeResources(com.engiweb.pm.entity.BeanList<ResourceBean> blResources,
                     GroupBean groupBean,
                     boolean hier,
                     java.lang.String cod_oper,
                     java.lang.String token,
                     java.lang.String realm)
              throws com.engiweb.toolkit.common.BackendException

Removes a list of ResourceBean from a group

Parameters:

blResources - BeanList of ResourceBean to remove. Resources must be present and uniquely defined.

groupBean - GroupBean from which remove resources. It must be present and uniquely defined.

hier - if true resources will be will be removed from group in hierarchical mode.

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

findResource

com.engiweb.pm.entity.BeanList<ResourceBean> findResource(ResourceBean resourcBean,
                                                          GroupBean groupBean,
                                                          com.engiweb.pm.entity.Paging paging,
                                                          java.lang.String cod_oper,
                                                          java.lang.String token,
                                                          java.lang.String realm)
                                                   throws com.engiweb.toolkit.common.BackendException

Returns the resources filtered by a passed ResourceBean object assigned to a group

Parameters:

ceBean - resourcBean ResourceBean if null no filter is applied, otherwise the passed object is used as filter

groupBean - GroupBean in which to search for the resources

Paging - paging: Paging

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

token - String Authorization string

realm - String Realm name

Returns:

BeanList of ResourceBean

Throws:

com.engiweb.toolkit.common.BackendException

findParent

com.engiweb.pm.entity.BeanList<GroupBean> findParent(GroupBean groupBean,
                                                     HierarchyBean hierarchyBean,
                                                     boolean showAdmin,
                                                     java.lang.String token,
                                                     java.lang.String realm)
                                              throws com.engiweb.toolkit.common.BackendException

Returns the parent tree of the passed Group. Explore the Group tree tracing and returning the passed ou parents The path ends when the scope of the user is reached.

Parameters:

groupBean - GroupBean that you want to find the parent tree. It must be present end uniquely defined

hierarchyBean - HierarchyBean manadatory

boolean - showAdmin: if true returs the ou's administrators

token - String Authorization string

realm - String Realm name

Returns:

BeanList of GroupBean

Throws:

com.engiweb.toolkit.common.BackendException

findInHier

com.engiweb.pm.entity.BeanList<GroupBean> findInHier(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 the children nodes of the passed Group

Parameters:

groupBean - GroupBean that you want to find the sons. It must be present end uniquely defined

hierarchyBean - HierarchyBean manadatory

token - String Authorization string

realm - String Realm name

Returns:

BeanList of GroupBean

Throws:

com.engiweb.toolkit.common.BackendException

findInHier

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

Returns the children nodes of the passed Group

Parameters:

groupBean - GroupBean that you want to find the sons. It must be present end uniquely defined

hierarchyBean - HierarchyBean manadatory

boolean - findAdmin set true if you want to retrieve the aministrator associated to the ous

token - String Authorization string

realm - String Realm name

Returns:

BeanList of GroupBean

Throws:

com.engiweb.toolkit.common.BackendException

insertType

OUTypeBean insertType(OUTypeBean ouTypeBean,
                      java.lang.String token,
                      java.lang.String realm)
               throws com.engiweb.toolkit.common.BackendException

Adds a new organization unit type if it not exists yet.

Parameters:

ouTypeBean - OUTypeBean to insert (mandatory). The group type name is a mandatory field.

token - String Authorization string

realm - String Realm name

Returns:

GroupBean created

Throws:

com.engiweb.toolkit.common.BackendException

updateType

void updateType(OUTypeBean ouTypeBean,
                java.lang.String token,
                java.lang.String realm)
         throws com.engiweb.toolkit.common.BackendException

Updates an existing organization type

Parameters:

ouTypeBean - OUTypeBean to update (mandatory).It must be present and uniquely defined.

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

deleteType

void deleteType(OUTypeBean ouTypeBean,
                java.lang.String token,
                java.lang.String realm)
         throws com.engiweb.toolkit.common.BackendException

Removes an existing group type. When a group type is removed, group type of groups having that type is set to null

Parameters:

ouTypeBean - OUTypeBean to delete (mandatory).It must be present and uniquely defined.

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

findType

com.engiweb.pm.entity.BeanList<OUTypeBean> findType(OUTypeBean ouTypeBean,
                                                    com.engiweb.pm.entity.Paging paging,
                                                    java.lang.String token,
                                                    java.lang.String realm)
                                             throws com.engiweb.toolkit.common.BackendException

Returns the group types filtered by a passed OUTypeBean object

Parameters:

ouTypeBean - OUTypeBean 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 GroupTypeBean

Throws:

com.engiweb.toolkit.common.BackendException

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 token,
                                                  java.lang.String realm)
                                           throws com.engiweb.toolkit.common.BackendException

Returns a list of users filtered by entitlement belonging to a group or one of its sons (if hier is true)

Parameters:

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

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

groupBean - GroupBeanif null user unassigned to any group in the hierarchy are returned

hierarchyBean - HierarchyBean mandatory

boolean - hier: if true the research is performed hierarchically

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

findUser

com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  EntitlementBean entitlementBean,
                                                  GroupBean groupBean,
                                                  HierarchyBean hierarchyBean,
                                                  boolean hier,
                                                  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 a list of users filtered by entitlement belonging to a group or one of its sons (if hier is true)

Parameters:

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

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

groupBean - GroupBeanif null user unassigned to any group in the hierarchy are returned

hierarchyBean - HierarchyBean mandatory

hier - boolean: if true the research is performed hierarchically

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

taskHier - boolean: if true the research is performed hierarchically

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

findUser

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

Returns a list of users belonging to a group or one of its sons (if hier is true)

Parameters:

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

groupBean - GroupBeanif null user unassigned to any group in the hierarchy are returned

hierarchyBean - HierarchyBean mandatory

hier - boolean: if true the research is performed hierarchically

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

addRoles

void addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlement,
              GroupBean groupBean,
              com.engiweb.profilemanager.common.util.EntitlementStatusOption entitlementStatusOption,
              boolean hier,
              boolean alignUserToDef,
              java.lang.String cod_oper,
              java.lang.String token,
              java.lang.String realm)
       throws com.engiweb.toolkit.common.BackendException

Adds a list of entitlements to a group

Parameters:

alignUserToDef -

blEntitlement - BeanList of EntitlementBean on which can be set some properties (DEFAULT, VISIBILITY_VIOLATION, ENALBLED). Entitlements must be present and uniquely defined

groupBean - GroupBean must be present and uniquely defined

hier - boolean: if true adds is performed hierarchically

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

addRoles

@Deprecated
void addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlement,
                          GroupBean groupBean,
                          boolean hier,
                          boolean alignUserToDef,
                          java.lang.String cod_oper,
                          java.lang.String token,
                          java.lang.String realm)
                   throws com.engiweb.toolkit.common.BackendException

Deprecated.

Throws:

com.engiweb.toolkit.common.BackendException

addRoles

void addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl,
              GroupBean groupBean,
              boolean hier,
              java.lang.String cod_oper,
              java.lang.String token,
              java.lang.String realm)
       throws com.engiweb.toolkit.common.BackendException

Add a list of EntitlementBean to an GroupBean

Parameters:

entBl - BeanList of well defined EntitlementBean to add

groupBean - GroupBean to which enitlements must be add

hier - boolean: if true entitlement are assigned hierarchically

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

modifyRoles

void modifyRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl,
                 GroupBean groupBean,
                 com.engiweb.profilemanager.common.util.EntitlementStatusOption entitlementStatusOption,
                 boolean hier,
                 boolean alignUserToDef,
                 java.lang.String cod_oper,
                 java.lang.String token,
                 java.lang.String realm)
          throws com.engiweb.toolkit.common.BackendException

Updates Default, VisibilityViolation and/or enabled property from a list of entitlements belonging to a group

Parameters:

blEntitlement: - BeanList of EntitlementBean on which EntitlementStatusOption properties can be updated. Entitlements must be present and uniquely

groupBean: - GroupBean must be present and uniquely defined

entitlementStatusOption - : EntitlementStatusOption entitlement properties that must/can be updated

boolean - hier: if true updates is performed hierarchically

boolean - alignUserToDef: true if roles must to be assigned to already present OU users

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

removeRoles

void removeRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl,
                 GroupBean groupBean,
                 boolean hier,
                 java.lang.String cod_oper,
                 java.lang.String token,
                 java.lang.String realm)
          throws com.engiweb.toolkit.common.BackendException

Removes a list of entitlements from a group

Parameters:

blEntitlement - BeanList of EntitlementBean to remove, They must be present and uniquely defined

groupBean - GroupBean must be present and uniquely defined

hier - if true removal operation is performed hierarchically

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

findApplication

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

Returns a list of applications associated to entitlements belonging to a group

Parameters:

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

groupBean - GroupBean must be present and uniquely defined

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of ApplicationBean

Throws:

com.engiweb.toolkit.common.BackendException

modifySOD

void modifySOD(GroupBean groupBean,
               HierarchyBean hierarchyBean,
               boolean enableSOD,
               boolean hier,
               java.lang.String token,
               java.lang.String realm)
        throws com.engiweb.toolkit.common.BackendException

Modify SOD on the group punctually or hierarchically

Parameters:

groupBean - GroupBean if null the group in the user scope is used

hierarchyBean - HierarchyBean mandatory

enableSOD - if true SOD is enabled

hier - if true modify is performed hierarchically

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

removeProperties

void removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                      GroupBean groupBean,
                      java.lang.String token,
                      java.lang.String realmAdm)
               throws com.engiweb.toolkit.common.BackendException

Removes a list of properties from an application

Parameters:

blPropertyBean - BeanList of PropertyBean to remove from application.

groupBean - GroupBean must be present and uniquely defined

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

findProperty

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

Returns a list of properties assigned to a group

Parameters:

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

groupBean - GroupBean must be present and uniquely defined

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of PropertyBean

Throws:

com.engiweb.toolkit.common.BackendException

addProperties

void addProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean,
                   GroupBean groupBean,
                   java.lang.String token,
                   java.lang.String realmAdm)
            throws com.engiweb.toolkit.common.BackendException

Adds a list of properties to a group

Parameters:

blPropertyBean - BeanList of PropertyBean to add to group

groupBean - GroupBean must be present and uniquely defined

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

findEntitlement

com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entBean,
                                                                ApplicationBean appBean,
                                                                GroupBean groupBean,
                                                                boolean hier,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                java.lang.String token,
                                                                java.lang.String realm)
                                                         throws com.engiweb.toolkit.common.BackendException

Returns a list of entitlements belonging to a group (punctually or hierarchically) filtered by an application

Parameters:

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

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

groupBean - GroupBean must be present and uniquely defined // * @param hierarchyBean // * HierarchyBean mandatory

hier - if true research is performed hierarchically

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of EntitlementBean

Throws:

com.engiweb.toolkit.common.BackendException

findApplicationByEntitlement

com.engiweb.pm.entity.BeanList<ApplicationBean> findApplicationByEntitlement(ApplicationBean appBean,
                                                                             EntitlementBean entBean,
                                                                             GroupBean groupBean,
                                                                             com.engiweb.pm.entity.Paging paging,
                                                                             java.lang.String token,
                                                                             java.lang.String realm)
                                                                      throws com.engiweb.toolkit.common.BackendException

Returns a list of applications belonging to a group (punctually or hierarchically) filtered by an entitlement

Parameters:

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

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

groupBean - GroupBean must be present and uniquely defined // * @param hierarchyBean // * HierarchyBean must be present and uniquely defined

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of ApplicationBean

Throws:

com.engiweb.toolkit.common.BackendException

findRoot

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

Returns a list of hierarchy roots

Parameters:

hierarchyBean - HierarchyBean must be present and uniquely defined

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of GroupBean

Throws:

com.engiweb.toolkit.common.BackendException

addInNoDefHierGroup

void addInNoDefHierGroup(UserBean userBean,
                         GroupBean groupBean,
                         java.lang.String token,
                         java.lang.String realm)
                  throws com.engiweb.toolkit.common.BackendException

Add an existing user (in the ORGANIZATIONAL_UNIT hierarchy) to a group of another hierarchy

Parameters:

userBean - UserBean must be present and uniquely defined

groupBean - GroupBean must be present and uniquely defined

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException

removeFromNoDefHierGroup

void removeFromNoDefHierGroup(UserBean userBean,
                              GroupBean groupBean,
                              java.lang.String token,
                              java.lang.String realm)
                       throws com.engiweb.toolkit.common.BackendException

Remove an user from a group belonging to a not default hierarchy (hierarchy id<>1)

Parameters:

userBean - UserBean must be present and uniquely defined

groupBean - GroupBean must be present and uniquely defined

token - String Authorization string

realm - String Realm name

Throws:

com.engiweb.toolkit.common.BackendException