com.engiweb.profilemanager.common.interfaces

Interface IHierarchy

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

    public interface IHierarchy
extends com.engiweb.toolkit.interfaces.IEjb
    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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void buildHierarchy(HierarchyBean hierarchyBean, java.lang.String token, java.lang.String realm)
      Create a job for the group scope building operation
      void delete(HierarchyBean hierarchyBean, java.lang.String token, java.lang.String realm)
      Deletes an existing hierarchy
      com.engiweb.pm.entity.BeanList<HierarchyBean> find(HierarchyBean hierarchyBean, boolean excludeOU, com.engiweb.pm.entity.Paging paging, java.lang.String token, java.lang.String realm)
      Returns the hierarchy beans filtered by a passed HierarchyBean.
      HierarchyBean insert(HierarchyBean hierarchyBean, java.lang.String token, java.lang.String realm)
      Adds a new hierarchy if it not exists yet.
      HierarchyBean update(HierarchyBean hierarchyBean, java.lang.String token, java.lang.String realm)
      Updates an existing hierarchy

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

        checkAB

    • Method Detail

      • find

        com.engiweb.pm.entity.BeanList<HierarchyBean> find(HierarchyBean hierarchyBean,
                                                   boolean excludeOU,
                                                   com.engiweb.pm.entity.Paging paging,
                                                   java.lang.String token,
                                                   java.lang.String realm)
                                            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
        Returns:
        BeanList of HierarchyBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • insert

        HierarchyBean insert(HierarchyBean hierarchyBean,
                     java.lang.String token,
                     java.lang.String realm)
              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.
        token - String Authorization string
        realm - String Realm name
        Returns:
        HierarchyBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • update

        HierarchyBean update(HierarchyBean hierarchyBean,
                     java.lang.String token,
                     java.lang.String realm)
              throws com.engiweb.toolkit.common.BackendException
        Updates an existing hierarchy
        Parameters:
        hierarchyBean - HierarchyBean to update (mandatory).It must be present and uniquely defined.
        token - String Authorization string
        realm - String Realm name
        Returns:
        HierarchyBean
        Throws:
        com.engiweb.toolkit.common.BackendException

      • delete

        void delete(HierarchyBean hierarchyBean,
            java.lang.String token,
            java.lang.String realm)
     throws com.engiweb.toolkit.common.BackendException
        Deletes an existing hierarchy
        Parameters:
        hierarchyBean - HierarchyBean to delete
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException

      • buildHierarchy

        void buildHierarchy(HierarchyBean hierarchyBean,
                    java.lang.String token,
                    java.lang.String realm)
             throws com.engiweb.toolkit.common.BackendException
        Create a job for the group scope building operation
        Parameters:
        hierarchyBean - HierarchyBean must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
Skip navigation links