Package com.groiss.org

Interface RemoteOrgData

All Superinterfaces:
Remote
All Known Subinterfaces:
OrgData
@Deprecated(since="11.0", forRemoval=true) public interface RemoteOrgData extends Remote
Deprecated, for removal: This API element is subject to removal in a future version.
This interface allows access to the organizational data stored in @enterprise.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addRoleToSession(Role r, OrgUnit ou)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds a role to the current usersession.
    void
    addRule(PermissionMapping pm)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use addRule(Class) instead
    void
    addRule(Class<? extends PermissionMapping> pm)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Add a permission mapping to the permission system.
    void
    changeDeferred(Persistent p, Date d)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Change the Object later
    void
    checkLoginAllowed(User u)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check if the user is active, not too many unsuccessful logins and system not in admin mode.
    List<String>
    checkPasswordPolicy(String password)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check a password against the password policy.
    void
    checkRight(Right r, Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether the thread user has the right r on object o.
    void
    clearCachedUserProperties(User u)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Clears the cache for the user properties of the passed user.
    OrgClass
    createOrgClass()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new OrgClass object.
    OrgTree
    createOrgTree()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return a new organizational tree.
    OrgUnit
    createOrgUnit()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new OrgUnit object.
    Permission
    createPermission()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new Permission
    PermissionList
    createPermissionList()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new PermissionList
    Right
    createRight()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new Right.
    Role
    createRole()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new Role object.
    User
    createUser()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new User object.
    UserRole
    createUserRole()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new user-role relation
    void
    delete(Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Delete the object including right check.
    void
    deleteCascade(OrgUnit ou)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Delete the passed organizational unit and also objects which are of no use without it.
    void
    deleteObjectExtension(Persistent obj, String formclass)
    Deprecated, for removal: This API element is subject to removal in a future version.
    delete the object extension for the given object.
    <P> P
    get(Class<? extends P> c, long oid)
    Deprecated.
    Use Store.get(Class, long)
    <P> P
    get(String classname, long oid)
    Deprecated.
    Use Store.get(String, long)
    Application
    getApplication(long oid)
    Deprecated.
    Use Store.get(Class, long) with Application.class as first parameter instead.
    <P> P
    getById(Class<? extends P> c, String id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get an object from the org-data database.
    <P> P
    getById(String classname, String id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get an object from the org-data database.
    List<OrgUnit>
    getDeptsInScope(OrgUnit ou, int orgScope, OrgTree tree)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the list of of organizational units which are in the given scope relatively from the given organizational unit.
    OrgUnit
    getHomeOrg(User u)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the Org.unit where the user has the home role.
    <P extends Persistent>
    Pair<LogEntry,P>
    getLogAndVersion(P o, long vid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the version of the object at a given version id along with the corresponding LogEntry.
    <P extends Persistent>
    Pair<LogEntry,P>
    getLogAndVersion(P o, Date d)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the version of the object at a given date along with the corresponding LogEntry.
    List<LogEntry>
    getLogEntries(String classname, long oid, Date from, Date to)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of log entries for the specified object (identified by passed oid and classname) which were made at time T, where from < T < to.
    Persistent
    getObjectExtension(Persistent obj, String formclass, boolean create)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the extension object to a persistent.
    OrgUnit
    getOrgUnit(long oid)
    Deprecated.
    Use Store.get(Class, long) with OrgUnit.class as first parameter instead.
    String
    getPolicyInfoText(User u)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if there are any hints for the user according to the password policy.
    Right
    getRight(long oid)
    Deprecated.
    Use Store.get(Class, long) with Right.class as first parameter instead.
    Role
    getRole(long oid)
    Deprecated.
    Use Store.get(Class, long) with Role.class as first parameter instead.
    Map<Role,Set<OrgUnit>>
    getRoles(User u)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a Map of the roles - and org.units - of a user.
    Map<Role,Set<OrgUnit>>
    getRoles(User u, Application appl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a Map of the roles - and org.units - of a user.
    List<Role>
    getRoles(User u, OrgUnit d)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the roles a user has in a OrgUnit.
    List<Pair<Role,OrgUnit>>
    getSessionRoles()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns all the combinations of role and organizational units that have been assigned to the current usersession.
    List<OrgUnit>
    getSubOrgs(OrgUnit ou, OrgTree tree)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the list of the organizational units that are below the given oe in the given tree.
    OrgUnit
    getSuperOrg(OrgUnit ou, OrgTree tree)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the organizational unit that is above the given oe in the given tree.
    User
    getUser(long oid)
    Deprecated.
    Use Store.get(Class, long) with User.class as first parameter instead.
    Map<String,String>
    getUserProperties(User u)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the full list of properties for a user.
    String
    getUserProperty(User u, String key)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use this method to get a user property.
    <P extends Persistent>
    P
    getVersion(P o, Date d)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the version of the object at a given date.
    boolean
    hasRight(User u, Right r, Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks whether the given user has the given right on the given object.
    boolean
    hasRight(User u, Right r, Persistent o, Application app)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    hasRight(User u, Right r, Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks whether the given user has the given right on the given object.
    <P> List<P>
    hasRightForList(User u, Right r, List<? extends P> l, boolean ignoreOrgs, boolean ignoreSubsts, Application app)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list containing all the elements of passed list l for which the user has the specified right.
    <P> List<P>
    hasRightForList(User u, Right r, List<? extends P> l, Application app)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list containing all the elements of passed list l for which the user has the specified right.
    boolean
    hasRole(User u, Role r, OrgUnit d, Application appl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Has the user u the role r in the org.unit d?
    boolean
    hasRoleInSession(Role r, OrgUnit ou)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if the given combination of role and organizational unit has been added to the current usersession.
    void
    insert(Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Insert the object including right check.
    boolean
    isInTree(OrgUnit ou, OrgTree tree)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Is the given org-unit in the specified org-tree.
    <P> List<P>
    list(Class<? extends P> c, String cond, String order)
    Deprecated.
    Use Store.list(Class, String, String)
    <P> List<P>
    list(Class<? extends P> c, String cond, String order, Object... bindVars)
    Deprecated.
    Use Store.list(Class, String, String, Object...)
    <P extends Persistent>
    List<P>
    list(String classname, String cond, String order, Object... bindVars)
    Deprecated.
    Use Store.list(String, String, String, Object...)
    Map<User,List<OrgUnit>>
    listUsersWithRole(Role r, OrgUnit ou, Application appl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    List the users that have a role
    <P> List<P>
    listWithRightCheck(User u, Class<? extends P> clazz, Right right, Application app, boolean ignoreDepts, String condition, String order, Object... args)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of all objects of the specified object class for which the specified user has the specified right and for which the condition matches.
    <P> List<P>
    listWithRightCheck(User u, Class<? extends P> clazz, String condition, String order, Object[] args, Right right, Application app, boolean ignoreDepts)
    Deprecated.
    Use listWithRightCheck(User,Class,Right,Application,boolean,String,String,Object...) instead
    <P extends Persistent>
    List<P>
    listWithRightCheck(User u, String classname, Right right, Application app, boolean ignoreDepts, String condition, String order, Object... bindVars)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of all objects of the specified object class for which the specified user has the specified right and for which the condition matches.
    <P extends Persistent>
    List<P>
    listWithRightCheck(User u, String classname, String condition, String order, Object[] bindVars, Right right, Application app, boolean ignoreDepts)
    Deprecated.
    Use listWithRightCheck(User,String,Right,Application,boolean,String,String,Object...) instead
    LogEntry
    makeLogEntry(Persistent o, int mode, long versionid, String desc)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create an entry in the log table.
    boolean
    mayDelete(User u, Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether the user may delete the object.
    boolean
    mayExecute(User u, Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether the user may execute the object (function).
    boolean
    mayInsert(User u, Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether the user may create the object (insert it into the database).
    boolean
    mayUpdate(User u, Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether the user may edit the object.
    boolean
    mayView(User u, Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether the user may view the object.
    void
    placeOrgInTree(OrgUnit parent, OrgUnit child, OrgTree tree)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Change the organizational hierarchy.
    void
    removeAllRolesFromSession()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes all roles from the current usersession.
    void
    removeRoleFromSession(Role r, OrgUnit ou)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes a role from the current usersession.
    User
    setPassword(User u, String password)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the password of a user.
    void
    setPermissionList(HasPermissionList o, PermissionList pl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the Permissionlist pl for an object o
    void
    setUserProperty(User u, String key, String value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set a user property.
    void
    update(Persistent o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Update the object including right check.

  • Method Details

    • addRule

      void addRule(Class<? extends PermissionMapping> pm) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add a permission mapping to the permission system.
      Parameters:
      pm - the permission mapping class
      Throws:
      RemoteException

    • addRule

      @Deprecated(since="11.0", forRemoval=true) void addRule(PermissionMapping pm) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addRule(Class) instead
      Add a permission mapping to the permission system.
      Parameters:
      pm - the permission mapping
      Throws:
      RemoteException

    • get

      @Deprecated <P> P get(Class<? extends P> c, long oid) throws RemoteException
      Deprecated.
      Use Store.get(Class, long)
      Get an object from the org-data database. The class is one of User, Right, Role, OrgUnit, Application, OrgTree. All of them from this package.
      Parameters:
      c - the class
      oid - the unique oid of the object
      Returns:
      the object, you can cast the result to the class you specified in the first argument
      Throws:
      RemoteException

    • get

      @Deprecated <P> P get(String classname, long oid) throws RemoteException
      Deprecated.
      Use Store.get(String, long)
      Get an object from the org-data database. The classname is one of User, Right, Role, OrgUnit, Application, OrgTree. All of them from this package.
      Parameters:
      classname - the classname
      oid - the unique oid of the object
      Returns:
      the object, you can cast the result to the class you specified in the first argument
      Throws:
      RemoteException

    • getUser

      @Deprecated User getUser(long oid) throws RemoteException
      Deprecated.
      Use Store.get(Class, long) with User.class as first parameter instead.
      Get an user from the org-data database.
      Parameters:
      oid - the unique oid of the object
      Returns:
      the requested user
      Throws:
      RemoteException

    • getUserProperty

      String getUserProperty(User u, String key) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use this method to get a user property. The method accesses system defined as well as application defined properties.
      Parameters:
      u - The user of which you want to get a property.
      key - The property key.
      Returns:
      Returns the property value as String or null if no such property exists.
      Throws:
      RemoteException

    • getUserProperties

      Map<String,String> getUserProperties(User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the full list of properties for a user.
      Parameters:
      u - The user of which you want to get the list.
      Returns:
      a Properties object
      Throws:
      RemoteException

    • checkLoginAllowed

      void checkLoginAllowed(User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check if the user is active, not too many unsuccessful logins and system not in admin mode.
      Throws:
      RemoteException

    • setUserProperty

      void setUserProperty(User u, String key, String value) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set a user property. The method accesses system defined as well as application defined properties.
      Parameters:
      u - The user of which you want to get a property.
      key - The property key.
      value - The property value. With value null the property will be removed.
      Throws:
      RemoteException

    • getRole

      @Deprecated Role getRole(long oid) throws RemoteException
      Deprecated.
      Use Store.get(Class, long) with Role.class as first parameter instead.
      Get an Role from the org-data database.
      Parameters:
      oid - the unique oid of the object
      Returns:
      the requested Role
      Throws:
      RemoteException

    • getRight

      @Deprecated Right getRight(long oid) throws RemoteException
      Deprecated.
      Use Store.get(Class, long) with Right.class as first parameter instead.
      Get an Right from the org-data database.
      Parameters:
      oid - the unique oid of the object
      Returns:
      the requested Right
      Throws:
      RemoteException

    • getOrgUnit

      @Deprecated OrgUnit getOrgUnit(long oid) throws RemoteException
      Deprecated.
      Use Store.get(Class, long) with OrgUnit.class as first parameter instead.
      Get an OrgUnit from the org-data database.
      Parameters:
      oid - the unique oid of the object
      Returns:
      the requested OrgUnit
      Throws:
      RemoteException

    • getApplication

      @Deprecated Application getApplication(long oid) throws RemoteException
      Deprecated.
      Use Store.get(Class, long) with Application.class as first parameter instead.
      Get an application from the org-data database.
      Parameters:
      oid - the unique oid of the object
      Returns:
      the requested application
      Throws:
      RemoteException

    • getById

      <P> P getById(Class<? extends P> c, String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get an object from the org-data database. The class is one of User, Right, Role, OrgUnit, Application, OrgTree. All of them from this package.
      Parameters:
      c - the class
      id - the id of the object
      Returns:
      the object, you can cast the result to the class you specified in the first argument
      Throws:
      RemoteException

    • getById

      <P> P getById(String classname, String id) throws ClassNotFoundException, RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get an object from the org-data database. The classname is one of User, Right, Role, OrgUnit, Application, OrgTree. All of them from this package.
      Parameters:
      classname - the classname
      id - the id of the object
      Returns:
      the object, you can cast the result to the class you specified in the first argument
      Throws:
      ClassNotFoundException
      RemoteException

    • getHomeOrg

      OrgUnit getHomeOrg(User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the Org.unit where the user has the home role.
      Parameters:
      u - the User
      Returns:
      the OrgUnit
      Throws:
      RemoteException

    • list

      @Deprecated <P> List<P> list(Class<? extends P> c, String cond, String order) throws RemoteException
      Deprecated.
      Use Store.list(Class, String, String)
      Get a list of objects from the org-data database. The class is one of User, Right, Role, OrgUnit, Application, OrgTree. All of them from this package.
      Parameters:
      c - the class
      cond - the condition expression
      order - the order attribute(s), comma-separated if more than one
      Returns:
      a list of objects of the given class
      Throws:
      RemoteException

    • list

      @Deprecated <P> List<P> list(Class<? extends P> c, String cond, String order, Object... bindVars) throws RemoteException
      Deprecated.
      Use Store.list(Class, String, String, Object...)
      Get a list of objects from the org-data database. The class is one of User, Right, Role, OrgUnit, Application, OrgTree. All of them from this package.
      Parameters:
      c - the class
      cond - the condition expression
      order - the order attribute(s), comma-separated if more than one
      bindVars - if the condition contains place holders for binding variables this array should contain the values
      Returns:
      a list of objects of the given class
      Throws:
      RemoteException

    • list

      @Deprecated <P extends Persistent> List<P> list(String classname, String cond, String order, Object... bindVars) throws RemoteException
      Deprecated.
      Use Store.list(String, String, String, Object...)
      Get a list of objects from the org-data database. The classname is one of fully qualified name of User, Right, Role, OrgUnit, Application, OrgTree. All of them from this package.
      Parameters:
      classname - the fully qualified name of the class of the object
      cond - the condition expression
      order - the order attribute(s), comma-separated if more than one
      bindVars - if the condition contains place holders for binding variables this array should contain the values
      Returns:
      a list of objects of the given class
      Throws:
      RemoteException

    • getRoles

      Map<Role,Set<OrgUnit>> getRoles(User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a Map of the roles - and org.units - of a user. The org-tree of the default application is used for determining the result for hierarchical roles.
      Parameters:
      u - the user
      Returns:
      a Map where the keys are the roles, the values are sets of org-units. If the role is global, this Set is empty.
      Throws:
      RemoteException

    • getRoles

      Map<Role,Set<OrgUnit>> getRoles(User u, Application appl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a Map of the roles - and org.units - of a user.
      Parameters:
      u - the user
      appl - an application object, the org-tree of this application is used for determining the result for hierarchical roles.
      Returns:
      a Map where the keys are the roles, the values are sets of org-units If the role is global, this Set is empty.
      Throws:
      RemoteException

    • getRoles

      List<Role> getRoles(User u, OrgUnit d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the roles a user has in a OrgUnit.
      Parameters:
      u - the user
      d - the OrgUnit
      Returns:
      a list of roles
      Throws:
      RemoteException

    • hasRole

      boolean hasRole(User u, Role r, OrgUnit d, Application appl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Has the user u the role r in the org.unit d?
      Parameters:
      u - the user
      r - the role
      d - the OrgUnit
      Returns:
      true, if the user has the role.
      Throws:
      RemoteException

    • hasRight

      boolean hasRight(User u, Right r, Object o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks whether the given user has the given right on the given object. See the description of the @enterprise permission system for details.
      Parameters:
      u - the user
      r - the right
      o - the object may be null, must be a Persistent
      Returns:
      true if the user has the right
      Throws:
      RemoteException

    • hasRight

      boolean hasRight(User u, Right r, Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks whether the given user has the given right on the given object. See the description of the @enterprise permission system for details.
      Parameters:
      u - the user
      r - the right
      o - the object (may be null)
      Returns:
      true if the user has the right
      Throws:
      RemoteException

    • hasRight

      boolean hasRight(User u, Right r, Persistent o, Application app) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      RemoteException

    • hasRightForList

      <P> List<P> hasRightForList(User u, Right r, List<? extends P> l, Application app) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list containing all the elements of passed list l for which the user has the specified right.
      Parameters:
      u - the user
      r - the right
      l - the list containing the unchecked elements
      app - the application for referencing an org-tree
      Returns:
      a list containing the permitted elements
      Throws:
      RemoteException

    • hasRightForList

      <P> List<P> hasRightForList(User u, Right r, List<? extends P> l, boolean ignoreOrgs, boolean ignoreSubsts, Application app) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list containing all the elements of passed list l for which the user has the specified right.
      Parameters:
      u - the user
      r - the right
      l - the list containing the unchecked elements
      ignoreOrgs - ignore permissions defined for org-unit scopes
      ignoreSubsts - ignore permissions defined for persons u substitutes
      app - the application for referencing an org-tree
      Returns:
      a list containing the permitted elements
      Throws:
      RemoteException

    • listWithRightCheck

      @Deprecated <P> List<P> listWithRightCheck(User u, Class<? extends P> clazz, String condition, String order, Object[] args, Right right, Application app, boolean ignoreDepts) throws RemoteException
      Deprecated.
      Use listWithRightCheck(User,Class,Right,Application,boolean,String,String,Object...) instead
      Returns a list of all objects of the specified object class for which the specified user has the specified right and for which the condition matches.
      Parameters:
      u - the user
      clazz - class which instances are wanted
      condition - a SQL condition
      order - a comma separated list of attribute names of the given class.
      args - if the condition contains place holders for binding variables this array should contain the values
      right - the right
      app - the application which department tree should be used for checking
      ignoreDepts - ignore the right a user has via dept scope
      Returns:
      the list
      Throws:
      RemoteException

    • listWithRightCheck

      <P> List<P> listWithRightCheck(User u, Class<? extends P> clazz, Right right, Application app, boolean ignoreDepts, String condition, String order, Object... args) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of all objects of the specified object class for which the specified user has the specified right and for which the condition matches.
      Parameters:
      u - the user
      clazz - class which instances are wanted
      right - the right
      app - the application which department tree should be used for checking
      ignoreDepts - ignore the right a user has via dept scope
      condition - a SQL condition
      order - a comma separated list of attribute names of the given class.
      args - values for binding variables in condition
      Returns:
      the list
      Throws:
      RemoteException

    • listWithRightCheck

      @Deprecated <P extends Persistent> List<P> listWithRightCheck(User u, String classname, String condition, String order, Object[] bindVars, Right right, Application app, boolean ignoreDepts) throws RemoteException
      Deprecated.
      Use listWithRightCheck(User,String,Right,Application,boolean,String,String,Object...) instead
      Returns a list of all objects of the specified object class for which the specified user has the specified right and for which the condition matches.
      Parameters:
      u - the user
      classname - the fully qualified name of the class of the object
      condition - a SQL condition
      order - a comma separated list of attribute names of the given class.
      bindVars - if the condition contains place holders for binding variables this array should contain the values
      right - the right
      app - the application which department tree should be used for checking
      ignoreDepts - ignore the right a user has via dept scope
      Returns:
      the list
      Throws:
      RemoteException

    • listWithRightCheck

      <P extends Persistent> List<P> listWithRightCheck(User u, String classname, Right right, Application app, boolean ignoreDepts, String condition, String order, Object... bindVars) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of all objects of the specified object class for which the specified user has the specified right and for which the condition matches.
      Parameters:
      u - the user
      classname - the fully qualified name of the class of the object
      right - the right
      app - the application which department tree should be used for checking
      ignoreDepts - ignore the right a user has via dept scope
      condition - a SQL condition
      order - a comma separated list of attribute names of the given class.
      bindVars - values for binding variables in condition
      Returns:
      the list
      Throws:
      RemoteException

    • checkRight

      void checkRight(Right r, Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether the thread user has the right r on object o. Throws ApplicationException 520 if not.
      Parameters:
      r - a right
      o - an object (optional)
      Throws:
      RemoteException

    • mayInsert

      boolean mayInsert(User u, Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether the user may create the object (insert it into the database).
      Parameters:
      u - the user requesting the access
      o - the object
      Returns:
      true, if access is allowed.
      Throws:
      RemoteException

    • mayUpdate

      boolean mayUpdate(User u, Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether the user may edit the object.
      Parameters:
      u - the user requesting the access
      o - the object
      Returns:
      true, if access is allowed.
      Throws:
      RemoteException

    • mayView

      boolean mayView(User u, Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether the user may view the object.
      Parameters:
      u - the user requesting the access
      o - the object
      Returns:
      true, if access is allowed.
      Throws:
      RemoteException

    • mayExecute

      boolean mayExecute(User u, Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether the user may execute the object (function).
      Parameters:
      u - the user requesting the access
      o - the object
      Returns:
      true, if access is allowed.
      Throws:
      RemoteException

    • mayDelete

      boolean mayDelete(User u, Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether the user may delete the object.
      Parameters:
      u - the user requesting the access
      o - the object
      Returns:
      true, if access is allowed.
      Throws:
      RemoteException

    • insert

      void insert(Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Insert the object including right check.
      Parameters:
      o - the object
      Throws:
      RemoteException

    • update

      void update(Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Update the object including right check.
      Parameters:
      o - the object
      Throws:
      RemoteException

    • delete

      void delete(Persistent o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Delete the object including right check.
      Parameters:
      o - the object
      Throws:
      RemoteException

    • getVersion

      <P extends Persistent> P getVersion(P o, Date d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the version of the object at a given date.
      Parameters:
      o - the object
      d - the date
      Returns:
      a Persistent
      Throws:
      RemoteException

    • getLogAndVersion

      <P extends Persistent> Pair<LogEntry,P> getLogAndVersion(P o, Date d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the version of the object at a given date along with the corresponding LogEntry.
      Parameters:
      o - the object
      d - the date
      Returns:
      a Pair of LogEntry and Persistent
      Throws:
      RemoteException

    • getLogAndVersion

      <P extends Persistent> Pair<LogEntry,P> getLogAndVersion(P o, long vid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the version of the object at a given version id along with the corresponding LogEntry.
      Parameters:
      o - the object
      vid - the version id
      Returns:
      a Pair of LogEntry and Persistent
      Throws:
      RemoteException

    • makeLogEntry

      LogEntry makeLogEntry(Persistent o, int mode, long versionid, String desc) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create an entry in the log table.
      Parameters:
      o - the logged object
      mode - the change mode, choose one of LogEntry constants
      versionid - a number identifying the version
      desc - a description test
      Returns:
      Throws:
      RemoteException

    • getLogEntries

      List<LogEntry> getLogEntries(String classname, long oid, Date from, Date to) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of log entries for the specified object (identified by passed oid and classname) which were made at time T, where from < T < to.
      Parameters:
      classname - the fully qualified name of the class of the object
      oid - the oid of the object
      from - the date for the start of the range (may be null)
      to - the date for the end of the range (may be null)
      Returns:
      a list of log entries
      Throws:
      RemoteException

    • listUsersWithRole

      Map<User,List<OrgUnit>> listUsersWithRole(Role r, OrgUnit ou, Application appl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      List the users that have a role
      Parameters:
      r - the role
      ou - optional: the orgunit where the role is assigned
      appl - optional application, necessary when checking hierarchic roles to use the correct department tree. if the argument is null the default tree is used.
      Returns:
      a map where the keys are users the values are lists of the departments where the user have the role. For global roles the lists are empty.
      Throws:
      RemoteException

    • checkPasswordPolicy

      List<String> checkPasswordPolicy(String password) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check a password against the password policy.
      Parameters:
      password - - the password string to check against the policy
      Returns:
      a vector of strings representing the reasons, why password does not fit the policy. null if password is ok
      Throws:
      RemoteException

    • getPolicyInfoText

      String getPolicyInfoText(User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if there are any hints for the user according to the password policy.
      Parameters:
      u - - the user
      Returns:
      a String with a policy info message, null if ther is no neccessary message.
      Throws:
      RemoteException

    • setPassword

      User setPassword(User u, String password) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the password of a user. Note: Be aware that the User Object is updated and a BeanManager.commit() is called in this method.
      Parameters:
      u - the user, whose password should be changed
      password - - the new password (plain string)
      Returns:
      the updated user object
      Throws:
      RemoteException

    • createUser

      User createUser() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new User object.
      Returns:
      a new User
      Throws:
      RemoteException

    • createRole

      Role createRole() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new Role object.
      Returns:
      a new Role
      Throws:
      RemoteException

    • createOrgUnit

      OrgUnit createOrgUnit() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new OrgUnit object.
      Returns:
      a new OrgUnit
      Throws:
      RemoteException

    • createOrgClass

      OrgClass createOrgClass() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new OrgClass object.
      Returns:
      a new OrgClass
      Throws:
      RemoteException

    • createUserRole

      UserRole createUserRole() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new user-role relation
      Returns:
      a new UserRole
      Throws:
      RemoteException

    • createRight

      Right createRight() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new Right.
      Returns:
      a new Right
      Throws:
      RemoteException

    • createPermission

      Permission createPermission() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new Permission
      Returns:
      a new Permission
      Throws:
      RemoteException

    • createPermissionList

      PermissionList createPermissionList() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new PermissionList
      Returns:
      a new PermissionList
      Throws:
      RemoteException

    • setPermissionList

      void setPermissionList(HasPermissionList o, PermissionList pl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the Permissionlist pl for an object o
      Parameters:
      o -
      pl -
      Throws:
      RemoteException

    • deleteCascade

      void deleteCascade(OrgUnit ou) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Delete the passed organizational unit and also objects which are of no use without it.
      Parameters:
      ou - the organizational unit to delete
      Throws:
      RemoteException

    • getSubOrgs

      List<OrgUnit> getSubOrgs(OrgUnit ou, OrgTree tree) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the list of the organizational units that are below the given oe in the given tree. If the argument ou is null, it returns the top level org-units of the given tree.
      Throws:
      RemoteException

    • getSuperOrg

      OrgUnit getSuperOrg(OrgUnit ou, OrgTree tree) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the organizational unit that is above the given oe in the given tree.
      Throws:
      RemoteException

    • createOrgTree

      OrgTree createOrgTree() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return a new organizational tree.
      Throws:
      RemoteException

    • placeOrgInTree

      void placeOrgInTree(OrgUnit parent, OrgUnit child, OrgTree tree) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Change the organizational hierarchy. Note that each org.unit has zero or one parent org.units in an org.tree.
      Parameters:
      parent - , may be null.
      child -
      tree - the tree
      Throws:
      RemoteException

    • isInTree

      boolean isInTree(OrgUnit ou, OrgTree tree) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Is the given org-unit in the specified org-tree.
      Parameters:
      ou -
      tree -
      Returns:
      true if the org-unit is part of the tree.
      Throws:
      RemoteException

    • getDeptsInScope

      List<OrgUnit> getDeptsInScope(OrgUnit ou, int orgScope, OrgTree tree) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the list of of organizational units which are in the given scope relatively from the given organizational unit.
      Parameters:
      ou - the organizational unit to start with
      orgScope - the scope c.f. Permission
      tree - the tree
      Returns:
      the list of organizational units in the specified scope within the tree
      Throws:
      RemoteException

    • getObjectExtension

      Persistent getObjectExtension(Persistent obj, String formclass, boolean create) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the extension object to a persistent. If none exists and create is true, the extension is created.
      Parameters:
      obj - an object having extensions
      formclass - the name of a form-class
      create - if true extensions are created
      Returns:
      the extension object
      Throws:
      RemoteException

    • deleteObjectExtension

      void deleteObjectExtension(Persistent obj, String formclass) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      delete the object extension for the given object.
      Throws:
      RemoteException

    • changeDeferred

      void changeDeferred(Persistent p, Date d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Change the Object later
      Parameters:
      p - the Object
      d - the time of change
      Throws:
      RemoteException

    • clearCachedUserProperties

      void clearCachedUserProperties(User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Clears the cache for the user properties of the passed user. May be needed in clustered installations when login depends on newest values of user properties.
      Parameters:
      u - the User
      Throws:
      RemoteException

    • addRoleToSession

      void addRoleToSession(Role r, OrgUnit ou) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds a role to the current usersession.
      Parameters:
      r - the role to add. Must not be null.
      ou - the organizational unit. If the role is a global one, this must be null, else an organizational unit must be provided.
      Throws:
      RemoteException

    • removeRoleFromSession

      void removeRoleFromSession(Role r, OrgUnit ou) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes a role from the current usersession.
      Parameters:
      r - the role to remove. Must not be null.
      ou - the organizational unit; if null, then the role will be removed regardless of the organizational unit.
      Throws:
      RemoteException

    • removeAllRolesFromSession

      void removeAllRolesFromSession() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes all roles from the current usersession.
      Throws:
      RemoteException

    • hasRoleInSession

      boolean hasRoleInSession(Role r, OrgUnit ou) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if the given combination of role and organizational unit has been added to the current usersession.
      Parameters:
      r - the role, if null then a specific role is not taken into account
      ou - the organizational unit; if null then a specific organizational unit is not taken into account.
      Returns:
      true, if the combination of role (and optional organizational unit) has been assigned to the current usersession.
      Throws:
      RemoteException

    • getSessionRoles

      List<Pair<Role,OrgUnit>> getSessionRoles() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns all the combinations of role and organizational units that have been assigned to the current usersession.
      Returns:
      Throws:
      RemoteException