com.liferay.portal.kernel.service

Interface OrganizationLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

OrganizationLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface OrganizationLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for Organization. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

OrganizationLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
void	addGroupOrganization(long groupId, long organizationId)
void	addGroupOrganization(long groupId, Organization organization)
void	addGroupOrganizations(long groupId, java.util.List<Organization> organizations)
void	addGroupOrganizations(long groupId, long[] organizationIds)
Organization	addOrganization(long userId, long parentOrganizationId, java.lang.String name, boolean site) Adds an organization.
Organization	addOrganization(long userId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, long statusId, java.lang.String comments, boolean site, ServiceContext serviceContext) Adds an organization.
Organization	addOrganization(Organization organization) Adds the organization to the database.
void	addOrganizationResources(long userId, Organization organization) Adds a resource for each type of permission available on the organization.
void	addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) Assigns the password policy to the organizations, removing any other currently assigned password policies.
void	addUserOrganization(long userId, long organizationId)
void	addUserOrganization(long userId, Organization organization)
void	addUserOrganizations(long userId, java.util.List<Organization> organizations)
void	addUserOrganizations(long userId, long[] organizationIds)
void	clearGroupOrganizations(long groupId)
void	clearUserOrganizations(long userId)
Organization	createOrganization(long organizationId) Creates a new organization with the primary key.
void	deleteGroupOrganization(long groupId, long organizationId)
void	deleteGroupOrganization(long groupId, Organization organization)
void	deleteGroupOrganizations(long groupId, java.util.List<Organization> organizations)
void	deleteGroupOrganizations(long groupId, long[] organizationIds)
void	deleteLogo(long organizationId) Deletes the organization's logo.
Organization	deleteOrganization(long organizationId) Deletes the organization with the primary key from the database.
Organization	deleteOrganization(Organization organization) Deletes the organization from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	deleteUserOrganization(long userId, long organizationId)
void	deleteUserOrganization(long userId, Organization organization)
void	deleteUserOrganizations(long userId, java.util.List<Organization> organizations)
void	deleteUserOrganizations(long userId, long[] organizationIds)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Organization	fetchOrganization(long organizationId)
Organization	fetchOrganization(long companyId, java.lang.String name) Returns the organization with the name.
Organization	fetchOrganizationByReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the organization with the matching external reference code and company.
Organization	fetchOrganizationByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the organization with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
java.lang.String[]	getChildrenTypes(java.lang.String type)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
java.util.List<Organization>	getGroupOrganizations(long groupId)
java.util.List<Organization>	getGroupOrganizations(long groupId, int start, int end)
java.util.List<Organization>	getGroupOrganizations(long groupId, int start, int end, OrderByComparator<Organization> orderByComparator)
int	getGroupOrganizationsCount(long groupId)
long[]	getGroupPrimaryKeys(long organizationId) Returns the groupIds of the groups associated with the organization.
java.util.List<Organization>	getGroupUserOrganizations(long groupId, long userId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.util.List<Organization>	getNoAssetOrganizations()
Organization	getOrganization(long organizationId) Returns the organization with the primary key.
Organization	getOrganization(long companyId, java.lang.String name) Returns the organization with the name.
Organization	getOrganizationByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the organization with the matching UUID and company.
long	getOrganizationId(long companyId, java.lang.String name) Returns the primary key of the organization with the name.
java.util.List<Organization>	getOrganizations(int start, int end) Returns a range of all the organizations.
java.util.List<Organization>	getOrganizations(long[] organizationIds) Returns the organizations with the primary keys.
java.util.List<Organization>	getOrganizations(long userId, int start, int end, OrderByComparator<Organization> obc)
java.util.List<Organization>	getOrganizations(long companyId, long parentOrganizationId) Returns all the organizations belonging to the parent organization.
java.util.List<Organization>	getOrganizations(long companyId, long parentOrganizationId, int start, int end) Returns a range of all the organizations belonging to the parent organization.
java.util.List<Organization>	getOrganizations(long companyId, long parentOrganizationId, java.lang.String name, int start, int end)
java.util.List<Organization>	getOrganizations(long companyId, java.lang.String treePath)
java.util.List<java.lang.Object>	getOrganizationsAndUsers(long companyId, long parentOrganizationId, int status, int start, int end, OrderByComparator<?> obc) Returns all the organizations and users belonging to the parent organization.
int	getOrganizationsAndUsersCount(long companyId, long parentOrganizationId, int status) Returns the number of organizations and users belonging to the parent organization.
int	getOrganizationsCount() Returns the number of organizations.
int	getOrganizationsCount(long companyId, long parentOrganizationId) Returns the number of organizations belonging to the parent organization.
int	getOrganizationsCount(long companyId, long parentOrganizationId, java.lang.String name)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
java.util.List<Organization>	getParentOrganizations(long organizationId) Returns the parent organizations in order by closest ancestor.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<Organization>	getSuborganizations(java.util.List<Organization> organizations) Returns the suborganizations of the organizations.
java.util.List<Organization>	getSuborganizations(long companyId, long organizationId) Returns the suborganizations of the organization.
int	getSuborganizationsCount(long companyId, long organizationId) Returns the count of suborganizations of the organization.
java.util.List<Organization>	getSubsetOrganizations(java.util.List<Organization> allOrganizations, java.util.List<Organization> availableOrganizations) Returns the intersection of allOrganizations and availableOrganizations.
java.lang.String[]	getTypes()
long[]	getUserOrganizationIds(long userId, boolean includeAdministrative) Returns all the IDs of organizations with which the user is explicitly associated, optionally including the IDs of organizations that the user administers or owns.
java.util.List<Organization>	getUserOrganizations(long userId)
java.util.List<Organization>	getUserOrganizations(long userId, boolean includeAdministrative) Returns all the organizations with which the user is explicitly associated, optionally including the organizations that the user administers or owns.
java.util.List<Organization>	getUserOrganizations(long userId, int start, int end)
java.util.List<Organization>	getUserOrganizations(long userId, int start, int end, OrderByComparator<Organization> orderByComparator)
int	getUserOrganizationsCount(long userId)
long[]	getUserPrimaryKeys(long organizationId) Returns the userIds of the users associated with the organization.
boolean	hasGroupOrganization(long groupId, long organizationId)
boolean	hasGroupOrganizations(long groupId)
boolean	hasPasswordPolicyOrganization(long passwordPolicyId, long organizationId) Returns true if the password policy has been assigned to the organization.
boolean	hasUserOrganization(long userId, long organizationId)
boolean	hasUserOrganization(long userId, long organizationId, boolean inheritSuborganizations, boolean includeSpecifiedOrganization) Returns true if the user is a member of the organization, optionally focusing on suborganizations or the specified organization.
boolean	hasUserOrganizations(long userId)
boolean	isCountryEnabled(java.lang.String type)
boolean	isCountryRequired(java.lang.String type)
boolean	isRootable(java.lang.String type)
void	rebuildTree(long companyId) Rebuilds the organization's tree.
Hits	search(long companyId, long parentOrganizationId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, Sort sort) Returns an ordered range of all the organizations that match the keywords, using the indexer.
java.util.List<Organization>	search(long companyId, long parentOrganizationId, java.lang.String keywords, java.lang.String type, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end) Returns a name ordered range of all the organizations that match the keywords, type, region, and country, without using the indexer.
java.util.List<Organization>	search(long companyId, long parentOrganizationId, java.lang.String keywords, java.lang.String type, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator<Organization> obc) Returns an ordered range of all the organizations that match the keywords, type, region, and country, without using the indexer.
java.util.List<Organization>	search(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end) Returns a name ordered range of all the organizations with the type, region, and country, and whose name, street, city, and zipcode match the keywords specified for them, without using the indexer.
java.util.List<Organization>	search(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator<Organization> obc) Returns an ordered range of all the organizations with the type, region, and country, and whose name, street, city, and zipcode match the keywords specified for them, without using the indexer.
Hits	search(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.String region, java.lang.String country, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, Sort sort) Returns an ordered range of all the organizations whose name, type, or location fields match the keywords specified for them, using the indexer.
int	searchCount(long companyId, long parentOrganizationId, java.lang.String keywords, java.lang.String type, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params) Returns the number of organizations that match the keywords, type, region, and country.
int	searchCount(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator) Returns the number of organizations with the type, region, and country, and whose name, street, city, and zipcode match the keywords specified for them.
BaseModelSearchResult<Organization>	searchOrganizations(long companyId, long parentOrganizationId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, Sort sort)
BaseModelSearchResult<Organization>	searchOrganizations(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.String region, java.lang.String country, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, Sort sort)
Hits	searchOrganizationsAndUsers(long companyId, long parentOrganizationId, java.lang.String keywords, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, Sort[] sorts) Returns the organizations and users that match the keywords specified for them and belong to the parent organization.
int	searchOrganizationsAndUsersCount(long companyId, long parentOrganizationId, java.lang.String keywords, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params) Returns the number of organizations and users that match the keywords specified for them and belong to the parent organization.
void	setGroupOrganizations(long groupId, long[] organizationIds)
void	setUserOrganizations(long userId, long[] organizationIds)
void	unsetGroupOrganizations(long groupId, long[] organizationIds) Removes the organizations from the group.
void	unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) Removes the organizations from the password policy.
void	updateAsset(long userId, Organization organization, long[] assetCategoryIds, java.lang.String[] assetTagNames) Updates the organization's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary.
Organization	updateOrganization(long companyId, long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, long statusId, java.lang.String comments, boolean logo, byte[] logoBytes, boolean site, ServiceContext serviceContext) Updates the organization.
Organization	updateOrganization(long companyId, long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, long statusId, java.lang.String comments, boolean site, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), replaced by updateOrganization(long, long, long, String, String, long, long, long, String, boolean, byte[], boolean, ServiceContext)
Organization	updateOrganization(Organization organization) Updates the organization in the database or adds it if it does not yet exist.

Method Detail

addGroupOrganization

void addGroupOrganization(long groupId,
                          long organizationId)

addGroupOrganization

void addGroupOrganization(long groupId,
                          Organization organization)

addGroupOrganizations

void addGroupOrganizations(long groupId,
                           java.util.List<Organization> organizations)

addGroupOrganizations

void addGroupOrganizations(long groupId,
                           long[] organizationIds)

addOrganization

Organization addOrganization(long userId,
                             long parentOrganizationId,
                             java.lang.String name,
                             boolean site)
                      throws PortalException

Adds an organization.

This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures. It is not necessary to make a subsequent call to addOrganizationResources(long, Organization).

Parameters:

userId - the primary key of the creator/owner of the organization

parentOrganizationId - the primary key of the organization's parent organization

name - the organization's name

site - whether the organization is to be associated with a main site

Returns:

the organization

Throws:

PortalException

addOrganization

Organization addOrganization(long userId,
                             long parentOrganizationId,
                             java.lang.String name,
                             java.lang.String type,
                             long regionId,
                             long countryId,
                             long statusId,
                             java.lang.String comments,
                             boolean site,
                             ServiceContext serviceContext)
                      throws PortalException

Adds an organization.

This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures. It is not necessary to make a subsequent call to addOrganizationResources(long, Organization).

Parameters:

userId - the primary key of the creator/owner of the organization

parentOrganizationId - the primary key of the organization's parent organization

name - the organization's name

type - the organization's type

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - the organization's workflow status

comments - the comments about the organization

site - whether the organization is to be associated with a main site

serviceContext - the service context to be applied (optionally null). Can set asset category IDs, asset tag names, and expando bridge attributes for the organization.

Returns:

the organization

Throws:

PortalException

addOrganization

@Indexable(type=REINDEX)
Organization addOrganization(Organization organization)

Adds the organization to the database. Also notifies the appropriate model listeners.

Parameters:

organization - the organization

Returns:

the organization that was added

addOrganizationResources

void addOrganizationResources(long userId,
                              Organization organization)
                       throws PortalException

Adds a resource for each type of permission available on the organization.

Parameters:

userId - the primary key of the creator/owner of the organization

organization - the organization

Throws:

PortalException

addPasswordPolicyOrganizations

void addPasswordPolicyOrganizations(long passwordPolicyId,
                                    long[] organizationIds)

Assigns the password policy to the organizations, removing any other currently assigned password policies.

Parameters:

passwordPolicyId - the primary key of the password policy

organizationIds - the primary keys of the organizations

addUserOrganization

void addUserOrganization(long userId,
                         long organizationId)

addUserOrganization

void addUserOrganization(long userId,
                         Organization organization)

addUserOrganizations

void addUserOrganizations(long userId,
                          java.util.List<Organization> organizations)

addUserOrganizations

void addUserOrganizations(long userId,
                          long[] organizationIds)

clearGroupOrganizations

void clearGroupOrganizations(long groupId)

clearUserOrganizations

void clearUserOrganizations(long userId)

createOrganization

@Transactional(enabled=false)
Organization createOrganization(long organizationId)

Creates a new organization with the primary key. Does not add the organization to the database.

Parameters:

organizationId - the primary key for the new organization

Returns:

the new organization

deleteGroupOrganization

void deleteGroupOrganization(long groupId,
                             long organizationId)

deleteGroupOrganization

void deleteGroupOrganization(long groupId,
                             Organization organization)

deleteGroupOrganizations

void deleteGroupOrganizations(long groupId,
                              java.util.List<Organization> organizations)

deleteGroupOrganizations

void deleteGroupOrganizations(long groupId,
                              long[] organizationIds)

deleteLogo

void deleteLogo(long organizationId)
         throws PortalException

Deletes the organization's logo.

Parameters:

organizationId - the primary key of the organization

Throws:

PortalException

deleteOrganization

@Indexable(type=DELETE)
Organization deleteOrganization(long organizationId)
                                                 throws PortalException

Deletes the organization with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

organizationId - the primary key of the organization

Returns:

the organization that was removed

Throws:

PortalException - if a organization with the primary key could not be found

deleteOrganization

@Indexable(type=DELETE)
 @SystemEvent(type=1)
Organization deleteOrganization(Organization organization)
                                                                       throws PortalException

Deletes the organization from the database. Also notifies the appropriate model listeners.

Parameters:

organization - the organization

Returns:

the organization that was removed

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteUserOrganization

void deleteUserOrganization(long userId,
                            long organizationId)

deleteUserOrganization

void deleteUserOrganization(long userId,
                            Organization organization)

deleteUserOrganizations

void deleteUserOrganizations(long userId,
                             java.util.List<Organization> organizations)

deleteUserOrganizations

void deleteUserOrganizations(long userId,
                             long[] organizationIds)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.OrganizationModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.OrganizationModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Organization fetchOrganization(long organizationId)

fetchOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Organization fetchOrganization(long companyId,
                                                                                                  java.lang.String name)

Returns the organization with the name.

Parameters:

companyId - the primary key of the organization's company

name - the organization's name

Returns:

the organization with the name, or null if no organization could be found

fetchOrganizationByReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Organization fetchOrganizationByReferenceCode(long companyId,
                                                                                                                 java.lang.String externalReferenceCode)

Returns the organization with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the organization's external reference code

Returns:

the matching organization, or null if a matching organization could not be found

fetchOrganizationByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Organization fetchOrganizationByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                    long companyId)

Returns the organization with the matching UUID and company.

Parameters:

uuid - the organization's UUID

companyId - the primary key of the company

Returns:

the matching organization, or null if a matching organization could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getChildrenTypes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String[] getChildrenTypes(java.lang.String type)

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getGroupOrganizations(long groupId)

getGroupOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getGroupOrganizations(long groupId,
                                                                                                                      int start,
                                                                                                                      int end)

getGroupOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getGroupOrganizations(long groupId,
                                                                                                                      int start,
                                                                                                                      int end,
                                                                                                                      OrderByComparator<Organization> orderByComparator)

getGroupOrganizationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupOrganizationsCount(long groupId)

getGroupPrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getGroupPrimaryKeys(long organizationId)

Returns the groupIds of the groups associated with the organization.

Parameters:

organizationId - the organizationId of the organization

Returns:

long[] the groupIds of groups associated with the organization

getGroupUserOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getGroupUserOrganizations(long groupId,
                                                                                                                          long userId)
                                                                                                                   throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNoAssetOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getNoAssetOrganizations()

getOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Organization getOrganization(long organizationId)
                                                                                         throws PortalException

Returns the organization with the primary key.

Parameters:

organizationId - the primary key of the organization

Returns:

the organization

Throws:

PortalException - if a organization with the primary key could not be found

getOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Organization getOrganization(long companyId,
                                                                                                java.lang.String name)
                                                                                         throws PortalException

Returns the organization with the name.

Parameters:

companyId - the primary key of the organization's company

name - the organization's name

Returns:

the organization with the name

Throws:

PortalException

getOrganizationByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Organization getOrganizationByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                  long companyId)
                                                                                                           throws PortalException

Returns the organization with the matching UUID and company.

Parameters:

uuid - the organization's UUID

companyId - the primary key of the company

Returns:

the matching organization

Throws:

PortalException - if a matching organization could not be found

getOrganizationId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getOrganizationId(long companyId,
                                                                                          java.lang.String name)

Returns the primary key of the organization with the name.

Parameters:

companyId - the primary key of the organization's company

name - the organization's name

Returns:

the primary key of the organization with the name, or 0 if the organization could not be found

getOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getOrganizations(int start,
                                                                                                                 int end)

Returns a range of all the organizations.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.OrganizationModelImpl.

Parameters:

start - the lower bound of the range of organizations

end - the upper bound of the range of organizations (not inclusive)

Returns:

the range of organizations

getOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getOrganizations(long userId,
                                                                                                                 int start,
                                                                                                                 int end,
                                                                                                                 OrderByComparator<Organization> obc)
                                                                                                          throws PortalException

Throws:

PortalException

getOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getOrganizations(long companyId,
                                                                                                                 long parentOrganizationId)

Returns all the organizations belonging to the parent organization.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

Returns:

the organizations belonging to the parent organization

getOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getOrganizations(long companyId,
                                                                                                                 long parentOrganizationId,
                                                                                                                 int start,
                                                                                                                 int end)

Returns a range of all the organizations belonging to the parent organization.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

Returns:

the range of organizations belonging to the parent organization

See Also:

OrganizationPersistence.findByC_P( long, long, int, int)

getOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getOrganizations(long companyId,
                                                                                                                 long parentOrganizationId,
                                                                                                                 java.lang.String name,
                                                                                                                 int start,
                                                                                                                 int end)

getOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getOrganizations(long companyId,
                                                                                                                 java.lang.String treePath)

getOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getOrganizations(long[] organizationIds)
                                                                                                          throws PortalException

Returns the organizations with the primary keys.

Parameters:

organizationIds - the primary keys of the organizations

Returns:

the organizations with the primary keys

Throws:

PortalException

getOrganizationsAndUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getOrganizationsAndUsers(long companyId,
                                                                                                                             long parentOrganizationId,
                                                                                                                             int status,
                                                                                                                             int start,
                                                                                                                             int end,
                                                                                                                             OrderByComparator<?> obc)

Returns all the organizations and users belonging to the parent organization.

Parameters:

companyId - the primary key of the organization and user's company

parentOrganizationId - the primary key of the organization and user's parent organization

status - the user's workflow status

start - the lower bound of the range of organizations and users to return

end - the upper bound of the range of organizations and users to return (not inclusive)

obc - the comparator to order the organizations and users (optionally null)

Returns:

the organizations and users belonging to the parent organization

getOrganizationsAndUsersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOrganizationsAndUsersCount(long companyId,
                                                                                                     long parentOrganizationId,
                                                                                                     int status)

Returns the number of organizations and users belonging to the parent organization.

Parameters:

companyId - the primary key of the organization and user's company

parentOrganizationId - the primary key of the organization and user's parent organization

status - the user's workflow status

Returns:

the number of organizations and users belonging to the parent organization

getOrganizationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOrganizationsCount()

Returns the number of organizations.

Returns:

the number of organizations

getOrganizationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOrganizationsCount(long companyId,
                                                                                             long parentOrganizationId)

Returns the number of organizations belonging to the parent organization.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

Returns:

the number of organizations belonging to the parent organization

getOrganizationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOrganizationsCount(long companyId,
                                                                                             long parentOrganizationId,
                                                                                             java.lang.String name)

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getParentOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getParentOrganizations(long organizationId)
                                                                                                                throws PortalException

Returns the parent organizations in order by closest ancestor. The list starts with the organization itself.

Parameters:

organizationId - the primary key of the organization

Returns:

the parent organizations in order by closest ancestor

Throws:

PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSuborganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getSuborganizations(java.util.List<Organization> organizations)

Returns the suborganizations of the organizations.

Parameters:

organizations - the organizations from which to get suborganizations

Returns:

the suborganizations of the organizations

getSuborganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getSuborganizations(long companyId,
                                                                                                                    long organizationId)

Returns the suborganizations of the organization.

Parameters:

companyId - the primary key of the organization's company

organizationId - the primary key of the organization

Returns:

the suborganizations of the organization

getSuborganizationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSuborganizationsCount(long companyId,
                                                                                                long organizationId)

Returns the count of suborganizations of the organization.

Parameters:

companyId - the primary key of the organization's company

organizationId - the primary key of the organization

Returns:

the count of suborganizations of the organization

getSubsetOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getSubsetOrganizations(java.util.List<Organization> allOrganizations,
                                                                                                                       java.util.List<Organization> availableOrganizations)

Returns the intersection of allOrganizations and availableOrganizations.

Parameters:

allOrganizations - the organizations to check for availability

availableOrganizations - the available organizations

Returns:

the intersection of allOrganizations and availableOrganizations

getTypes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String[] getTypes()

getUserOrganizationIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getUserOrganizationIds(long userId,
                                                                                                 boolean includeAdministrative)
                                                                                          throws PortalException

Returns all the IDs of organizations with which the user is explicitly associated, optionally including the IDs of organizations that the user administers or owns.

A user is considered to be explicitly associated with an organization if his account is individually created within the organization or if the user is later added to it.

Parameters:

userId - the primary key of the user

includeAdministrative - whether to include the IDs of organizations that the user administers or owns, even if he's not a member of the organizations

Returns:

the IDs of organizations with which the user is explicitly associated, optionally including the IDs of organizations that the user administers or owns

Throws:

PortalException

getUserOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getUserOrganizations(long userId)

getUserOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getUserOrganizations(long userId,
                                                                                                                     boolean includeAdministrative)
                                                                                                              throws PortalException

Returns all the organizations with which the user is explicitly associated, optionally including the organizations that the user administers or owns.

A user is considered to be explicitly associated with an organization if his account is individually created within the organization or if the user is later added as a member.

Parameters:

userId - the primary key of the user

includeAdministrative - whether to include the IDs of organizations that the user administers or owns, even if he's not a member of the organizations

Returns:

the organizations with which the user is explicitly associated, optionally including the organizations that the user administers or owns

Throws:

PortalException

getUserOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getUserOrganizations(long userId,
                                                                                                                     int start,
                                                                                                                     int end)

getUserOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> getUserOrganizations(long userId,
                                                                                                                     int start,
                                                                                                                     int end,
                                                                                                                     OrderByComparator<Organization> orderByComparator)

getUserOrganizationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserOrganizationsCount(long userId)

getUserPrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getUserPrimaryKeys(long organizationId)

Returns the userIds of the users associated with the organization.

Parameters:

organizationId - the organizationId of the organization

Returns:

long[] the userIds of users associated with the organization

hasGroupOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupOrganization(long groupId,
                                                                                                long organizationId)

hasGroupOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupOrganizations(long groupId)

hasPasswordPolicyOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasPasswordPolicyOrganization(long passwordPolicyId,
                                                                                                         long organizationId)

Returns true if the password policy has been assigned to the organization.

Parameters:

passwordPolicyId - the primary key of the password policy

organizationId - the primary key of the organization

Returns:

true if the password policy has been assigned to the organization; false otherwise

hasUserOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserOrganization(long userId,
                                                                                               long organizationId)

hasUserOrganization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserOrganization(long userId,
                                                                                               long organizationId,
                                                                                               boolean inheritSuborganizations,
                                                                                               boolean includeSpecifiedOrganization)
                                                                                        throws PortalException

Returns true if the user is a member of the organization, optionally focusing on suborganizations or the specified organization. This method is usually called to determine if the user has view access to a resource belonging to the organization.

1. If inheritSuborganizations=false: the method checks whether the user belongs to the organization specified by organizationId. The parameter includeSpecifiedOrganization is ignored.
2. The parameter includeSpecifiedOrganization is ignored unless inheritSuborganizations is also true.
3. If inheritSuborganizations=true and includeSpecifiedOrganization=false: the method checks whether the user belongs to one of the child organizations of the one specified by organizationId.
4. If inheritSuborganizations=true and includeSpecifiedOrganization=true: the method checks whether the user belongs to the organization specified by organizationId or any of its child organizations.

Parameters:

userId - the primary key of the organization's user

organizationId - the primary key of the organization

inheritSuborganizations - if true suborganizations are considered in the determination

includeSpecifiedOrganization - if true the organization specified by organizationId is considered in the determination

Returns:

true if the user has access to the organization; false otherwise

Throws:

PortalException

See Also:

OrganizationFinder

hasUserOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserOrganizations(long userId)

isCountryEnabled

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isCountryEnabled(java.lang.String type)

isCountryRequired

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isCountryRequired(java.lang.String type)

isRootable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isRootable(java.lang.String type)

rebuildTree

void rebuildTree(long companyId)
          throws PortalException

Rebuilds the organization's tree.

Only call this method if the tree has become stale through operations other than normal CRUD. Under normal circumstances the tree is automatically rebuilt whenever necessary.

Parameters:

companyId - the primary key of the organization's company

Throws:

PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long companyId,
                                                                               long parentOrganizationId,
                                                                               java.lang.String keywords,
                                                                               java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                               int start,
                                                                               int end,
                                                                               Sort sort)

Returns an ordered range of all the organizations that match the keywords, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

keywords - the keywords (space separated), which may occur in the organization's name, street, city, zipcode, type, region or country (optionally null)

params - the finder parameters (optionally null). For more information see OrganizationIndexer

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

sort - the field and direction by which to sort (optionally null)

Returns:

the matching organizations ordered by name

See Also:

OrganizationIndexer

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> search(long companyId,
                                                                                                       long parentOrganizationId,
                                                                                                       java.lang.String keywords,
                                                                                                       java.lang.String type,
                                                                                                       java.lang.Long regionId,
                                                                                                       java.lang.Long countryId,
                                                                                                       java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                       int start,
                                                                                                       int end)

Returns a name ordered range of all the organizations that match the keywords, type, region, and country, without using the indexer. It is preferable to use the indexed version search(long, long, String, LinkedHashMap, int, int, Sort) instead of this method wherever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

keywords - the keywords (space separated), which may occur in the organization's name, street, city, or zipcode (optionally null)

type - the organization's type (optionally null)

regionId - the primary key of the organization's region (optionally null)

countryId - the primary key of the organization's country (optionally null)

params - the finder params. For more information see OrganizationFinder

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

Returns:

the matching organizations ordered by name

See Also:

OrganizationFinder

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> search(long companyId,
                                                                                                       long parentOrganizationId,
                                                                                                       java.lang.String keywords,
                                                                                                       java.lang.String type,
                                                                                                       java.lang.Long regionId,
                                                                                                       java.lang.Long countryId,
                                                                                                       java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       OrderByComparator<Organization> obc)

Returns an ordered range of all the organizations that match the keywords, type, region, and country, without using the indexer. It is preferable to use the indexed version search(long, long, String, String, String, String, String, String, String, LinkedHashMap, boolean, int, int, Sort) instead of this method wherever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

keywords - the keywords (space separated), which may occur in the organization's name, street, city, or zipcode (optionally null)

type - the organization's type (optionally null)

regionId - the primary key of the organization's region (optionally null)

countryId - the primary key of the organization's country (optionally null)

params - the finder params. For more information see OrganizationFinder

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

obc - the comparator to order the organizations (optionally null)

Returns:

the matching organizations ordered by comparator obc

See Also:

OrganizationFinder

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> search(long companyId,
                                                                                                       long parentOrganizationId,
                                                                                                       java.lang.String name,
                                                                                                       java.lang.String type,
                                                                                                       java.lang.String street,
                                                                                                       java.lang.String city,
                                                                                                       java.lang.String zip,
                                                                                                       java.lang.Long regionId,
                                                                                                       java.lang.Long countryId,
                                                                                                       java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                       boolean andOperator,
                                                                                                       int start,
                                                                                                       int end)

Returns a name ordered range of all the organizations with the type, region, and country, and whose name, street, city, and zipcode match the keywords specified for them, without using the indexer. It is preferable to use the indexed version search(long, long, String, String, String, String, String, String, String, LinkedHashMap, boolean, int, int, Sort) instead of this method wherever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent

name - the name keywords (space separated, optionally null)

type - the organization's type (optionally null)

street - the street keywords (optionally null)

city - the city keywords (optionally null)

zip - the zipcode keywords (optionally null)

regionId - the primary key of the organization's region (optionally null)

countryId - the primary key of the organization's country (optionally null)

params - the finder parameters (optionally null). For more information see OrganizationFinder

andOperator - whether every field must match its keywords, or just one field. For example, "organizations with the name 'Employees' and city 'Chicago'" vs "organizations with the name 'Employees' or the city 'Chicago'".

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

Returns:

the matching organizations ordered by name

See Also:

OrganizationFinder

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Organization> search(long companyId,
                                                                                                       long parentOrganizationId,
                                                                                                       java.lang.String name,
                                                                                                       java.lang.String type,
                                                                                                       java.lang.String street,
                                                                                                       java.lang.String city,
                                                                                                       java.lang.String zip,
                                                                                                       java.lang.Long regionId,
                                                                                                       java.lang.Long countryId,
                                                                                                       java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                       boolean andOperator,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       OrderByComparator<Organization> obc)

Returns an ordered range of all the organizations with the type, region, and country, and whose name, street, city, and zipcode match the keywords specified for them, without using the indexer. It is preferable to use the indexed version search(long, long, String, String, String, String, String, String, String, LinkedHashMap, boolean, int, int, Sort) instead of this method wherever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

name - the name keywords (space separated, optionally null)

type - the organization's type (optionally null)

street - the street keywords (optionally null)

city - the city keywords (optionally null)

zip - the zipcode keywords (optionally null)

regionId - the primary key of the organization's region (optionally null)

countryId - the primary key of the organization's country (optionally null)

params - the finder parameters (optionally null). For more information see OrganizationFinder

andOperator - whether every field must match its keywords, or just one field. For example, "organizations with the name 'Employees' and city 'Chicago'" vs "organizations with the name 'Employees' or the city 'Chicago'".

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

obc - the comparator to order the organizations (optionally null)

Returns:

the matching organizations ordered by comparator obc

See Also:

OrganizationFinder

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long companyId,
                                                                               long parentOrganizationId,
                                                                               java.lang.String name,
                                                                               java.lang.String type,
                                                                               java.lang.String street,
                                                                               java.lang.String city,
                                                                               java.lang.String zip,
                                                                               java.lang.String region,
                                                                               java.lang.String country,
                                                                               java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                               boolean andSearch,
                                                                               int start,
                                                                               int end,
                                                                               Sort sort)

Returns an ordered range of all the organizations whose name, type, or location fields match the keywords specified for them, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

name - the name keywords (space separated, optionally null)

type - the type keywords (optionally null)

street - the street keywords (optionally null)

city - the city keywords (optionally null)

zip - the zipcode keywords (optionally null)

region - the region keywords (optionally null)

country - the country keywords (optionally null)

params - the finder parameters (optionally null). For more information see OrganizationIndexer.

andSearch - whether every field must match its keywords or just one field

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

sort - the field and direction by which to sort (optionally null)

Returns:

the matching organizations ordered by sort

See Also:

OrganizationIndexer

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long parentOrganizationId,
                                                                                   java.lang.String keywords,
                                                                                   java.lang.String type,
                                                                                   java.lang.Long regionId,
                                                                                   java.lang.Long countryId,
                                                                                   java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)

Returns the number of organizations that match the keywords, type, region, and country.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

keywords - the keywords (space separated), which may occur in the organization's name, street, city, or zipcode (optionally null)

type - the organization's type (optionally null)

regionId - the primary key of the organization's region (optionally null)

countryId - the primary key of the organization's country (optionally null)

params - the finder parameters (optionally null). For more information see OrganizationFinder

Returns:

the number of matching organizations

See Also:

OrganizationFinder

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long parentOrganizationId,
                                                                                   java.lang.String name,
                                                                                   java.lang.String type,
                                                                                   java.lang.String street,
                                                                                   java.lang.String city,
                                                                                   java.lang.String zip,
                                                                                   java.lang.Long regionId,
                                                                                   java.lang.Long countryId,
                                                                                   java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                   boolean andOperator)

Returns the number of organizations with the type, region, and country, and whose name, street, city, and zipcode match the keywords specified for them.

Parameters:

companyId - the primary key of the organization's company

parentOrganizationId - the primary key of the organization's parent organization

name - the name keywords (space separated, optionally null)

type - the organization's type (optionally null)

street - the street keywords (optionally null)

city - the city keywords (optionally null)

zip - the zipcode keywords (optionally null)

regionId - the primary key of the organization's region (optionally null)

countryId - the primary key of the organization's country (optionally null)

params - the finder parameters (optionally null). For more information see OrganizationFinder

andOperator - whether every field must match its keywords, or just one field. For example, "organizations with the name 'Employees' and city 'Chicago'" vs "organizations with the name 'Employees' or the city 'Chicago'".

Returns:

the number of matching organizations

See Also:

OrganizationFinder

searchOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<Organization> searchOrganizations(long companyId,
                                                                                                                           long parentOrganizationId,
                                                                                                                           java.lang.String keywords,
                                                                                                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                                           int start,
                                                                                                                           int end,
                                                                                                                           Sort sort)
                                                                                                                    throws PortalException

Throws:

PortalException

searchOrganizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<Organization> searchOrganizations(long companyId,
                                                                                                                           long parentOrganizationId,
                                                                                                                           java.lang.String name,
                                                                                                                           java.lang.String type,
                                                                                                                           java.lang.String street,
                                                                                                                           java.lang.String city,
                                                                                                                           java.lang.String zip,
                                                                                                                           java.lang.String region,
                                                                                                                           java.lang.String country,
                                                                                                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                                           boolean andSearch,
                                                                                                                           int start,
                                                                                                                           int end,
                                                                                                                           Sort sort)
                                                                                                                    throws PortalException

Throws:

PortalException

searchOrganizationsAndUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits searchOrganizationsAndUsers(long companyId,
                                                                                                    long parentOrganizationId,
                                                                                                    java.lang.String keywords,
                                                                                                    int status,
                                                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                    int start,
                                                                                                    int end,
                                                                                                    Sort[] sorts)
                                                                                             throws PortalException

Returns the organizations and users that match the keywords specified for them and belong to the parent organization.

Parameters:

companyId - the primary key of the organization and user's company

parentOrganizationId - the primary key of the organization and user's parent organization

keywords - the keywords (space separated), which may occur in the organization's name, type, or location fields or user's first name, middle name, last name, screen name, email address, or address fields

status - user's workflow status

params - the finder parameters (optionally null).

start - the lower bound of the range of organizations and users to return

end - the upper bound of the range of organizations and users to return (not inclusive)

Returns:

the matching organizations and users

Throws:

PortalException

searchOrganizationsAndUsersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchOrganizationsAndUsersCount(long companyId,
                                                                                                        long parentOrganizationId,
                                                                                                        java.lang.String keywords,
                                                                                                        int status,
                                                                                                        java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                                                                                                 throws PortalException

Returns the number of organizations and users that match the keywords specified for them and belong to the parent organization.

Parameters:

companyId - the primary key of the organization and user's company

parentOrganizationId - the primary key of the organization and user's parent organization

keywords - the keywords (space separated), which may occur in the organization's name, type, or location fields or user's first name, middle name, last name, screen name, email address, or address fields

status - user's workflow status

params - the finder parameters (optionally null).

Returns:

the number of matching organizations and users

Throws:

PortalException

setGroupOrganizations

void setGroupOrganizations(long groupId,
                           long[] organizationIds)

setUserOrganizations

void setUserOrganizations(long userId,
                          long[] organizationIds)

unsetGroupOrganizations

void unsetGroupOrganizations(long groupId,
                             long[] organizationIds)

Removes the organizations from the group.

Parameters:

groupId - the primary key of the group

organizationIds - the primary keys of the organizations

unsetPasswordPolicyOrganizations

void unsetPasswordPolicyOrganizations(long passwordPolicyId,
                                      long[] organizationIds)

Removes the organizations from the password policy.

Parameters:

passwordPolicyId - the primary key of the password policy

organizationIds - the primary keys of the organizations

updateAsset

void updateAsset(long userId,
                 Organization organization,
                 long[] assetCategoryIds,
                 java.lang.String[] assetTagNames)
          throws PortalException

Updates the organization's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary.

Parameters:

userId - the primary key of the user

organization - the organization

assetCategoryIds - the primary keys of the asset categories

assetTagNames - the asset tag names

Throws:

PortalException

updateOrganization

Organization updateOrganization(long companyId,
                                long organizationId,
                                long parentOrganizationId,
                                java.lang.String name,
                                java.lang.String type,
                                long regionId,
                                long countryId,
                                long statusId,
                                java.lang.String comments,
                                boolean logo,
                                byte[] logoBytes,
                                boolean site,
                                ServiceContext serviceContext)
                         throws PortalException

Updates the organization.

Parameters:

companyId - the primary key of the organization's company

organizationId - the primary key of the organization

parentOrganizationId - the primary key of organization's parent organization

name - the organization's name

type - the organization's type

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - the organization's workflow status

comments - the comments about the organization

logo - whether to update the ogranization's logo

logoBytes - the new logo image data

site - whether the organization is to be associated with a main site

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the organization, and merge expando bridge attributes for the organization.

Returns:

the organization

Throws:

PortalException

updateOrganization

@Deprecated
Organization updateOrganization(long companyId,
                                            long organizationId,
                                            long parentOrganizationId,
                                            java.lang.String name,
                                            java.lang.String type,
                                            long regionId,
                                            long countryId,
                                            long statusId,
                                            java.lang.String comments,
                                            boolean site,
                                            ServiceContext serviceContext)
                                     throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by updateOrganization(long, long, long, String, String, long, long, long, String, boolean, byte[], boolean, ServiceContext)

Updates the organization.

Parameters:

companyId - the primary key of the organization's company

organizationId - the primary key of the organization

parentOrganizationId - the primary key of organization's parent organization

name - the organization's name

type - the organization's type

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - the organization's workflow status

comments - the comments about the organization

site - whether the organization is to be associated with a main site

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the organization, and merge expando bridge attributes for the organization.

Returns:

the organization

Throws:

PortalException

updateOrganization

@Indexable(type=REINDEX)
Organization updateOrganization(Organization organization)

Updates the organization in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

organization - the organization

Returns:

the organization that was updated