com.groiss.org

Interface RemoteOrgData

All Superinterfaces:

Remote

All Known Subinterfaces:

OrgData

public interface RemoteOrgData
extends Remote

This interface allows access to the organizational data stored in @enterprise.

Method Summary

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

Method Detail

addRule

void addRule(PermissionMapping pm)
      throws RemoteException

Add a permission mapping to the permission system.

Parameters:

pm - the permission mapping

Throws:

RemoteException

get

<T> T get(Class<? extends T> c,
          long oid)
   throws RemoteException

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

<T> T get(String classname,
          long oid)
   throws RemoteException

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. since ep 9.0 and will be removed in ep 10.0. Use RemoteStore.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

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

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

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

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. since ep 9.0 and will be removed in ep 10.0. Use RemoteStore.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. since ep 9.0 and will be removed in ep 10.0. Use RemoteStore.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. since ep 9.0 and will be removed in ep 10.0. Use RemoteStore.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. since ep 9.0 and will be removed in ep 10.0. Use RemoteStore.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

<T> T getById(Class<? extends T> c,
              String id)
       throws RemoteException

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

<T> T getById(String classname,
              String id)
       throws ClassNotFoundException,
              RemoteException

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

Return the Org.unit where the user has the home role.

Parameters:

u - the User

Returns:

the OrgUnit

Throws:

RemoteException

list

<T> List<T> list(Class<? extends T> c,
                 String cond,
                 String order)
          throws RemoteException

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

<T> List<T> list(Class<? extends T> c,
                 String cond,
                 String order,
                 Object... bindVars)
          throws RemoteException

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

List<Persistent> list(String classname,
                      String cond,
                      String order,
                      Object... bindVars)
               throws RemoteException

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<? extends Role,Set<String>> getRoles(User u)
                                  throws RemoteException

Returns a Map of the roles - and depts - of a user.

Parameters:

u - the user

Returns:

a Map where the first keys are the roles, the values are Sets again, containing strings of the form deptoid or form deptoid*depttreeoid. If the role is global, this Set is empty.

Throws:

RemoteException

getRoles

List<Role> getRoles(User u,
                    OrgUnit d)
             throws RemoteException

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

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

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

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

Throws:

RemoteException

hasRightForList

<T extends Persistent> List<T> hasRightForList(User u,
                                               Right r,
                                               List<? extends T> l,
                                               Application app)
                                        throws RemoteException

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

<T extends Persistent> List<T> hasRightForList(User u,
                                               Right r,
                                               List<? extends T> l,
                                               boolean ignoreOrgs,
                                               boolean ignoreSubsts,
                                               Application app)
                                        throws RemoteException

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
<T extends Persistent> List<T> listWithRightCheck(User u,
                                                              Class<? extends T> 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

<T extends Persistent> List<T> listWithRightCheck(User u,
                                                  Class<? extends T> clazz,
                                                  Right right,
                                                  Application app,
                                                  boolean ignoreDepts,
                                                  String condition,
                                                  String order,
                                                  Object... args)
                                           throws RemoteException

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
<T extends Persistent> List<T> 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

<T extends Persistent> List<T> listWithRightCheck(User u,
                                                  String classname,
                                                  Right right,
                                                  Application app,
                                                  boolean ignoreDepts,
                                                  String condition,
                                                  String order,
                                                  Object... bindVars)
                                           throws RemoteException

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

Check whether the thread user has the right r on object o. Throws ApplicationException 27 if not.

Parameters:

r - a right

o - an object (optional)

Throws:

RemoteException

mayInsert

boolean mayInsert(User u,
                  Persistent o)
           throws RemoteException

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

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

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

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

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

Insert the object including right check.

Parameters:

o - the object

Throws:

RemoteException

update

void update(Persistent o)
     throws RemoteException

Update the object including right check.

Parameters:

o - the object

Throws:

RemoteException

delete

void delete(Persistent o)
     throws RemoteException

Delete the object including right check.

Parameters:

o - the object

Throws:

RemoteException

getVersion

<P extends Persistent> P getVersion(P o,
                                    Date d)
                             throws RemoteException

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

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

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

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

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

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

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

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

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

Create a new User object.

Returns:

a new User

Throws:

RemoteException

createRole

Role createRole()
         throws RemoteException

Create a new Role object.

Returns:

a new Role

Throws:

RemoteException

createOrgUnit

OrgUnit createOrgUnit()
               throws RemoteException

Create a new OrgUnit object.

Returns:

a new OrgUnit

Throws:

RemoteException

createOrgClass

OrgClass createOrgClass()
                 throws RemoteException

Create a new OrgClass object.

Returns:

a new OrgClass

Throws:

RemoteException

createUserRole

UserRole createUserRole()
                 throws RemoteException

Create a new user-role relation

Returns:

a new UserRole

Throws:

RemoteException

createRight

Right createRight()
           throws RemoteException

Create a new Right.

Returns:

a new Right

Throws:

RemoteException

createPermission

Permission createPermission()
                     throws RemoteException

Create a new Permission

Returns:

a new Permission

Throws:

RemoteException

createPermissionList

PermissionList createPermissionList()
                             throws RemoteException

Create a new PermissionList

Returns:

a new PermissionList

Throws:

RemoteException

setPermissionList

void setPermissionList(HasPermissionList o,
                       PermissionList pl)
                throws RemoteException

Set the Permissionlist pl for an object o

Parameters:

o -

pl -

Throws:

RemoteException

deleteCascade

void deleteCascade(OrgUnit ou)
            throws RemoteException

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

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

Return the organizational unit that is above the given oe in the given tree.

Throws:

RemoteException

createOrgTree

OrgTree createOrgTree()
               throws RemoteException

Return a new organizational tree.

Throws:

RemoteException

placeOrgInTree

void placeOrgInTree(OrgUnit parent,
                    OrgUnit child,
                    OrgTree tree)
             throws RemoteException

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

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

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

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

delete the object extension for the given object.

Throws:

RemoteException

changeDeferred

void changeDeferred(Persistent p,
                    Date d)
             throws RemoteException

Change the Object later

Parameters:

p - the Object

d - the time of change

Throws:

RemoteException

clearCachedUserProperties

void clearCachedUserProperties(User u)
                        throws RemoteException

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

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

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

Removes all roles from the current usersession.

Throws:

RemoteException

hasRoleInSession

boolean hasRoleInSession(Role r,
                         OrgUnit ou)
                  throws RemoteException

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

Returns all the combinations of role and organizational units that have been assigned to the current usersession.

Returns:

Throws:

RemoteException

getReferencedObjects

List<Exportable> getReferencedObjects(Exportable e)
                               throws Exception

Returns the objects referenced by the given object, including the object itself. The functionality is similar to the XML-Export, where the export of an object contains all components of this object. For example, if the argument is a user, the method returns a list of user-role-relations, user-properties, etc. The method can be used to copy such an object with all its components.

Parameters:

e - an Exportable (User, Role, ProcessDefinition)

Returns:

a list of Exportables

Throws:

Exception