oracle.epm.fm.domainobject.security

Class SecurityOM

java.lang.Object

oracle.epm.fm.domainobject.security.SecurityOM

All Implemented Interfaces:

Serializable

public class SecurityOM
extends Object
implements Serializable

SecurityOM contains all security related APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SecurityOM(SessionInfo sessionInfo) Constructor of SecurityOM.

Method Summary

Modifier and Type	Method and Description
void	addSecurityClass(String className) Method helps to add the security class to server.
List<SecurityClassError>	deleteSecurityClasses(List<String> securityClasses) Method helps to delete the security classes from server.
List<ACCESS_RIGHTS>	getCellLevelAccessRights(String povSlice) Method to get Cell level Access rights.
List<String>	getSecurityClasses() Method get the all security class form the serverd.
List<ACCESS_RIGHTS>	getSecurityClassesAccessForConnectedUser(List<String> securityClasses) Get list of corresponding security classes accesss for the connected user based on input security classes.
List<String>	getSecurityClassesForConnectedUser(ACCESS_RIGHTS minAccess) Get all the security Class for connected user.
List<UserAccessRight>	getSecurityClassRights(List<String> users, List<String> classes, List<String> nusers) Get security class rights.
List<Boolean>	getTaskAccessForConnectedUserFromList(List<TASK_ENUM> taskEnum) Method to get Task Access rights.
void	saveSecurityClassRights(List<UserAccessRight> userAccessRights) Method helps to save security class rights to Server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityOM

public SecurityOM(SessionInfo sessionInfo)
           throws HFMException

Constructor of SecurityOM.

Parameters:

sessionInfo - session related information

Throws:

HFMException

Method Detail

getSecurityClasses

public List<String> getSecurityClasses()
                                throws HFMException

Method get the all security class form the serverd.

Returns:

list all of security classes within the application

Throws:

HFMException - on error

getSecurityClassesForConnectedUser

public List<String> getSecurityClassesForConnectedUser(ACCESS_RIGHTS minAccess)
                                                throws HFMException

Get all the security Class for connected user.

Parameters:

minAccess - min access right that the user need to have

Returns:

return all the security class that the use has at least the minimun input security class access right.

Throws:

HFMException - on error

getSecurityClassesAccessForConnectedUser

public List<ACCESS_RIGHTS> getSecurityClassesAccessForConnectedUser(List<String> securityClasses)
                                                             throws HFMException

Get list of corresponding security classes accesss for the connected user based on input security classes.

Parameters:

securityClasses - list of security classes

Returns:

list of corresponding security classes accesss for the connected user based on input security classes

Throws:

HFMException - on error or input security classes is null

addSecurityClass

public void addSecurityClass(String className)
                      throws HFMException

Method helps to add the security class to server.

Parameters:

className - security class name that we want to add

Throws:

HFMException - on error or input security classes is null

deleteSecurityClasses

public List<SecurityClassError> deleteSecurityClasses(List<String> securityClasses)
                                               throws HFMException

Method helps to delete the security classes from server.

Parameters:

securityClasses - list of security classes

Returns:

list of security class error while delete

Throws:

HFMException - on error or input security classes is null

getSecurityClassRights

public List<UserAccessRight> getSecurityClassRights(List<String> users,
                                                    List<String> classes,
                                                    List<String> nusers)
                                             throws HFMException

Get security class rights.

Parameters:

users - list of selected users/groups

classes - list of selected classes

Returns:

list of user security class access rights

Throws:

HFMException

saveSecurityClassRights

public void saveSecurityClassRights(List<UserAccessRight> userAccessRights)
                             throws HFMException

Method helps to save security class rights to Server.

Parameters:

userAccessRights - list of user securiry class access righhts

Throws:

HFMException

getCellLevelAccessRights

public List<ACCESS_RIGHTS> getCellLevelAccessRights(String povSlice)
                                             throws HFMException

Method to get Cell level Access rights.

Parameters:

povSlice - string representing single pov.

Returns:

list of Cell level Access rights.

Throws:

HFMException

getTaskAccessForConnectedUserFromList

public List<Boolean> getTaskAccessForConnectedUserFromList(List<TASK_ENUM> taskEnum)
                                                    throws HFMException

Method to get Task Access rights.

Parameters:

taskEnum - list of HFM Task Enums like TASK_OPEN_APPLICATION

Returns:

list of true/false values corresponding to Task Enums

Throws:

HFMException