com.engiweb.profilemanager.common.interfaces

Interface IHierarchyDirect

All Superinterfaces:

common.direct.IDirect

public interface IHierarchyDirect
extends common.direct.IDirect

The IHierarchy interface allows a client to retrieve and manage all information about hierarchy 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	buildHierarchy(HierarchyBean hierarchyBean, com.engiweb.pm.dao.db.DAO dao) Create a job for the group scope building operation
void	delete(HierarchyBean hierarchyBean, com.engiweb.pm.dao.db.DAO dao) Deletes an existing hierarchy
com.engiweb.pm.entity.BeanList<HierarchyBean>	find(HierarchyBean hierarchyBean, boolean excludeOU, com.engiweb.pm.entity.Paging paging, com.engiweb.pm.dao.db.DAO dao) Returns the hierarchy beans filtered by a passed HierarchyBean.
HierarchyBean	insert(HierarchyBean hierarchyBean, com.engiweb.pm.dao.db.DAO dao) * Adds a new hierarchy if it not exists yet.
HierarchyBean	update(HierarchyBean hierarchyBean, com.engiweb.pm.dao.db.DAO dao) Updates an existing hierarchy

Methods inherited from interface common.direct.IDirect

checkAB, deleteAB, insertAB, modifyAB, openDAO, openDAO

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

Copyright

See Also:

Constant Field Values

Method Detail

find

com.engiweb.pm.entity.BeanList<HierarchyBean> find(HierarchyBean hierarchyBean,
                                                   boolean excludeOU,
                                                   com.engiweb.pm.entity.Paging paging,
                                                   com.engiweb.pm.dao.db.DAO dao)
                                            throws com.engiweb.toolkit.common.BackendException

Returns the hierarchy beans filtered by a passed HierarchyBean.

Parameters:

hierarchyBean - HierarchyBean if null no filter is applied, otherwise the passed object is used as filter

paging - Paging

token - String Authorization string

realm - String Realm name

dao -

Returns:

BeanList of HierarchyBean

Throws:

com.engiweb.toolkit.common.BackendException

insert

HierarchyBean insert(HierarchyBean hierarchyBean,
                     com.engiweb.pm.dao.db.DAO dao)
              throws com.engiweb.toolkit.common.BackendException

* Adds a new hierarchy if it not exists yet.

Parameters:

hierarchyBean - HierarchyBean to insert (mandatory). The name is a mandatory field.

dao -

Returns:

HierarchyBean

Throws:

com.engiweb.toolkit.common.BackendException

update

HierarchyBean update(HierarchyBean hierarchyBean,
                     com.engiweb.pm.dao.db.DAO dao)
              throws com.engiweb.toolkit.common.BackendException

Updates an existing hierarchy

Parameters:

hierarchyBean - HierarchyBean to update (mandatory).It must be present and uniquely defined.

dao -

Returns:

HierarchyBean

Throws:

com.engiweb.toolkit.common.BackendException

delete

void delete(HierarchyBean hierarchyBean,
            com.engiweb.pm.dao.db.DAO dao)
     throws com.engiweb.toolkit.common.BackendException

Deletes an existing hierarchy

Parameters:

hierarchyBean - HierarchyBean to delete

dao -

Throws:

com.engiweb.toolkit.common.BackendException

buildHierarchy

void buildHierarchy(HierarchyBean hierarchyBean,
                    com.engiweb.pm.dao.db.DAO dao)
             throws com.engiweb.toolkit.common.BackendException

Create a job for the group scope building operation

Parameters:

hierarchyBean - HierarchyBean must be present and uniquely defined

dao -

Throws:

com.engiweb.toolkit.common.BackendException