Class OrganizationLocalServiceWrapper

Object
com.liferay.portal.kernel.service.OrganizationLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, CTService<Organization>, OrganizationLocalService, PersistedModelLocalService, ServiceWrapper<OrganizationLocalService>

public class OrganizationLocalServiceWrapper extends Object implements OrganizationLocalService, ServiceWrapper<OrganizationLocalService>
Provides a wrapper for OrganizationLocalService.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • OrganizationLocalServiceWrapper

      public OrganizationLocalServiceWrapper()
    • OrganizationLocalServiceWrapper

      public OrganizationLocalServiceWrapper(OrganizationLocalService organizationLocalService)
  • Method Details

    • addGroupOrganization

      public boolean addGroupOrganization(long groupId, long organizationId)
      Specified by:
      addGroupOrganization in interface OrganizationLocalService
    • addGroupOrganization

      public boolean addGroupOrganization(long groupId, Organization organization)
      Specified by:
      addGroupOrganization in interface OrganizationLocalService
    • addGroupOrganizations

      public boolean addGroupOrganizations(long groupId, List<Organization> organizations)
      Specified by:
      addGroupOrganizations in interface OrganizationLocalService
    • addGroupOrganizations

      public boolean addGroupOrganizations(long groupId, long[] organizationIds)
      Specified by:
      addGroupOrganizations in interface OrganizationLocalService
    • addOrganization

      public Organization addOrganization(long userId, long parentOrganizationId, 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).

      Specified by:
      addOrganization in interface OrganizationLocalService
      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 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.

      Specified by:
      addOrganization in interface OrganizationLocalService
      Parameters:
      organization - the organization
      Returns:
      the organization that was added
    • addOrganization

      public Organization addOrganization(String externalReferenceCode, long userId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, 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).

      Specified by:
      addOrganization in interface OrganizationLocalService
      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
      statusListTypeId - 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
    • addOrganizationResources

      public void addOrganizationResources(long userId, Organization organization) throws PortalException
      Adds a resource for each type of permission available on the organization.
      Specified by:
      addOrganizationResources in interface OrganizationLocalService
      Parameters:
      userId - the primary key of the creator/owner of the organization
      organization - the organization
      Throws:
      PortalException
    • addOrganizationUserByEmailAddress

      public User addOrganizationUserByEmailAddress(String emailAddress, long organizationId, ServiceContext serviceContext) throws PortalException
      Specified by:
      addOrganizationUserByEmailAddress in interface OrganizationLocalService
      Throws:
      PortalException
    • addOrUpdateOrganization

      public Organization addOrUpdateOrganization(String externalReferenceCode, long userId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean hasLogo, byte[] logoBytes, boolean site, ServiceContext serviceContext) throws PortalException
      Specified by:
      addOrUpdateOrganization in interface OrganizationLocalService
      Throws:
      PortalException
    • addPasswordPolicyOrganizations

      public void addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds)
      Assigns the password policy to the organizations, removing any other currently assigned password policies.
      Specified by:
      addPasswordPolicyOrganizations in interface OrganizationLocalService
      Parameters:
      passwordPolicyId - the primary key of the password policy
      organizationIds - the primary keys of the organizations
    • addUserOrganization

      public boolean addUserOrganization(long userId, long organizationId)
      Specified by:
      addUserOrganization in interface OrganizationLocalService
    • addUserOrganization

      public boolean addUserOrganization(long userId, Organization organization)
      Specified by:
      addUserOrganization in interface OrganizationLocalService
    • addUserOrganizationByEmailAddress

      public void addUserOrganizationByEmailAddress(String emailAddress, long organizationId) throws PortalException
      Specified by:
      addUserOrganizationByEmailAddress in interface OrganizationLocalService
      Throws:
      PortalException
    • addUserOrganizations

      public boolean addUserOrganizations(long userId, List<Organization> organizations)
      Specified by:
      addUserOrganizations in interface OrganizationLocalService
    • addUserOrganizations

      public boolean addUserOrganizations(long userId, long[] organizationIds)
      Specified by:
      addUserOrganizations in interface OrganizationLocalService
    • clearGroupOrganizations

      public void clearGroupOrganizations(long groupId)
      Specified by:
      clearGroupOrganizations in interface OrganizationLocalService
    • clearUserOrganizations

      public void clearUserOrganizations(long userId)
      Specified by:
      clearUserOrganizations in interface OrganizationLocalService
    • createOrganization

      public Organization createOrganization(long organizationId)
      Creates a new organization with the primary key. Does not add the organization to the database.
      Specified by:
      createOrganization in interface OrganizationLocalService
      Parameters:
      organizationId - the primary key for the new organization
      Returns:
      the new organization
    • createPersistedModel

      public PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface OrganizationLocalService
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
      PortalException
    • deleteGroupOrganization

      public void deleteGroupOrganization(long groupId, long organizationId)
      Specified by:
      deleteGroupOrganization in interface OrganizationLocalService
    • deleteGroupOrganization

      public void deleteGroupOrganization(long groupId, Organization organization)
      Specified by:
      deleteGroupOrganization in interface OrganizationLocalService
    • deleteGroupOrganizations

      public void deleteGroupOrganizations(long groupId, List<Organization> organizations)
      Specified by:
      deleteGroupOrganizations in interface OrganizationLocalService
    • deleteGroupOrganizations

      public void deleteGroupOrganizations(long groupId, long[] organizationIds)
      Specified by:
      deleteGroupOrganizations in interface OrganizationLocalService
    • deleteLogo

      public void deleteLogo(long organizationId) throws PortalException
      Deletes the organization's logo.
      Specified by:
      deleteLogo in interface OrganizationLocalService
      Parameters:
      organizationId - the primary key of the organization
      Throws:
      PortalException
    • deleteOrganization

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

      Specified by:
      deleteOrganization in interface OrganizationLocalService
      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
      PortalException
    • deleteOrganization

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

      Specified by:
      deleteOrganization in interface OrganizationLocalService
      Parameters:
      organization - the organization
      Returns:
      the organization that was removed
      Throws:
      PortalException
      PortalException
    • deletePersistedModel

      public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface OrganizationLocalService
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
      PortalException
    • deleteUserOrganization

      public void deleteUserOrganization(long userId, long organizationId)
      Specified by:
      deleteUserOrganization in interface OrganizationLocalService
    • deleteUserOrganization

      public void deleteUserOrganization(long userId, Organization organization)
      Specified by:
      deleteUserOrganization in interface OrganizationLocalService
    • deleteUserOrganizationByEmailAddress

      public void deleteUserOrganizationByEmailAddress(String emailAddress, long organizationId) throws PortalException
      Specified by:
      deleteUserOrganizationByEmailAddress in interface OrganizationLocalService
      Throws:
      PortalException
    • deleteUserOrganizations

      public void deleteUserOrganizations(long userId, List<Organization> organizations)
      Specified by:
      deleteUserOrganizations in interface OrganizationLocalService
    • deleteUserOrganizations

      public void deleteUserOrganizations(long userId, long[] organizationIds)
      Specified by:
      deleteUserOrganizations in interface OrganizationLocalService
    • dslQuery

      public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface OrganizationLocalService
      Specified by:
      dslQuery in interface PersistedModelLocalService
    • dslQueryCount

      public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface OrganizationLocalService
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • dynamicQuery

      public DynamicQuery dynamicQuery()
      Specified by:
      dynamicQuery in interface OrganizationLocalService
    • dynamicQuery

      public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Specified by:
      dynamicQuery in interface OrganizationLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

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

      Specified by:
      dynamicQuery in interface OrganizationLocalService
      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 <T> 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.

      Specified by:
      dynamicQuery in interface OrganizationLocalService
      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 long dynamicQueryCount(DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Specified by:
      dynamicQueryCount in interface OrganizationLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows matching the dynamic query.
      Specified by:
      dynamicQueryCount in interface OrganizationLocalService
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchOrganization

      public Organization fetchOrganization(long organizationId)
      Specified by:
      fetchOrganization in interface OrganizationLocalService
    • fetchOrganization

      public Organization fetchOrganization(long companyId, String name)
      Returns the organization with the name.
      Specified by:
      fetchOrganization in interface OrganizationLocalService
      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 Organization fetchOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId)
      Specified by:
      fetchOrganizationByExternalReferenceCode in interface OrganizationLocalService
    • fetchOrganizationByUuidAndCompanyId

      public Organization fetchOrganizationByUuidAndCompanyId(String uuid, long companyId)
      Returns the organization with the matching UUID and company.
      Specified by:
      fetchOrganizationByUuidAndCompanyId in interface OrganizationLocalService
      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 ActionableDynamicQuery getActionableDynamicQuery()
      Specified by:
      getActionableDynamicQuery in interface OrganizationLocalService
    • getChildrenTypes

      public String[] getChildrenTypes(String type)
      Specified by:
      getChildrenTypes in interface OrganizationLocalService
    • getExportActionableDynamicQuery

      public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
      Specified by:
      getExportActionableDynamicQuery in interface OrganizationLocalService
    • getGroupOrganizations

      public List<Organization> getGroupOrganizations(long groupId)
      Specified by:
      getGroupOrganizations in interface OrganizationLocalService
    • getGroupOrganizations

      public List<Organization> getGroupOrganizations(long groupId, int start, int end)
      Specified by:
      getGroupOrganizations in interface OrganizationLocalService
    • getGroupOrganizations

      public List<Organization> getGroupOrganizations(long groupId, int start, int end, OrderByComparator<Organization> orderByComparator)
      Specified by:
      getGroupOrganizations in interface OrganizationLocalService
    • getGroupOrganizationsCount

      public int getGroupOrganizationsCount(long groupId)
      Specified by:
      getGroupOrganizationsCount in interface OrganizationLocalService
    • getGroupPrimaryKeys

      public long[] getGroupPrimaryKeys(long organizationId)
      Returns the groupIds of the groups associated with the organization.
      Specified by:
      getGroupPrimaryKeys in interface OrganizationLocalService
      Parameters:
      organizationId - the organizationId of the organization
      Returns:
      long[] the groupIds of groups associated with the organization
    • getGroupUserOrganizations

      public List<Organization> getGroupUserOrganizations(long groupId, long userId) throws PortalException
      Specified by:
      getGroupUserOrganizations in interface OrganizationLocalService
      Throws:
      PortalException
    • getIndexableActionableDynamicQuery

      public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
      Specified by:
      getIndexableActionableDynamicQuery in interface OrganizationLocalService
    • getNoAssetOrganizations

      public List<Organization> getNoAssetOrganizations()
      Specified by:
      getNoAssetOrganizations in interface OrganizationLocalService
    • getOrganization

      public Organization getOrganization(long organizationId) throws PortalException
      Returns the organization with the primary key.
      Specified by:
      getOrganization in interface OrganizationLocalService
      Parameters:
      organizationId - the primary key of the organization
      Returns:
      the organization
      Throws:
      PortalException - if a organization with the primary key could not be found
      PortalException
    • getOrganization

      public Organization getOrganization(long companyId, String name) throws PortalException
      Returns the organization with the name.
      Specified by:
      getOrganization in interface OrganizationLocalService
      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 Organization getOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
      Specified by:
      getOrganizationByExternalReferenceCode in interface OrganizationLocalService
      Throws:
      PortalException
    • getOrganizationByUuidAndCompanyId

      public Organization getOrganizationByUuidAndCompanyId(String uuid, long companyId) throws PortalException
      Returns the organization with the matching UUID and company.
      Specified by:
      getOrganizationByUuidAndCompanyId in interface OrganizationLocalService
      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
      PortalException
    • getOrganizationId

      public long getOrganizationId(long companyId, String name)
      Returns the primary key of the organization with the name.
      Specified by:
      getOrganizationId in interface OrganizationLocalService
      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 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.

      Specified by:
      getOrganizations in interface OrganizationLocalService
      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 List<Organization> getOrganizations(long userId, int start, int end, OrderByComparator<Organization> orderByComparator) throws PortalException
      Specified by:
      getOrganizations in interface OrganizationLocalService
      Throws:
      PortalException
    • getOrganizations

      public List<Organization> getOrganizations(long companyId, long parentOrganizationId)
      Returns all the organizations belonging to the parent organization.
      Specified by:
      getOrganizations in interface OrganizationLocalService
      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 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.

      Specified by:
      getOrganizations in interface OrganizationLocalService
      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:
    • getOrganizations

      public List<Organization> getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end)
      Specified by:
      getOrganizations in interface OrganizationLocalService
    • getOrganizations

      public List<Organization> getOrganizations(long companyId, String treePath)
      Specified by:
      getOrganizations in interface OrganizationLocalService
    • getOrganizations

      public List<Organization> getOrganizations(long companyId, String name, int start, int end, OrderByComparator<Organization> orderByComparator)
      Specified by:
      getOrganizations in interface OrganizationLocalService
    • getOrganizations

      public List<Organization> getOrganizations(long[] organizationIds) throws PortalException
      Returns the organizations with the primary keys.
      Specified by:
      getOrganizations in interface OrganizationLocalService
      Parameters:
      organizationIds - the primary keys of the organizations
      Returns:
      the organizations with the primary keys
      Throws:
      PortalException
    • getOrganizationsAndUsers

      public List<Object> getOrganizationsAndUsers(long companyId, long parentOrganizationId, int status, int start, int end, OrderByComparator<?> orderByComparator)
      Returns all the organizations and users belonging to the parent organization.
      Specified by:
      getOrganizationsAndUsers in interface OrganizationLocalService
      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)
      orderByComparator - the comparator to order the organizations and users (optionally null)
      Returns:
      the organizations and users belonging to the parent organization
    • getOrganizationsAndUsersCount

      public int getOrganizationsAndUsersCount(long companyId, long parentOrganizationId, int status)
      Returns the number of organizations and users belonging to the parent organization.
      Specified by:
      getOrganizationsAndUsersCount in interface OrganizationLocalService
      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 int getOrganizationsCount()
      Returns the number of organizations.
      Specified by:
      getOrganizationsCount in interface OrganizationLocalService
      Returns:
      the number of organizations
    • getOrganizationsCount

      public int getOrganizationsCount(long companyId, long parentOrganizationId)
      Returns the number of organizations belonging to the parent organization.
      Specified by:
      getOrganizationsCount in interface OrganizationLocalService
      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 int getOrganizationsCount(long companyId, long parentOrganizationId, String name)
      Specified by:
      getOrganizationsCount in interface OrganizationLocalService
    • getOrganizationsCount

      public int getOrganizationsCount(long companyId, String name)
      Specified by:
      getOrganizationsCount in interface OrganizationLocalService
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface OrganizationLocalService
      Returns:
      the OSGi service identifier
    • getParentOrganizations

      public List<Organization> getParentOrganizations(long organizationId) throws PortalException
      Returns the parent organizations in order by closest ancestor. The list starts with the organization itself.
      Specified by:
      getParentOrganizations in interface OrganizationLocalService
      Parameters:
      organizationId - the primary key of the organization
      Returns:
      the parent organizations in order by closest ancestor
      Throws:
      PortalException
    • getPersistedModel

      public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      getPersistedModel in interface OrganizationLocalService
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
      PortalException
    • getSuborganizations

      public List<Organization> getSuborganizations(List<Organization> organizations)
      Returns the suborganizations of the organizations.
      Specified by:
      getSuborganizations in interface OrganizationLocalService
      Parameters:
      organizations - the organizations from which to get suborganizations
      Returns:
      the suborganizations of the organizations
    • getSuborganizations

      public List<Organization> getSuborganizations(long companyId, long organizationId)
      Returns the suborganizations of the organization.
      Specified by:
      getSuborganizations in interface OrganizationLocalService
      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 int getSuborganizationsCount(long companyId, long organizationId)
      Returns the count of suborganizations of the organization.
      Specified by:
      getSuborganizationsCount in interface OrganizationLocalService
      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 List<Organization> getSubsetOrganizations(List<Organization> allOrganizations, List<Organization> availableOrganizations)
      Returns the intersection of allOrganizations and availableOrganizations.
      Specified by:
      getSubsetOrganizations in interface OrganizationLocalService
      Parameters:
      allOrganizations - the organizations to check for availability
      availableOrganizations - the available organizations
      Returns:
      the intersection of allOrganizations and availableOrganizations
    • getTypes

      public String[] getTypes()
      Specified by:
      getTypes in interface OrganizationLocalService
    • getUserOrganizationIds

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

      Specified by:
      getUserOrganizationIds in interface OrganizationLocalService
      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 List<Organization> getUserOrganizations(long userId)
      Specified by:
      getUserOrganizations in interface OrganizationLocalService
    • getUserOrganizations

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

      Specified by:
      getUserOrganizations in interface OrganizationLocalService
      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 List<Organization> getUserOrganizations(long userId, int start, int end)
      Specified by:
      getUserOrganizations in interface OrganizationLocalService
    • getUserOrganizations

      public List<Organization> getUserOrganizations(long userId, int start, int end, OrderByComparator<Organization> orderByComparator)
      Specified by:
      getUserOrganizations in interface OrganizationLocalService
    • getUserOrganizationsCount

      public int getUserOrganizationsCount(long userId)
      Specified by:
      getUserOrganizationsCount in interface OrganizationLocalService
    • getUserPrimaryKeys

      public long[] getUserPrimaryKeys(long organizationId)
      Returns the userIds of the users associated with the organization.
      Specified by:
      getUserPrimaryKeys in interface OrganizationLocalService
      Parameters:
      organizationId - the organizationId of the organization
      Returns:
      long[] the userIds of users associated with the organization
    • hasGroupOrganization

      public boolean hasGroupOrganization(long groupId, long organizationId)
      Specified by:
      hasGroupOrganization in interface OrganizationLocalService
    • hasGroupOrganizations

      public boolean hasGroupOrganizations(long groupId)
      Specified by:
      hasGroupOrganizations in interface OrganizationLocalService
    • hasPasswordPolicyOrganization

      public boolean hasPasswordPolicyOrganization(long passwordPolicyId, long organizationId)
      Returns true if the password policy has been assigned to the organization.
      Specified by:
      hasPasswordPolicyOrganization in interface OrganizationLocalService
      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 boolean hasUserOrganization(long userId, long organizationId)
      Specified by:
      hasUserOrganization in interface OrganizationLocalService
    • hasUserOrganization

      public 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.
      Specified by:
      hasUserOrganization in interface OrganizationLocalService
      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:
    • hasUserOrganizations

      public boolean hasUserOrganizations(long userId)
      Specified by:
      hasUserOrganizations in interface OrganizationLocalService
    • isCountryEnabled

      public boolean isCountryEnabled(String type)
      Specified by:
      isCountryEnabled in interface OrganizationLocalService
    • isCountryRequired

      public boolean isCountryRequired(String type)
      Specified by:
      isCountryRequired in interface OrganizationLocalService
    • isRootable

      public boolean isRootable(String type)
      Specified by:
      isRootable in interface OrganizationLocalService
    • rebuildTree

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

      Specified by:
      rebuildTree in interface OrganizationLocalService
      Parameters:
      companyId - the primary key of the organization's company
      Throws:
      PortalException
    • search

      public Hits search(long companyId, long parentOrganizationId, String keywords, LinkedHashMap<String,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.

      Specified by:
      search in interface OrganizationLocalService
      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).
      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
    • search

      public List<Organization> search(long companyId, long parentOrganizationId, String keywords, String type, Long regionId, Long countryId, LinkedHashMap<String,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.

      Specified by:
      search in interface OrganizationLocalService
      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:
    • search

      public List<Organization> search(long companyId, long parentOrganizationId, String keywords, String type, Long regionId, Long countryId, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Organization> orderByComparator)
      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.

      Specified by:
      search in interface OrganizationLocalService
      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)
      orderByComparator - the comparator to order the organizations (optionally null)
      Returns:
      the matching organizations ordered by comparator orderByComparator
      See Also:
    • search

      public List<Organization> search(long companyId, long parentOrganizationId, String name, String type, String street, String city, String zip, Long regionId, Long countryId, LinkedHashMap<String,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.

      Specified by:
      search in interface OrganizationLocalService
      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:
    • search

      public List<Organization> search(long companyId, long parentOrganizationId, String name, String type, String street, String city, String zip, Long regionId, Long countryId, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Organization> orderByComparator)
      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.

      Specified by:
      search in interface OrganizationLocalService
      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)
      orderByComparator - the comparator to order the organizations (optionally null)
      Returns:
      the matching organizations ordered by comparator orderByComparator
      See Also:
    • search

      public Hits search(long companyId, long parentOrganizationId, String name, String type, String street, String city, String zip, String region, String country, LinkedHashMap<String,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.

      Specified by:
      search in interface OrganizationLocalService
      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).
      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
    • searchCount

      public int searchCount(long companyId, long parentOrganizationId, String keywords, String type, Long regionId, Long countryId, LinkedHashMap<String,Object> params)
      Returns the number of organizations that match the keywords, type, region, and country.
      Specified by:
      searchCount in interface OrganizationLocalService
      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:
    • searchCount

      public int searchCount(long companyId, long parentOrganizationId, String name, String type, String street, String city, String zip, Long regionId, Long countryId, LinkedHashMap<String,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.
      Specified by:
      searchCount in interface OrganizationLocalService
      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:
    • searchOrganizations

      public BaseModelSearchResult<Organization> searchOrganizations(long companyId, long parentOrganizationId, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort) throws PortalException
      Specified by:
      searchOrganizations in interface OrganizationLocalService
      Throws:
      PortalException
    • searchOrganizations

      public BaseModelSearchResult<Organization> searchOrganizations(long companyId, long parentOrganizationId, String name, String type, String street, String city, String zip, String region, String country, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort) throws PortalException
      Specified by:
      searchOrganizations in interface OrganizationLocalService
      Throws:
      PortalException
    • searchOrganizationsAndUsers

      public Hits searchOrganizationsAndUsers(long companyId, long parentOrganizationId, String keywords, int status, LinkedHashMap<String,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.
      Specified by:
      searchOrganizationsAndUsers in interface OrganizationLocalService
      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 int searchOrganizationsAndUsersCount(long companyId, long parentOrganizationId, String keywords, int status, LinkedHashMap<String,Object> params) throws PortalException
      Returns the number of organizations and users that match the keywords specified for them and belong to the parent organization.
      Specified by:
      searchOrganizationsAndUsersCount in interface OrganizationLocalService
      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 void setGroupOrganizations(long groupId, long[] organizationIds)
      Specified by:
      setGroupOrganizations in interface OrganizationLocalService
    • setUserOrganizations

      public void setUserOrganizations(long userId, long[] organizationIds)
      Specified by:
      setUserOrganizations in interface OrganizationLocalService
    • unsetGroupOrganizations

      public void unsetGroupOrganizations(long groupId, long[] organizationIds)
      Removes the organizations from the group.
      Specified by:
      unsetGroupOrganizations in interface OrganizationLocalService
      Parameters:
      groupId - the primary key of the group
      organizationIds - the primary keys of the organizations
    • unsetPasswordPolicyOrganizations

      public void unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds)
      Removes the organizations from the password policy.
      Specified by:
      unsetPasswordPolicyOrganizations in interface OrganizationLocalService
      Parameters:
      passwordPolicyId - the primary key of the password policy
      organizationIds - the primary keys of the organizations
    • updateAsset

      public void updateAsset(long userId, Organization organization, long[] assetCategoryIds, 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.
      Specified by:
      updateAsset in interface OrganizationLocalService
      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
    • updateLogo

      public Organization updateLogo(long organizationId, byte[] logoBytes) throws PortalException
      Specified by:
      updateLogo in interface OrganizationLocalService
      Throws:
      PortalException
    • updateOrganization

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

      Specified by:
      updateOrganization in interface OrganizationLocalService
      Parameters:
      organization - the organization
      Returns:
      the organization that was updated
    • updateOrganization

      public Organization updateOrganization(String externalReferenceCode, long companyId, long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean hasLogo, byte[] logoBytes, boolean site, ServiceContext serviceContext) throws PortalException
      Updates the organization.
      Specified by:
      updateOrganization in interface OrganizationLocalService
      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
      statusListTypeId - the organization's workflow status
      comments - the comments about the organization
      hasLogo - if the organization has a custom 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
    • getBasePersistence

      public BasePersistence<?> getBasePersistence()
      Specified by:
      getBasePersistence in interface PersistedModelLocalService
    • getCTPersistence

      public CTPersistence<Organization> getCTPersistence()
      Specified by:
      getCTPersistence in interface CTService<Organization>
      Specified by:
      getCTPersistence in interface OrganizationLocalService
    • getModelClass

      public Class<Organization> getModelClass()
      Specified by:
      getModelClass in interface CTService<Organization>
      Specified by:
      getModelClass in interface OrganizationLocalService
    • updateWithUnsafeFunction

      public <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Organization>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface CTService<Organization>
      Specified by:
      updateWithUnsafeFunction in interface OrganizationLocalService
      Throws:
      E extends Throwable
    • getWrappedService

      public OrganizationLocalService getWrappedService()
      Specified by:
      getWrappedService in interface ServiceWrapper<OrganizationLocalService>
    • setWrappedService

      public void setWrappedService(OrganizationLocalService organizationLocalService)
      Specified by:
      setWrappedService in interface ServiceWrapper<OrganizationLocalService>