com.engiweb.profilemanager.common.interfaces

Interface IOrgUnit

All Superinterfaces:

com.engiweb.toolkit.interfaces.IEjb

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

The IOrgUnit interface allows a client to retrieve and manage all information about organization unit 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	addProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean, OrgUnitBean orgUnitBean, java.lang.String token, java.lang.String realmAdm) Adds a list of properties to an organization unit
void	addResources(com.engiweb.pm.entity.BeanList<ResourceBean> blResources, OrgUnitBean orgUnitBean, boolean hier, boolean employee, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a list of ResourceBean to an organization unit
void	addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlement, OrgUnitBean orgUnitBean, boolean hier, boolean alignUserToDef, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a list of entitlements to an organization unit
void	addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl, OrgUnitBean ouBean, boolean hier, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Add a list of EntitlementBean to an OrgUnitBean
void	delete(OrgUnitBean orgUnitBean, boolean hier, java.lang.String token, java.lang.String realm) Deletes an existing organization unit.
void	deleteType(OUTypeBean ouTypeBean, java.lang.String token, java.lang.String realm) Removes an existing organization unit type.
com.engiweb.pm.entity.BeanList<OrgUnitBean>	find(OrgUnitBean orgUnitBean, OrgUnitBean ouStart, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the organization units filtered by a passed OrgUnitBean object starting from a start OU.
com.engiweb.pm.entity.BeanList<ApplicationBean>	findApplication(ApplicationBean appBean, OrgUnitBean orgUnitBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of applications associated to entitlements belonging to an organization unit
com.engiweb.pm.entity.BeanList<ApplicationBean>	findApplicationByEntitlement(ApplicationBean appBean, EntitlementBean entBean, OrgUnitBean orgUnitBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of applications belonging to an organization unit (punctually or hierarchically) filtered by an entitlement
com.engiweb.pm.entity.BeanList<EntitlementBean>	findEntitlement(EntitlementBean entBean, ApplicationBean appBean, OrgUnitBean orgUnitBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of entitlements belonging to an organization unit (punctually or hierarchically) filtered by an application
com.engiweb.pm.entity.BeanList<OrgUnitBean>	findInHier(OrgUnitBean orgUnitBean, boolean findAdmin, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the children nodes of the passed OU
com.engiweb.pm.entity.BeanList<OrgUnitBean>	findInHier(OrgUnitBean orgUnitBean, boolean findAdmin, java.lang.String token, java.lang.String realm) Deprecated. As of release 5.1, replaced by findInHier(OrgUnitBean, boolean, Paging, String, String)
com.engiweb.pm.entity.BeanList<OrgUnitBean>	findInHier(OrgUnitBean orgUnitBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the children nodes of the passed OU
com.engiweb.pm.entity.BeanList<OrgUnitBean>	findInHier(OrgUnitBean orgUnitBean, java.lang.String token, java.lang.String realm) Deprecated. As of release 5.1, replaced by findInHier(OrgUnitBean, Paging, String, String)
com.engiweb.pm.entity.BeanList<OrgUnitBean>	findParent(OrgUnitBean ouBean, boolean showAdmin, java.lang.String token, java.lang.String realm) Returns the parent tree of the passed OU.
com.engiweb.pm.entity.BeanList<PropertyBean>	findProperty(PropertyBean propertyBean, OrgUnitBean orgUnitBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realmAdm) Returns a list of properties assigned to an organization unit
com.engiweb.pm.entity.BeanList<ResourceBean>	findResource(ResourceBean resourcBean, OrgUnitBean orgUnitBean, 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 an organization unit
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 organization unit types filtered by a passed OUTypeBean object
com.engiweb.pm.entity.BeanList<UserBean>	findUser(UserBean userBean, EntitlementBean entitlementBean, OrgUnitBean orgUnitBean, 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 an organization unit or one of its sons (if hier is true)
com.engiweb.pm.entity.BeanList<UserBean>	findUser(UserBean userBean, OrgUnitBean orgUnitBean, boolean hier, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns a list of users belonging to an organization unit or one of its sons (if hier is true)
OrgUnitBean	insert(OrgUnitBean orgUnitBean, OrgUnitBean ouParentBean, boolean parentEntitlements, boolean parentResources, java.lang.String token, java.lang.String realm) Adds a new organization unit, if it not exists yet, to the organization unit tree.
OUTypeBean	insertType(OUTypeBean ouTypeBean, java.lang.String token, java.lang.String realm) Adds a new orgnization unit type if it not exists yet.
void	modifyRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl, OrgUnitBean ouBean, 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 an orgaanization unit
void	modifySOD(OrgUnitBean orgUnitBean, boolean enableSOD, boolean hier, java.lang.String token, java.lang.String realm) Modify SOD on the organization unit punctually or hierarchically
void	removeProperties(com.engiweb.pm.entity.BeanList<PropertyBean> blPropertyBean, OrgUnitBean orgUnitBean, 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, OrgUnitBean orgUnitBean, boolean hier, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Removes a list of ResourceBean from an organization unit
void	removeRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl, OrgUnitBean orgUnitBean, boolean hier, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Removes a list of entitlements from an organization unit
OrgUnitBean	update(OrgUnitBean orgUnitBean, OrgUnitBean ouParentBean, java.lang.String token, java.lang.String realm) Updates an existing organization unit
void	updateType(OUTypeBean ouTypeBean, java.lang.String token, java.lang.String realm) Updates an existing organization unit 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

OrgUnitBean insert(OrgUnitBean orgUnitBean,
                   OrgUnitBean ouParentBean,
                   boolean parentEntitlements,
                   boolean parentResources,
                   java.lang.String token,
                   java.lang.String realm)
            throws com.engiweb.toolkit.common.BackendException

Adds a new organization unit, if it not exists yet, to the organization unit tree. Organization unit parent is mandatory.

Parameters:

orgUnitBean - OrgUnitBean to add (mandatory)

ouParentBean - OrgUnitBean parent of the new organization unit.It must be present and uniquely defined.

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

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

token - String Authorization string

realm - String Realm name

Returns:

OrgUnitBean added

Throws:

com.engiweb.toolkit.common.BackendException

update

OrgUnitBean update(OrgUnitBean orgUnitBean,
                   OrgUnitBean ouParentBean,
                   java.lang.String token,
                   java.lang.String realm)
            throws com.engiweb.toolkit.common.BackendException

Updates an existing organization unit

Parameters:

orgUnitBean - OrgUnitBean to update (mandatory)

ouParentBean - OrgUnitBean parent of the updated organization unit.It must be present and uniquely defined.

token - String Authorization string

realm - String Realm name

Returns:

OrgUnitBean updated.

Throws:

com.engiweb.toolkit.common.BackendException

delete

void delete(OrgUnitBean orgUnitBean,
            boolean hier,
            java.lang.String token,
            java.lang.String realm)
     throws com.engiweb.toolkit.common.BackendException

Deletes an existing organization unit.

Parameters:

orgUnitBean - OrgUnitBean to delete (mandatory). If OU is not a leaf, then all nested OUs will be assigned to its associated parent OU

boolean - hier: if true organization unit 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<OrgUnitBean> find(OrgUnitBean orgUnitBean,
                                                 OrgUnitBean ouStart,
                                                 com.engiweb.pm.entity.Paging paging,
                                                 java.lang.String token,
                                                 java.lang.String realm)
                                          throws com.engiweb.toolkit.common.BackendException

Returns the organization units filtered by a passed OrgUnitBean object starting from a start OU. Is startOU is null or not uniquely defined, the start OU is defined according to user visibility

Parameters:

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

ouStart - OrgUnitBean OU from which research must be performed. If null or id or code is not set start OU is defined according to user visibility

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of OrgUnitBean

Throws:

com.engiweb.toolkit.common.BackendException

addResources

void addResources(com.engiweb.pm.entity.BeanList<ResourceBean> blResources,
                  OrgUnitBean orgUnitBean,
                  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 an organization unit

Parameters:

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

orgUnitBean - OrgUnitBean to which add resources. It must be present and uniquely defined.

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

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

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,
                     OrgUnitBean orgUnitBean,
                     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 an organization unit

Parameters:

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

orgUnitBean - OrgUnitBean from which remove resources. It must be present and uniquely defined.

hier - if true resources will be will be removed from organization unit 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,
                                                          OrgUnitBean orgUnitBean,
                                                          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 an organization unit

Parameters:

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

orgUnitBean - OrgUnitBean 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<OrgUnitBean> findParent(OrgUnitBean ouBean,
                                                       boolean showAdmin,
                                                       java.lang.String token,
                                                       java.lang.String realm)
                                                throws com.engiweb.toolkit.common.BackendException

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

Parameters:

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

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

token - String Authorization string

realm - String Realm name

Returns:

BeanList of OrgUnitBean

Throws:

com.engiweb.toolkit.common.BackendException

findInHier

com.engiweb.pm.entity.BeanList<OrgUnitBean> findInHier(OrgUnitBean orgUnitBean,
                                                       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 OU

Parameters:

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

token - String Authorization string

realm - String Realm name

Returns:

BeanList of OrgUnitBean

Throws:

com.engiweb.toolkit.common.BackendException

findInHier

@Deprecated
com.engiweb.pm.entity.BeanList<OrgUnitBean> findInHier(OrgUnitBean orgUnitBean,
                                                                   java.lang.String token,
                                                                   java.lang.String realm)
                                                            throws com.engiweb.toolkit.common.BackendException

Deprecated. As of release 5.1, replaced by findInHier(OrgUnitBean, Paging, String, String)

Throws:

com.engiweb.toolkit.common.BackendException

findInHier

com.engiweb.pm.entity.BeanList<OrgUnitBean> findInHier(OrgUnitBean orgUnitBean,
                                                       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 OU

Parameters:

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

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 OrgUnitBean

Throws:

com.engiweb.toolkit.common.BackendException

findInHier

@Deprecated
com.engiweb.pm.entity.BeanList<OrgUnitBean> findInHier(OrgUnitBean orgUnitBean,
                                                                   boolean findAdmin,
                                                                   java.lang.String token,
                                                                   java.lang.String realm)
                                                            throws com.engiweb.toolkit.common.BackendException

Deprecated. As of release 5.1, replaced by findInHier(OrgUnitBean, boolean, Paging, String, String)

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 orgnization unit type if it not exists yet.

Parameters:

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

token - String Authorization string

realm - String Realm name

Returns:

OrgUnitBean 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 unit 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 organization unit type. When an OU type is removed, ou type of organization units 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 organization unit 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 OUTypeBean

Throws:

com.engiweb.toolkit.common.BackendException

findUser

com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  EntitlementBean entitlementBean,
                                                  OrgUnitBean orgUnitBean,
                                                  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 an organization unit 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

orgUnitBean - OrgUnitBean must be present and uniquely defined

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,
                                                  OrgUnitBean orgUnitBean,
                                                  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 an organization unit 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

orgUnitBean - OrgUnitBean must be present and uniquely defined

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

addRoles

void addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlement,
              OrgUnitBean orgUnitBean,
              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 an organization unit

Parameters:

alignUserToDef -

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

orgUnitBean - OrgUnitBean must be present and uniquely defined

boolean - hier: 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

void addRoles(com.engiweb.pm.entity.BeanList<EntitlementBean> entBl,
              OrgUnitBean ouBean,
              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 OrgUnitBean

Parameters:

entBl - BeanList of well defined EntitlementBean to add

ouBean - OrgUnitBean to which enitlements must be add

hier - 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,
                 OrgUnitBean ouBean,
                 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 an orgaanization unit

Parameters:

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

orgUnitBean - OrgUnitBean must be present and uniquely defined

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,
                 OrgUnitBean orgUnitBean,
                 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 an organization unit

Parameters:

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

orgUnitBean - OrgUnitBean 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,
                                                                OrgUnitBean orgUnitBean,
                                                                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 an organization unit

Parameters:

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

orgUnitBean - OrgUnitBean 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(OrgUnitBean orgUnitBean,
               boolean enableSOD,
               boolean hier,
               java.lang.String token,
               java.lang.String realm)
        throws com.engiweb.toolkit.common.BackendException

Modify SOD on the organization unit punctually or hierarchically

Parameters:

orgUnitBean - OrgUnitBean if null the organization unit in the user scope is used

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,
                      OrgUnitBean orgUnitBean,
                      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.

orgUnitBean - OrgUnitBean 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,
                                                          OrgUnitBean orgUnitBean,
                                                          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 an organization unit

Parameters:

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

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

Adds a list of properties to an organization unit

Parameters:

blPropertyBean - BeanList of PropertyBean to add to organization unit

orgUnitBean - OrgUnitBean 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,
                                                                OrgUnitBean orgUnitBean,
                                                                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 an organization unit (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

orgUnitBean - OrgUnitBean must be present and uniquely defined

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,
                                                                             OrgUnitBean orgUnitBean,
                                                                             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 an organization unit (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

orgUnitBean - OrgUnitBean 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