Class OrganizationServiceWrapper

Object
com.liferay.portal.kernel.service.OrganizationServiceWrapper
All Implemented Interfaces:
BaseService, OrganizationService, ServiceWrapper<OrganizationService>

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

    • OrganizationServiceWrapper

      public OrganizationServiceWrapper()
    • OrganizationServiceWrapper

      public OrganizationServiceWrapper(OrganizationService organizationService)
  • Method Details

    • addGroupOrganizations

      public void addGroupOrganizations(long groupId, long[] organizationIds) throws PortalException
      Adds the organizations to the group.
      Specified by:
      addGroupOrganizations in interface OrganizationService
      Parameters:
      groupId - the primary key of the group
      organizationIds - the primary keys of the organizations
      Throws:
      PortalException
    • addOrganization

      public Organization addOrganization(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, List<Address> addresses, List<EmailAddress> emailAddresses, List<OrgLabor> orgLabors, List<Phone> phones, List<Website> websites, ServiceContext serviceContext) throws 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.

      Specified by:
      addOrganization in interface OrganizationService
      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:
      PortalException
    • addOrganization

      public Organization addOrganization(String externalReferenceCode, 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.

      Specified by:
      addOrganization in interface OrganizationService
      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:
      PortalException
    • addOrganizationUserByEmailAddress

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

      public 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<Address> addresses, List<EmailAddress> emailAddresses, List<OrgLabor> orgLabors, List<Phone> phones, List<Website> websites, ServiceContext serviceContext) throws PortalException
      Specified by:
      addOrUpdateOrganization in interface OrganizationService
      Throws:
      PortalException
    • addPasswordPolicyOrganizations

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

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

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

      public void deleteOrganization(long organizationId) throws PortalException
      Deletes the organization. The organization's associated resources and assets are also deleted.
      Specified by:
      deleteOrganization in interface OrganizationService
      Parameters:
      organizationId - the primary key of the organization
      Throws:
      PortalException
    • deleteUserOrganizationByEmailAddress

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

      public Organization fetchOrganization(long organizationId) throws PortalException
      Returns the organization with the primary key.
      Specified by:
      fetchOrganization in interface OrganizationService
      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:
      PortalException
    • fetchOrganizationByExternalReferenceCode

      public Organization fetchOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
      Specified by:
      fetchOrganizationByExternalReferenceCode in interface OrganizationService
      Throws:
      PortalException
    • getGtOrganizations

      public List<Organization> getGtOrganizations(long gtOrganizationId, long companyId, long parentOrganizationId, int size)
      Specified by:
      getGtOrganizations in interface OrganizationService
    • getOrganization

      public Organization getOrganization(long organizationId) throws PortalException
      Returns the organization with the primary key.
      Specified by:
      getOrganization in interface OrganizationService
      Parameters:
      organizationId - the primary key of the organization
      Returns:
      the organization with the primary key
      Throws:
      PortalException
    • getOrganizationByExternalReferenceCode

      public Organization getOrganizationByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
      Specified by:
      getOrganizationByExternalReferenceCode in interface OrganizationService
      Throws:
      PortalException
    • getOrganizationId

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

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

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

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

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

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

      public List<Organization> getUserOrganizations(long userId) throws 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.

      Specified by:
      getUserOrganizations in interface OrganizationService
      Parameters:
      userId - the primary key of the user
      Returns:
      the organizations with which the user is explicitly associated
      Throws:
      PortalException
    • setGroupOrganizations

      public void setGroupOrganizations(long groupId, long[] organizationIds) throws PortalException
      Sets the organizations in the group, removing and adding organizations to the group as necessary.
      Specified by:
      setGroupOrganizations in interface OrganizationService
      Parameters:
      groupId - the primary key of the group
      organizationIds - the primary keys of the organizations
      Throws:
      PortalException
    • unsetGroupOrganizations

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

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

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

      public 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<Address> addresses, List<EmailAddress> emailAddresses, List<OrgLabor> orgLabors, List<Phone> phones, List<Website> websites, ServiceContext serviceContext) throws PortalException
      Updates the organization with additional parameters.
      Specified by:
      updateOrganization in interface OrganizationService
      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:
      PortalException
    • updateOrganization

      public Organization updateOrganization(String externalReferenceCode, long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, ServiceContext serviceContext) throws PortalException
      Updates the organization.
      Specified by:
      updateOrganization in interface OrganizationService
      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:
      PortalException
    • getWrappedService

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

      public void setWrappedService(OrganizationService organizationService)
      Specified by:
      setWrappedService in interface ServiceWrapper<OrganizationService>