Class OrganizationServiceImpl

Object
com.liferay.portal.kernel.service.BaseServiceImpl
com.liferay.portal.service.base.OrganizationServiceBaseImpl
com.liferay.portal.service.impl.OrganizationServiceImpl
All Implemented Interfaces:
com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.OrganizationService

public class OrganizationServiceImpl extends OrganizationServiceBaseImpl
Provides the remote service for accessing, adding, deleting, and updating organizations. Its methods include permission checks.
Author:
Brian Wing Shun Chan, Jorge Ferrer, Julio Camarero
  • Field Summary

    Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

    ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addGroupOrganizations(long groupId, long[] organizationIds)
    Adds the organizations to the group.
    com.liferay.portal.kernel.model.Organization
    addOrganization(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Adds an organization.
    com.liferay.portal.kernel.model.Organization
    addOrganization(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, List<com.liferay.portal.kernel.model.Address> addresses, List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, List<com.liferay.portal.kernel.model.Phone> phones, List<com.liferay.portal.kernel.model.Website> websites, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Adds an organization with additional parameters.
    com.liferay.portal.kernel.model.User
    addOrganizationUserByEmailAddress(String emailAddress, long organizationId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    com.liferay.portal.kernel.model.Organization
    addOrUpdateOrganization(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean hasLogo, byte[] logoBytes, boolean site, List<com.liferay.portal.kernel.model.Address> addresses, List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, List<com.liferay.portal.kernel.model.Phone> phones, List<com.liferay.portal.kernel.model.Website> websites, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    void
    addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds)
    Assigns the password policy to the organizations, removing any other currently assigned password policies.
    void
    addUserOrganizationByEmailAddress(String emailAddress, long organizationId)
     
    void
    deleteLogo(long organizationId)
    Deletes the organization's logo.
    void
    deleteOrganization(long organizationId)
    Deletes the organization.
    void
    deleteUserOrganizationByEmailAddress(String emailAddress, long organizationId)
     
    com.liferay.portal.kernel.model.Organization
    fetchOrganization(long organizationId)
    Returns the organization with the primary key.
    com.liferay.portal.kernel.model.Organization
    fetchOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId)
     
    List<com.liferay.portal.kernel.model.Organization>
    getGtOrganizations(long gtOrganizationId, long companyId, long parentOrganizationId, int size)
     
    com.liferay.portal.kernel.model.Organization
    getOrganization(long organizationId)
    Returns the organization with the primary key.
    com.liferay.portal.kernel.model.Organization
    getOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId)
     
    long
    getOrganizationId(long companyId, String name)
    Returns the primary key of the organization with the name.
    List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(long companyId, long parentOrganizationId)
    Returns all the organizations belonging to the parent organization.
    List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(long companyId, long parentOrganizationId, int start, int end)
    Returns a range of all the organizations belonging to the parent organization.
    List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(long companyId, long parentOrganizationId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Organization> orderByComparator)
     
    List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end)
     
    List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Organization> orderByComparator)
     
    int
    getOrganizationsCount(long companyId, long parentOrganizationId)
    Returns the number of organizations belonging to the parent organization.
    int
    getOrganizationsCount(long companyId, long parentOrganizationId, String name)
     
    List<com.liferay.portal.kernel.model.Organization>
    getUserOrganizations(long userId)
    Returns all the organizations with which the user is explicitly associated.
    void
    setGroupOrganizations(long groupId, long[] organizationIds)
    Sets the organizations in the group, removing and adding organizations to the group as necessary.
    void
    unsetGroupOrganizations(long groupId, long[] organizationIds)
    Removes the organizations from the group.
    void
    unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds)
    Removes the organizations from the password policy.
    com.liferay.portal.kernel.model.Organization
    updateLogo(long organizationId, byte[] logoBytes)
     
    com.liferay.portal.kernel.model.Organization
    updateOrganization(String externalReferenceCode, long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean hasLogo, byte[] logoBytes, boolean site, List<com.liferay.portal.kernel.model.Address> addresses, List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, List<com.liferay.portal.kernel.model.Phone> phones, List<com.liferay.portal.kernel.model.Website> websites, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the organization with additional parameters.
    com.liferay.portal.kernel.model.Organization
    updateOrganization(String externalReferenceCode, long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the organization.

    Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

    getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • OrganizationServiceImpl

      public OrganizationServiceImpl()
  • Method Details

    • addGroupOrganizations

      public void addGroupOrganizations(long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Adds the organizations to the group.
      Parameters:
      groupId - the primary key of the group
      organizationIds - the primary keys of the organizations
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrganization

      public com.liferay.portal.kernel.model.Organization addOrganization(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, List<com.liferay.portal.kernel.model.Address> addresses, List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, List<com.liferay.portal.kernel.model.Phone> phones, List<com.liferay.portal.kernel.model.Website> websites, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Adds an organization with additional parameters.

      This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.

      Parameters:
      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
      addresses - the organization's addresses
      emailAddresses - the organization's email addresses
      orgLabors - the organization's hours of operation
      phones - the organization's phone numbers
      websites - the organization's websites
      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:
      com.liferay.portal.kernel.exception.PortalException
    • addOrganization

      public com.liferay.portal.kernel.model.Organization addOrganization(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Adds an organization.

      This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.

      Parameters:
      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:
      com.liferay.portal.kernel.exception.PortalException
    • addOrganizationUserByEmailAddress

      public com.liferay.portal.kernel.model.User addOrganizationUserByEmailAddress(String emailAddress, long organizationId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateOrganization

      public com.liferay.portal.kernel.model.Organization addOrUpdateOrganization(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean hasLogo, byte[] logoBytes, boolean site, List<com.liferay.portal.kernel.model.Address> addresses, List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, List<com.liferay.portal.kernel.model.Phone> phones, List<com.liferay.portal.kernel.model.Website> websites, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addPasswordPolicyOrganizations

      public void addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      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
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addUserOrganizationByEmailAddress

      public void addUserOrganizationByEmailAddress(String emailAddress, long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteLogo

      public void deleteLogo(long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the organization's logo.
      Parameters:
      organizationId - the primary key of the organization
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteOrganization

      public void deleteOrganization(long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the organization. The organization's associated resources and assets are also deleted.
      Parameters:
      organizationId - the primary key of the organization
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteUserOrganizationByEmailAddress

      public void deleteUserOrganizationByEmailAddress(String emailAddress, long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchOrganization

      public com.liferay.portal.kernel.model.Organization fetchOrganization(long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the organization with the primary key.
      Parameters:
      organizationId - the primary key of the organization
      Returns:
      the organization with the primary key, or null if an organization with the primary key could not be found or if the user did not have permission to view the organization
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchOrganizationByExternalReferenceCode

      public com.liferay.portal.kernel.model.Organization fetchOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGtOrganizations

      public List<com.liferay.portal.kernel.model.Organization> getGtOrganizations(long gtOrganizationId, long companyId, long parentOrganizationId, int size)
    • getOrganization

      public com.liferay.portal.kernel.model.Organization getOrganization(long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the organization with the primary key.
      Parameters:
      organizationId - the primary key of the organization
      Returns:
      the organization with the primary key
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOrganizationByExternalReferenceCode

      public com.liferay.portal.kernel.model.Organization getOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOrganizationId

      public long getOrganizationId(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException
      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
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOrganizations

      public List<com.liferay.portal.kernel.model.Organization> getOrganizations(long companyId, long parentOrganizationId)
      Returns all the organizations belonging to the parent organization.
      Parameters:
      companyId - the primary key of the organizations' company
      parentOrganizationId - the primary key of the organizations' parent organization
      Returns:
      the organizations belonging to the parent organization
    • getOrganizations

      public List<com.liferay.portal.kernel.model.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 organizations' company
      parentOrganizationId - the primary key of the organizations' 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
    • getOrganizations

      public List<com.liferay.portal.kernel.model.Organization> getOrganizations(long companyId, long parentOrganizationId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Organization> orderByComparator)
    • getOrganizations

      public List<com.liferay.portal.kernel.model.Organization> getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end)
    • getOrganizations

      public List<com.liferay.portal.kernel.model.Organization> getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Organization> orderByComparator)
    • getOrganizationsCount

      public int getOrganizationsCount(long companyId, long parentOrganizationId)
      Returns the number of organizations belonging to the parent organization.
      Parameters:
      companyId - the primary key of the organizations' company
      parentOrganizationId - the primary key of the organizations' parent organization
      Returns:
      the number of organizations belonging to the parent organization
    • getOrganizationsCount

      public int getOrganizationsCount(long companyId, long parentOrganizationId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserOrganizations

      public List<com.liferay.portal.kernel.model.Organization> getUserOrganizations(long userId) throws com.liferay.portal.kernel.exception.PortalException
      Returns all the organizations with which the user is explicitly associated.

      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
      Returns:
      the organizations with which the user is explicitly associated
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setGroupOrganizations

      public void setGroupOrganizations(long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Sets the organizations in the group, removing and adding organizations to the group as necessary.
      Parameters:
      groupId - the primary key of the group
      organizationIds - the primary keys of the organizations
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsetGroupOrganizations

      public void unsetGroupOrganizations(long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Removes the organizations from the group.
      Parameters:
      groupId - the primary key of the group
      organizationIds - the primary keys of the organizations
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsetPasswordPolicyOrganizations

      public void unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Removes the organizations from the password policy.
      Parameters:
      passwordPolicyId - the primary key of the password policy
      organizationIds - the primary keys of the organizations
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLogo

      public com.liferay.portal.kernel.model.Organization updateLogo(long organizationId, byte[] logoBytes) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateOrganization

      public com.liferay.portal.kernel.model.Organization updateOrganization(String externalReferenceCode, long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean hasLogo, byte[] logoBytes, boolean site, List<com.liferay.portal.kernel.model.Address> addresses, List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, List<com.liferay.portal.kernel.model.Phone> phones, List<com.liferay.portal.kernel.model.Website> websites, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Updates the organization with additional parameters.
      Parameters:
      organizationId - the primary key 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
      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
      addresses - the organization's addresses
      emailAddresses - the organization's email addresses
      orgLabors - the organization's hours of operation
      phones - the organization's phone numbers
      websites - the organization's websites
      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:
      com.liferay.portal.kernel.exception.PortalException
    • updateOrganization

      public com.liferay.portal.kernel.model.Organization updateOrganization(String externalReferenceCode, long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Updates the organization.
      Parameters:
      organizationId - the primary key 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 and asset tag names for the organization, and merge expando bridge attributes for the organization.
      Returns:
      the organization
      Throws:
      com.liferay.portal.kernel.exception.PortalException