com.retek.rsm.app.security.service
Interface SecurityDataAdminService

All Superinterfaces:
com.retek.platform.service.Service
All Known Implementing Classes:
SecurityDataAdminServiceEjb

public interface SecurityDataAdminService
extends com.retek.platform.service.Service

The internal data level permission admin service API. This interface should be used by the RSM client to perform data level permission maintenance.


Field Summary
 
Fields inherited from interface com.retek.platform.service.Service
serialVersionUID
 
Method Summary
 com.retek.platform.bo.IdentifiableReference createHierarchyPermissionReference(com.retek.platform.service.ClientContext clientContext)
          Reads next available hierarchy permission reference.
 com.retek.platform.bo.IdentifiableReference createRoleHierarchyPermissionReference(com.retek.platform.service.ClientContext clientContext)
          Reads next available role hierarchy permission reference.
 void deleteRoleHierarchyPermissionReferences(com.retek.platform.service.ClientContext clientContext, java.util.Set roleHierarchyPermissionReferences)
          Removes all hierarchy permissions identified by the set of references.
 java.util.Set findAppDefinitions(com.retek.platform.service.ClientContext context)
          Find the application definitions from the app_data_definition.xml files to create the screen layout.
 java.util.Set findDisplayableReferences(com.retek.platform.service.ClientContext clientContext, DisplayableReferenceSearchCriteria criteria)
          Finds all the displayable reference VO's for the given search criteria by calling out to the associated application on the search criteria.
 java.util.Set findRoleHierarchyPermissionVos(com.retek.platform.service.ClientContext clientContext, RoleHierarchyPermissionSearchCriteria criteria)
          Finds all of the hierarchy permission VO's for the given search criteria.
 AppDefinitionVo readAppDefinition(com.retek.platform.service.ClientContext clientContext, com.retek.platform.app.security.service.Application application)
          Finds the application definition from the app_data_definition.xml files for the given application to create the screen layout.
 void saveRoleHierarchyPermissionVos(com.retek.platform.service.ClientContext clientContext, com.retek.platform.bo.IdentifiableReference roleReference, java.util.Set roleHierarchyPermissionVos)
          Creates or Updates all hierarchy permissions for the given role.
 
Methods inherited from interface com.retek.platform.service.Service
attachFallbackHandler
 

Method Detail

findAppDefinitions

public java.util.Set findAppDefinitions(com.retek.platform.service.ClientContext context)
                                 throws com.retek.platform.exception.RetekBusinessException
Find the application definitions from the app_data_definition.xml files to create the screen layout.

Throws:
com.retek.platform.exception.RetekBusinessException

readAppDefinition

public AppDefinitionVo readAppDefinition(com.retek.platform.service.ClientContext clientContext,
                                         com.retek.platform.app.security.service.Application application)
                                  throws com.retek.platform.exception.RetekBusinessException
Finds the application definition from the app_data_definition.xml files for the given application to create the screen layout.

Throws:
com.retek.platform.exception.RetekBusinessException

findRoleHierarchyPermissionVos

public java.util.Set findRoleHierarchyPermissionVos(com.retek.platform.service.ClientContext clientContext,
                                                    RoleHierarchyPermissionSearchCriteria criteria)
                                             throws com.retek.platform.exception.RetekBusinessException
Finds all of the hierarchy permission VO's for the given search criteria. An external call is made to an associated application to populate the external ID and description.

Throws:
com.retek.platform.exception.RetekBusinessException

findDisplayableReferences

public java.util.Set findDisplayableReferences(com.retek.platform.service.ClientContext clientContext,
                                               DisplayableReferenceSearchCriteria criteria)
                                        throws com.retek.platform.exception.RetekBusinessException
Finds all the displayable reference VO's for the given search criteria by calling out to the associated application on the search criteria.

Throws:
com.retek.platform.exception.RetekBusinessException

createHierarchyPermissionReference

public com.retek.platform.bo.IdentifiableReference createHierarchyPermissionReference(com.retek.platform.service.ClientContext clientContext)
                                                                               throws com.retek.platform.exception.RetekBusinessException
Reads next available hierarchy permission reference.

Throws:
com.retek.platform.exception.RetekBusinessException

deleteRoleHierarchyPermissionReferences

public void deleteRoleHierarchyPermissionReferences(com.retek.platform.service.ClientContext clientContext,
                                                    java.util.Set roleHierarchyPermissionReferences)
                                             throws com.retek.platform.exception.RetekBusinessException
Removes all hierarchy permissions identified by the set of references.

Throws:
com.retek.platform.exception.RetekBusinessException

saveRoleHierarchyPermissionVos

public void saveRoleHierarchyPermissionVos(com.retek.platform.service.ClientContext clientContext,
                                           com.retek.platform.bo.IdentifiableReference roleReference,
                                           java.util.Set roleHierarchyPermissionVos)
                                    throws com.retek.platform.exception.RetekBusinessException
Creates or Updates all hierarchy permissions for the given role.

Throws:
com.retek.platform.exception.RetekBusinessException

createRoleHierarchyPermissionReference

public com.retek.platform.bo.IdentifiableReference createRoleHierarchyPermissionReference(com.retek.platform.service.ClientContext clientContext)
                                                                                   throws com.retek.platform.exception.RetekBusinessException
Reads next available role hierarchy permission reference.

Throws:
com.retek.platform.exception.RetekBusinessException