com.liferay.portal.kernel.service

Class OrganizationLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.OrganizationLocalServiceUtil

public class OrganizationLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Organization. This utility wraps com.liferay.portal.service.impl.OrganizationLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:

OrganizationLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
OrganizationLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static void	addGroupOrganization(long groupId, long organizationId)
static void	addGroupOrganization(long groupId, Organization organization)
static void	addGroupOrganizations(long groupId, java.util.List<Organization> organizations)
static void	addGroupOrganizations(long groupId, long[] organizationIds)
static Organization	addOrganization(long userId, long parentOrganizationId, java.lang.String name, boolean site) Adds an organization.
static 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.
static Organization	addOrganization(Organization organization) Adds the organization to the database.
static void	addOrganizationResources(long userId, Organization organization) Adds a resource for each type of permission available on the organization.
static void	addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) Assigns the password policy to the organizations, removing any other currently assigned password policies.
static void	addUserOrganization(long userId, long organizationId)
static void	addUserOrganization(long userId, Organization organization)
static void	addUserOrganizations(long userId, java.util.List<Organization> organizations)
static void	addUserOrganizations(long userId, long[] organizationIds)
static void	clearGroupOrganizations(long groupId)
static void	clearUserOrganizations(long userId)
static Organization	createOrganization(long organizationId) Creates a new organization with the primary key.
static void	deleteGroupOrganization(long groupId, long organizationId)
static void	deleteGroupOrganization(long groupId, Organization organization)
static void	deleteGroupOrganizations(long groupId, java.util.List<Organization> organizations)
static void	deleteGroupOrganizations(long groupId, long[] organizationIds)
static void	deleteLogo(long organizationId) Deletes the organization's logo.
static Organization	deleteOrganization(long organizationId) Deletes the organization with the primary key from the database.
static Organization	deleteOrganization(Organization organization) Deletes the organization from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	deleteUserOrganization(long userId, long organizationId)
static void	deleteUserOrganization(long userId, Organization organization)
static void	deleteUserOrganizations(long userId, java.util.List<Organization> organizations)
static void	deleteUserOrganizations(long userId, long[] organizationIds)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Organization	fetchOrganization(long organizationId)
static Organization	fetchOrganization(long companyId, java.lang.String name) Returns the organization with the name.
static Organization	fetchOrganizationByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the organization with the matching external reference code and company.
static Organization	fetchOrganizationByReferenceCode(long companyId, java.lang.String externalReferenceCode) Deprecated. As of Cavanaugh (7.4.x), replaced by fetchOrganizationByExternalReferenceCode(long, String)
static Organization	fetchOrganizationByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the organization with the matching UUID and company.
static ActionableDynamicQuery	getActionableDynamicQuery()
static java.lang.String[]	getChildrenTypes(java.lang.String type)
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static java.util.List<Organization>	getGroupOrganizations(long groupId)
static java.util.List<Organization>	getGroupOrganizations(long groupId, int start, int end)
static java.util.List<Organization>	getGroupOrganizations(long groupId, int start, int end, OrderByComparator<Organization> orderByComparator)
static int	getGroupOrganizationsCount(long groupId)
static long[]	getGroupPrimaryKeys(long organizationId) Returns the groupIds of the groups associated with the organization.
static java.util.List<Organization>	getGroupUserOrganizations(long groupId, long userId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.util.List<Organization>	getNoAssetOrganizations()
static Organization	getOrganization(long organizationId) Returns the organization with the primary key.
static Organization	getOrganization(long companyId, java.lang.String name) Returns the organization with the name.
static Organization	getOrganizationByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the organization with the matching external reference code and company.
static Organization	getOrganizationByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the organization with the matching UUID and company.
static long	getOrganizationId(long companyId, java.lang.String name) Returns the primary key of the organization with the name.
static java.util.List<Organization>	getOrganizations(int start, int end) Returns a range of all the organizations.
static java.util.List<Organization>	getOrganizations(long[] organizationIds) Returns the organizations with the primary keys.
static java.util.List<Organization>	getOrganizations(long userId, int start, int end, OrderByComparator<Organization> obc)
static java.util.List<Organization>	getOrganizations(long companyId, long parentOrganizationId) Returns all the organizations belonging to the parent organization.
static 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.
static java.util.List<Organization>	getOrganizations(long companyId, long parentOrganizationId, java.lang.String name, int start, int end)
static java.util.List<Organization>	getOrganizations(long companyId, java.lang.String treePath)
static 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.
static int	getOrganizationsAndUsersCount(long companyId, long parentOrganizationId, int status) Returns the number of organizations and users belonging to the parent organization.
static int	getOrganizationsCount() Returns the number of organizations.
static int	getOrganizationsCount(long companyId, long parentOrganizationId) Returns the number of organizations belonging to the parent organization.
static int	getOrganizationsCount(long companyId, long parentOrganizationId, java.lang.String name)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static java.util.List<Organization>	getParentOrganizations(long organizationId) Returns the parent organizations in order by closest ancestor.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static OrganizationLocalService	getService()
static java.util.List<Organization>	getSuborganizations(java.util.List<Organization> organizations) Returns the suborganizations of the organizations.
static java.util.List<Organization>	getSuborganizations(long companyId, long organizationId) Returns the suborganizations of the organization.
static int	getSuborganizationsCount(long companyId, long organizationId) Returns the count of suborganizations of the organization.
static java.util.List<Organization>	getSubsetOrganizations(java.util.List<Organization> allOrganizations, java.util.List<Organization> availableOrganizations) Returns the intersection of allOrganizations and availableOrganizations.
static java.lang.String[]	getTypes()
static 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.
static java.util.List<Organization>	getUserOrganizations(long userId)
static 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.
static java.util.List<Organization>	getUserOrganizations(long userId, int start, int end)
static java.util.List<Organization>	getUserOrganizations(long userId, int start, int end, OrderByComparator<Organization> orderByComparator)
static int	getUserOrganizationsCount(long userId)
static long[]	getUserPrimaryKeys(long organizationId) Returns the userIds of the users associated with the organization.
static boolean	hasGroupOrganization(long groupId, long organizationId)
static boolean	hasGroupOrganizations(long groupId)
static boolean	hasPasswordPolicyOrganization(long passwordPolicyId, long organizationId) Returns true if the password policy has been assigned to the organization.
static boolean	hasUserOrganization(long userId, long organizationId)
static 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.
static boolean	hasUserOrganizations(long userId)
static boolean	isCountryEnabled(java.lang.String type)
static boolean	isCountryRequired(java.lang.String type)
static boolean	isRootable(java.lang.String type)
static void	rebuildTree(long companyId) Rebuilds the organization's tree.
static 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.
static 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.
static 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.
static 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.
static 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.
static 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.
static 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.
static 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.
static 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)
static 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)
static 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.
static 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.
static void	setGroupOrganizations(long groupId, long[] organizationIds)
static void	setUserOrganizations(long userId, long[] organizationIds)
static void	unsetGroupOrganizations(long groupId, long[] organizationIds) Removes the organizations from the group.
static void	unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) Removes the organizations from the password policy.
static 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.
static 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.
static 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)
static Organization	updateOrganization(Organization organization) Updates the organization in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationLocalServiceUtil

public OrganizationLocalServiceUtil()

Method Detail

addGroupOrganization

public static void addGroupOrganization(long groupId,
                                        long organizationId)

addGroupOrganization

public static void addGroupOrganization(long groupId,
                                        Organization organization)

addGroupOrganizations

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

addGroupOrganizations

public static void addGroupOrganizations(long groupId,
                                         long[] organizationIds)

addOrganization

public static 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

public static 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

public static Organization addOrganization(Organization organization)

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

Important: Inspect OrganizationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

organization - the organization

Returns:

the organization that was added

addOrganizationResources

public static 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

public static 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

public static void addUserOrganization(long userId,
                                       long organizationId)

addUserOrganization

public static void addUserOrganization(long userId,
                                       Organization organization)

addUserOrganizations

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

addUserOrganizations

public static void addUserOrganizations(long userId,
                                        long[] organizationIds)

clearGroupOrganizations

public static void clearGroupOrganizations(long groupId)

clearUserOrganizations

public static void clearUserOrganizations(long userId)

createOrganization

public static 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

public static void deleteGroupOrganization(long groupId,
                                           long organizationId)

deleteGroupOrganization

public static void deleteGroupOrganization(long groupId,
                                           Organization organization)

deleteGroupOrganizations

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

deleteGroupOrganizations

public static void deleteGroupOrganizations(long groupId,
                                            long[] organizationIds)

deleteLogo

public static void deleteLogo(long organizationId)
                       throws PortalException

Deletes the organization's logo.

Parameters:

organizationId - the primary key of the organization

Throws:

PortalException

deleteOrganization

public static Organization deleteOrganization(long organizationId)
                                       throws PortalException

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

Important: Inspect OrganizationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

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

public static Organization deleteOrganization(Organization organization)
                                       throws PortalException

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

Important: Inspect OrganizationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

organization - the organization

Returns:

the organization that was removed

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteUserOrganization

public static void deleteUserOrganization(long userId,
                                          long organizationId)

deleteUserOrganization

public static void deleteUserOrganization(long userId,
                                          Organization organization)

deleteUserOrganizations

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

deleteUserOrganizations

public static void deleteUserOrganizations(long userId,
                                           long[] organizationIds)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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

public static <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

public static 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

public static 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

public static Organization fetchOrganization(long organizationId)

fetchOrganization

public static 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

fetchOrganizationByExternalReferenceCode

public static Organization fetchOrganizationByExternalReferenceCode(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

fetchOrganizationByReferenceCode

@Deprecated
public static Organization fetchOrganizationByReferenceCode(long companyId,
                                                                        java.lang.String externalReferenceCode)

Deprecated. As of Cavanaugh (7.4.x), replaced by fetchOrganizationByExternalReferenceCode(long, String)

fetchOrganizationByUuidAndCompanyId

public static 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

public static ActionableDynamicQuery getActionableDynamicQuery()

getChildrenTypes

public static java.lang.String[] getChildrenTypes(java.lang.String type)

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupOrganizations

public static java.util.List<Organization> getGroupOrganizations(long groupId)

getGroupOrganizations

public static java.util.List<Organization> getGroupOrganizations(long groupId,
                                                                 int start,
                                                                 int end)

getGroupOrganizations

public static java.util.List<Organization> getGroupOrganizations(long groupId,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator<Organization> orderByComparator)

getGroupOrganizationsCount

public static int getGroupOrganizationsCount(long groupId)

getGroupPrimaryKeys

public static 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

public static java.util.List<Organization> getGroupUserOrganizations(long groupId,
                                                                     long userId)
                                                              throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNoAssetOrganizations

public static java.util.List<Organization> getNoAssetOrganizations()

getOrganization

public static 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

public static 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

getOrganizationByExternalReferenceCode

public static Organization getOrganizationByExternalReferenceCode(long companyId,
                                                                  java.lang.String externalReferenceCode)
                                                           throws PortalException

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

Throws:

PortalException - if a matching organization could not be found

getOrganizationByUuidAndCompanyId

public static 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

public static 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

public static 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

public static java.util.List<Organization> getOrganizations(long userId,
                                                            int start,
                                                            int end,
                                                            OrderByComparator<Organization> obc)
                                                     throws PortalException

Throws:

PortalException

getOrganizations

public static 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

public static 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

public static java.util.List<Organization> getOrganizations(long companyId,
                                                            long parentOrganizationId,
                                                            java.lang.String name,
                                                            int start,
                                                            int end)

getOrganizations

public static java.util.List<Organization> getOrganizations(long companyId,
                                                            java.lang.String treePath)

getOrganizations

public static 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

public static 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

public static 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

public static int getOrganizationsCount()

Returns the number of organizations.

Returns:

the number of organizations

getOrganizationsCount

public static 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

public static int getOrganizationsCount(long companyId,
                                        long parentOrganizationId,
                                        java.lang.String name)

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getParentOrganizations

public static 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

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getSuborganizations

public static 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

public static 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

public static 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

public static 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

public static java.lang.String[] getTypes()

getUserOrganizationIds

public static 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

public static java.util.List<Organization> getUserOrganizations(long userId)

getUserOrganizations

public static 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

public static java.util.List<Organization> getUserOrganizations(long userId,
                                                                int start,
                                                                int end)

getUserOrganizations

public static java.util.List<Organization> getUserOrganizations(long userId,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<Organization> orderByComparator)

getUserOrganizationsCount

public static int getUserOrganizationsCount(long userId)

getUserPrimaryKeys

public static 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

public static boolean hasGroupOrganization(long groupId,
                                           long organizationId)

hasGroupOrganizations

public static boolean hasGroupOrganizations(long groupId)

hasPasswordPolicyOrganization

public static 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

public static boolean hasUserOrganization(long userId,
                                          long organizationId)

hasUserOrganization

public static 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

public static boolean hasUserOrganizations(long userId)

isCountryEnabled

public static boolean isCountryEnabled(java.lang.String type)

isCountryRequired

public static boolean isCountryRequired(java.lang.String type)

isRootable

public static boolean isRootable(java.lang.String type)

rebuildTree

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static void setGroupOrganizations(long groupId,
                                         long[] organizationIds)

setUserOrganizations

public static void setUserOrganizations(long userId,
                                        long[] organizationIds)

unsetGroupOrganizations

public static 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

public static 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

public static 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

public static 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
public static 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

public static 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.

Important: Inspect OrganizationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

organization - the organization

Returns:

the organization that was updated

getService

public static OrganizationLocalService getService()