com.engiweb.profilemanager.common.interfaces

Interface IResource

All Superinterfaces:

com.engiweb.toolkit.interfaces.IEjb

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

The IResource interface allows a client to retrieve and manage all information about resource 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	delete(ResourceBean resBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Deletes an existing resource.
void	deleteFamily(ResourceFamilyBean resFamBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Deletes an existing resource family and cascade all resource types and resources related.
void	deleteType(ResourceTypeBean resTypeBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Deletes an existing resource type and cascade all related resources.
com.engiweb.pm.entity.BeanList<ResourceBean>	find(ResourceBean resBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the resources filtered by a passed ResourceBean object.
com.engiweb.pm.entity.BeanList<ResourceFamilyBean>	findFamily(ResourceFamilyBean resFamBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the resource families filtered by a passed ResourceFamilyBean object.
com.engiweb.pm.entity.BeanList<OrgUnitBean>	findOrgUnit(OrgUnitBean ouBean, ResourceBean resBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the organizational units for the given ResourceBean object.
com.engiweb.pm.entity.BeanList<ResourceTypeBean>	findType(ResourceTypeBean resTypeBean, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns the resource types filtered by a passed ResourceTypeBean object.
com.engiweb.pm.entity.BeanList<UserBean>	findUser(UserBean userBean, OrgUnitBean ouBean, EntitlementBean entitlementBean, com.engiweb.pm.web.bean.AbstractBean resBean, boolean hier, boolean delegate, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns user having a fixed resource.
com.engiweb.pm.entity.BeanList<UserBean>	findUserByIntOU(UserBean userBean, OrgUnitBean ouBean, EntitlementBean entitlementBean, OrgUnitBean resBean, boolean hier, boolean delegated, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns users having a fixed organization unit in visibility.
com.engiweb.pm.entity.BeanList<UserBean>	findUserByIntOUAndProfile(UserBean userBean, OrgUnitBean ouBean, OrgUnitBean resBean, com.engiweb.pm.entity.BeanList<EntitlementBean> blEntBean, boolean hier, boolean delegated, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns user having a organizational unit internal resource assigned to a fixed list of entitlement, punctual or in visibility
com.engiweb.pm.entity.BeanList<UserBean>	findUserByProfile(UserBean userBean, OrgUnitBean ouBean, com.engiweb.pm.web.bean.AbstractBean resBean, com.engiweb.pm.entity.BeanList<EntitlementBean> blEntBean, boolean hier, boolean delegated, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm) Returns users with a fixed internal resource (OrgUnit, Entitlement, Application, ResourceFamily, ResourceType) given a list of his profiles.
ResourceBean	insert(ResourceBean resBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a new resource, if it not exists yet.
ResourceFamilyBean	insertFamily(ResourceFamilyBean resFamBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a new resource family, if it not exists yet.
ResourceTypeBean	insertType(ResourceTypeBean resTypeBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Adds a new resource type, if it not exists yet.
void	update(ResourceBean resBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Updates an existing resource.
void	updateFamily(ResourceFamilyBean resFamBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Updates an existing resource family.
void	updateType(ResourceTypeBean resTypeBean, java.lang.String cod_oper, java.lang.String token, java.lang.String realm) Updates an existing resource 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

ResourceBean insert(ResourceBean resBean,
                    java.lang.String cod_oper,
                    java.lang.String token,
                    java.lang.String realm)
             throws com.engiweb.toolkit.common.BackendException

Adds a new resource, if it not exists yet. Resource is mandatory.

Parameters:

resBean - ResourceBean to add (mandatory)

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

token - String Authorization string

realm - String Realm name

Returns:

ResourceBean added

Throws:

com.engiweb.toolkit.common.BackendException

update

void update(ResourceBean resBean,
            java.lang.String cod_oper,
            java.lang.String token,
            java.lang.String realm)
     throws com.engiweb.toolkit.common.BackendException

Updates an existing resource.

Parameters:

resBean - ResourceBean to update (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

delete

void delete(ResourceBean resBean,
            java.lang.String cod_oper,
            java.lang.String token,
            java.lang.String realm)
     throws com.engiweb.toolkit.common.BackendException

Deletes an existing resource.

Parameters:

resBean - ResourceBean to delete (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

find

com.engiweb.pm.entity.BeanList<ResourceBean> find(ResourceBean resBean,
                                                  com.engiweb.pm.entity.Paging paging,
                                                  java.lang.String token,
                                                  java.lang.String realm)
                                           throws com.engiweb.toolkit.common.BackendException

Returns the resources filtered by a passed ResourceBean object.

Parameters:

resBean - ResourceBean 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 ResourceBean

Throws:

com.engiweb.toolkit.common.BackendException

insertFamily

ResourceFamilyBean insertFamily(ResourceFamilyBean resFamBean,
                                java.lang.String cod_oper,
                                java.lang.String token,
                                java.lang.String realm)
                         throws com.engiweb.toolkit.common.BackendException

Adds a new resource family, if it not exists yet. Resource family is mandatory.

Parameters:

resFamBean - ResourceFamilyBean to add (mandatory)

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

token - String Authorization string

realm - String Realm name

Returns:

ResourceFamilyBean added

Throws:

com.engiweb.toolkit.common.BackendException

updateFamily

void updateFamily(ResourceFamilyBean resFamBean,
                  java.lang.String cod_oper,
                  java.lang.String token,
                  java.lang.String realm)
           throws com.engiweb.toolkit.common.BackendException

Updates an existing resource family.

Parameters:

resFamBean - ResourceFamilyBean to update (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

deleteFamily

void deleteFamily(ResourceFamilyBean resFamBean,
                  java.lang.String cod_oper,
                  java.lang.String token,
                  java.lang.String realm)
           throws com.engiweb.toolkit.common.BackendException

Deletes an existing resource family and cascade all resource types and resources related.

Parameters:

resFamBean - ResourceFamilyuBean to delete (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

findFamily

com.engiweb.pm.entity.BeanList<ResourceFamilyBean> findFamily(ResourceFamilyBean resFamBean,
                                                              com.engiweb.pm.entity.Paging paging,
                                                              java.lang.String token,
                                                              java.lang.String realm)
                                                       throws com.engiweb.toolkit.common.BackendException

Returns the resource families filtered by a passed ResourceFamilyBean object.

Parameters:

resFamBean - ResourceFamilyBean 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 ResourceFamilyBean

Throws:

com.engiweb.toolkit.common.BackendException

insertType

ResourceTypeBean insertType(ResourceTypeBean resTypeBean,
                            java.lang.String cod_oper,
                            java.lang.String token,
                            java.lang.String realm)
                     throws com.engiweb.toolkit.common.BackendException

Adds a new resource type, if it not exists yet. Resource type is mandatory.

Parameters:

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

token - String Authorization string

realm - String Realm name

Returns:

ResourceTypeBean added

Throws:

com.engiweb.toolkit.common.BackendException

updateType

void updateType(ResourceTypeBean resTypeBean,
                java.lang.String cod_oper,
                java.lang.String token,
                java.lang.String realm)
         throws com.engiweb.toolkit.common.BackendException

Updates an existing resource type.

Parameters:

resTypeBean - ResourceBean to update (mandatory)

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

token - String Authorization string

realm - StringRealm name

Throws:

com.engiweb.toolkit.common.BackendException

deleteType

void deleteType(ResourceTypeBean resTypeBean,
                java.lang.String cod_oper,
                java.lang.String token,
                java.lang.String realm)
         throws com.engiweb.toolkit.common.BackendException

Deletes an existing resource type and cascade all related resources.

Parameters:

resTypeBean - ResourceBean to delete (mandatory)

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

token - String Authorization string

realm - StringRealm name

Throws:

com.engiweb.toolkit.common.BackendException

findType

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

Returns the resource types filtered by a passed ResourceTypeBean object.

Parameters:

resTypeBean - ResourceTypeBean 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 ResourceFamilyBean

Throws:

com.engiweb.toolkit.common.BackendException

findOrgUnit

com.engiweb.pm.entity.BeanList<OrgUnitBean> findOrgUnit(OrgUnitBean ouBean,
                                                        ResourceBean resBean,
                                                        com.engiweb.pm.entity.Paging paging,
                                                        java.lang.String token,
                                                        java.lang.String realm)
                                                 throws com.engiweb.toolkit.common.BackendException

Returns the organizational units for the given ResourceBean object.

Parameters:

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

resBean - ResourceBean whose assigned organizational unit are to be retrieved.

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of OrgUnitBean with the given resouce

Throws:

com.engiweb.toolkit.common.BackendException

findUser

com.engiweb.pm.entity.BeanList<UserBean> findUser(UserBean userBean,
                                                  OrgUnitBean ouBean,
                                                  EntitlementBean entitlementBean,
                                                  com.engiweb.pm.web.bean.AbstractBean resBean,
                                                  boolean hier,
                                                  boolean delegate,
                                                  com.engiweb.pm.entity.Paging paging,
                                                  java.lang.String token,
                                                  java.lang.String realm)
                                           throws com.engiweb.toolkit.common.BackendException

Returns user having a fixed resource. It's possible to specify an entitlement as filter. Resource is an AbstractBean of ResourceBean type, for external resource, or ApplicationBean, EntitlementBean, OrgUnitBean for internal resources.

Parameters:

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

ouBean - OrgUnitBean if null no filter is applied, otherwise it must be well defined

entitlementBean - EntitlementBean if null no filter is applied, otherwise it must be well defined

resBean - resource of OrgUnitBean type. Mandatory

resBean - resource of ApplicationBean or EntitlementBean or OrgUnitBean type. Mandatory

hier - true if the research must be done in hierarchical mode. It is used only if ouBean arguments are set

delegated - true if the research must include also user having the organization unit resource delegated

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

findUserByIntOU

com.engiweb.pm.entity.BeanList<UserBean> findUserByIntOU(UserBean userBean,
                                                         OrgUnitBean ouBean,
                                                         EntitlementBean entitlementBean,
                                                         OrgUnitBean resBean,
                                                         boolean hier,
                                                         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 organization unit in visibility. It's possible to specify an entitlement as filter.

Parameters:

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

ouBean - OrgUnitBean if null no filter is applied, otherwise it must be well defined

entitlementBean - EntitlementBean if null no filter is applied, otherwise it must be well defined

resBean - resource of OrgUnitBean type. Mandatory

hier - true if the research must be done in hierarchical mode. It is used only if ouBean arguments are set

delegated - true if the research must include also user having the organization unit resource delegated

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

findUserByProfile

com.engiweb.pm.entity.BeanList<UserBean> findUserByProfile(UserBean userBean,
                                                           OrgUnitBean ouBean,
                                                           com.engiweb.pm.web.bean.AbstractBean resBean,
                                                           com.engiweb.pm.entity.BeanList<EntitlementBean> blEntBean,
                                                           boolean hier,
                                                           boolean delegated,
                                                           com.engiweb.pm.entity.Paging paging,
                                                           java.lang.String token,
                                                           java.lang.String realm)
                                                    throws com.engiweb.toolkit.common.BackendException

Returns users with a fixed internal resource (OrgUnit, Entitlement, Application, ResourceFamily, ResourceType) given a list of his profiles. The list of profiles if considered in OR condition

Parameters:

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

ouBean - OrgUnitBean starting point in the the organization unit tree from which search users. If null no filter is applied, otherwise it must be well defined

resBean - AbstractBean that sets the internal resource type to search. It must be well defined (Mandatory)

blEntBean - BeanList of profiles owned by user.The list is considered in OR condition

hier - true if the research must be done in hierarchical mode. It is used only if ouBean arguments are set

delegated - true if the research must include also user having the organization unit resource delegated

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException

findUserByIntOUAndProfile

com.engiweb.pm.entity.BeanList<UserBean> findUserByIntOUAndProfile(UserBean userBean,
                                                                   OrgUnitBean ouBean,
                                                                   OrgUnitBean resBean,
                                                                   com.engiweb.pm.entity.BeanList<EntitlementBean> blEntBean,
                                                                   boolean hier,
                                                                   boolean delegated,
                                                                   com.engiweb.pm.entity.Paging paging,
                                                                   java.lang.String token,
                                                                   java.lang.String realm)
                                                            throws com.engiweb.toolkit.common.BackendException

Returns user having a organizational unit internal resource assigned to a fixed list of entitlement, punctual or in visibility

Parameters:

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

ouBean - OrgUnitBean starting point in the the organization unit tree from which search users. If null no filter is applied, otherwise it must be well defined

resBean - resource of OrgUnitBean type. Mandatory

blEntBean - BeanList of profiles owned by user.The list is considered in OR condition

hier - true if the research must be done in hierarchical mode. It is used only if ouBean arguments are set

delegated - true if the research must include also user having the organization unit resource delegated

paging - Paging

token - String Authorization string

realm - String Realm name

Returns:

BeanList of UserBean

Throws:

com.engiweb.toolkit.common.BackendException