Package org.openiam.srvc.am

Interface OrganizationDataService

All Known Implementing Classes:

OrganizationDataServiceImpl

public interface OrganizationDataService

Method Summary

Modifier and Type	Method	Description
Response	addChildOrganization(String organizationId, String childOrganizationId, Set<String> rightIds, Date startDate, Date endDate)
Response	addGroupToOrganization(String organizationId, String groupId, Set<String> rightIds, Date startDate, Date endDate)
Response	addLocation(Location location)
Response	addResourceToOrganization(String organizationId, String resourceId, Set<String> rightIds, Date startDate, Date endDate)
Response	addRoleToOrganization(String organizationId, String roleId, Set<String> rightIds, Date startDate, Date endDate)
Response	canAddUserToOrganization(String organizationId, String userId, Date startDate, Date endDate)
Response	canRemoveUserToOrganization(String organizationId, String userId)
int	count(OrganizationSearchBean searchBean)
Response	deleteOrganization(String orgId)
Response	deleteOrganizationWithSkipPrePostProcessors(String orgId, boolean skipPrePostProcessors)
OrganizationListResponse	findBeans(OrganizationSearchBean searchBean, int from, int size)
List<Location>	findLocationBeans(LocationSearchBean searchBean, int from, int size)
List<Organization>	getAllowedParentOrganizationsForType(String orgTypeId)
List<Organization>	getChildOrganizations(String orgId, int from, int size)
OrganizationListResponse	getDetachedForUser(String userId, String name, int from, int size)	method is used to detect all user's organizations that are not linked with any resources.
Location	getLocationById(String locationId)
List<Location>	getLocationListByPageForUser(String organizationId, int from, int size)
int	getNumOfChildOrganizations(String orgId)	Deprecated.
int	getNumOfLocations(LocationSearchBean searchBean)
int	getNumOfParentOrganizations(String orgId)	Deprecated.
Organization	getOrganization(String orgId)
List<OrganizationAttribute>	getOrganizationAttributes(String orgId)
List<Organization>	getOrganizationsForUserByType(String userId, String organizationTypeId)
List<Organization>	getParentOrganizations(String orgId, int from, int size)	Deprecated.
OrganizationListResponse	getWithResources(String userId, OrganizationSearchBean searchBean, Set<String> resourceTypeIds, int from, int size)	method is used to get user's organizaiotn with entitled resources.
boolean	isIndexed(String organizationId)	Checks if a Organization has been indexed in the search engine (currently ElasticSearch)
Response	reindexOrganization(String id)
Response	removeChildOrganization(String organizationId, String childOrganizationId)
Response	removeGroupFromOrganization(String organizationId, String groupId)
Response	removeLocation(String locationId)
Response	removeResourceFromOrganization(String organizationId, String resourceId)
Response	removeRoleFromOrganization(String organizationId, String roleId)
Response	saveOrganization(Organization organization)
Response	saveOrganizationWithSkipPrePostProcessors(Organization organization, boolean skipPrePostProcessors)
Organization	suggestById(String id)	Find a organization in Elasticsearch.
Response	updateLocation(Location location)
Response	validateDelete(String id)
Response	validateEdit(Organization organization)

Method Detail

validateEdit

Response validateEdit(Organization organization)

validateDelete

Response validateDelete(String id)

getOrganization

Organization getOrganization(String orgId)

suggestById

Organization suggestById(String id)

Find a organization in Elasticsearch. Significantly faster than going to the database. Use this method when performance is important and/or data integrity is not 100% required, as the database and ES may be out of sync for a period of time

Parameters:

id - the role id

Returns:

group

getOrganizationsForUserByType

List<Organization> getOrganizationsForUserByType(String userId,
                                                 String organizationTypeId)

findBeans

OrganizationListResponse findBeans(OrganizationSearchBean searchBean,
                                   int from,
                                   int size)

getParentOrganizations

@Deprecated
List<Organization> getParentOrganizations(String orgId,
                                          int from,
                                          int size)

Deprecated.

getChildOrganizations

List<Organization> getChildOrganizations(String orgId,
                                         int from,
                                         int size)

count

int count(OrganizationSearchBean searchBean)

getNumOfParentOrganizations

@Deprecated
int getNumOfParentOrganizations(String orgId)

Deprecated.

getNumOfChildOrganizations

@Deprecated
int getNumOfChildOrganizations(String orgId)

Deprecated.

saveOrganization

Response saveOrganization(Organization organization)

saveOrganizationWithSkipPrePostProcessors

Response saveOrganizationWithSkipPrePostProcessors(Organization organization,
                                                   boolean skipPrePostProcessors)

addChildOrganization

Response addChildOrganization(String organizationId,
                              String childOrganizationId,
                              Set<String> rightIds,
                              Date startDate,
                              Date endDate)

addGroupToOrganization

Response addGroupToOrganization(String organizationId,
                                String groupId,
                                Set<String> rightIds,
                                Date startDate,
                                Date endDate)

removeGroupFromOrganization

Response removeGroupFromOrganization(String organizationId,
                                     String groupId)

addRoleToOrganization

Response addRoleToOrganization(String organizationId,
                               String roleId,
                               Set<String> rightIds,
                               Date startDate,
                               Date endDate)

removeRoleFromOrganization

Response removeRoleFromOrganization(String organizationId,
                                    String roleId)

addResourceToOrganization

Response addResourceToOrganization(String organizationId,
                                   String resourceId,
                                   Set<String> rightIds,
                                   Date startDate,
                                   Date endDate)

removeResourceFromOrganization

Response removeResourceFromOrganization(String organizationId,
                                        String resourceId)

deleteOrganization

Response deleteOrganization(String orgId)

deleteOrganizationWithSkipPrePostProcessors

Response deleteOrganizationWithSkipPrePostProcessors(String orgId,
                                                     boolean skipPrePostProcessors)

removeChildOrganization

Response removeChildOrganization(String organizationId,
                                 String childOrganizationId)

canAddUserToOrganization

Response canAddUserToOrganization(String organizationId,
                                  String userId,
                                  Date startDate,
                                  Date endDate)

canRemoveUserToOrganization

Response canRemoveUserToOrganization(String organizationId,
                                     String userId)

getAllowedParentOrganizationsForType

List<Organization> getAllowedParentOrganizationsForType(String orgTypeId)

addLocation

Response addLocation(Location location)

updateLocation

Response updateLocation(Location location)

removeLocation

Response removeLocation(String locationId)

reindexOrganization

Response reindexOrganization(String id)

getLocationById

Location getLocationById(String locationId)

findLocationBeans

List<Location> findLocationBeans(LocationSearchBean searchBean,
                                 int from,
                                 int size)

getNumOfLocations

int getNumOfLocations(LocationSearchBean searchBean)

getLocationListByPageForUser

List<Location> getLocationListByPageForUser(String organizationId,
                                            int from,
                                            int size)

getOrganizationAttributes

List<OrganizationAttribute> getOrganizationAttributes(String orgId)

isIndexed

boolean isIndexed(String organizationId)

Checks if a Organization has been indexed in the search engine (currently ElasticSearch)

Parameters:

organizationId -

Returns:

getDetachedForUser

OrganizationListResponse getDetachedForUser(String userId,
                                            String name,
                                            int from,
                                            int size)

method is used to detect all user's organizations that are not linked with any resources.

Parameters:

userId - - id of User to check detached groups

name - - name for case INSENSITIVE CONTAINS match search.

from - - zero based very first result

Returns:

- OrganizationListResponse

getWithResources

OrganizationListResponse getWithResources(String userId,
                                          OrganizationSearchBean searchBean,
                                          Set<String> resourceTypeIds,
                                          int from,
                                          int size)

method is used to get user's organizaiotn with entitled resources. filter #resourceTypeIds - does't work for organization due to global restrictions. need to refactor.

Parameters:

userId - - user id

searchBean - - searchBean for objects

resourceTypeIds - - types of resources to fetch

from - - zero based very first result

size - - total size of page.

Returns:

GroupListResponse with requested objects