Class OrganizationServiceHttp

Object
com.liferay.portal.service.http.OrganizationServiceHttp

public class OrganizationServiceHttp extends Object
Provides the HTTP utility for the OrganizationServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

Author:
Brian Wing Shun Chan
{$generated.description}
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addGroupOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] organizationIds)
     
    static com.liferay.portal.kernel.model.Organization
    addOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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)
     
    static com.liferay.portal.kernel.model.Organization
    addOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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)
     
    static com.liferay.portal.kernel.model.User
    addOrganizationUserByEmailAddress(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String emailAddress, long organizationId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static com.liferay.portal.kernel.model.Organization
    addOrUpdateOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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)
     
    static void
    addPasswordPolicyOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long passwordPolicyId, long[] organizationIds)
     
    static void
    addUserOrganizationByEmailAddress(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String emailAddress, long organizationId)
     
    static void
    deleteLogo(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId)
     
    static void
    deleteOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId)
     
    static void
    deleteUserOrganizationByEmailAddress(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String emailAddress, long organizationId)
     
    static com.liferay.portal.kernel.model.Organization
    fetchOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId)
     
    static com.liferay.portal.kernel.model.Organization
    fetchOrganizationByExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, long companyId)
     
    static List<com.liferay.portal.kernel.model.Organization>
    getGtOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long gtOrganizationId, long companyId, long parentOrganizationId, int size)
     
    static com.liferay.portal.kernel.model.Organization
    getOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId)
     
    static com.liferay.portal.kernel.model.Organization
    getOrganizationByExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, long companyId)
     
    static long
    getOrganizationId(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name)
     
    static List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId)
     
    static List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId, int start, int end)
     
    static List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Organization> orderByComparator)
     
    static List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId, String name, int start, int end)
     
    static List<com.liferay.portal.kernel.model.Organization>
    getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Organization> orderByComparator)
     
    static int
    getOrganizationsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId)
     
    static int
    getOrganizationsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId, String name)
     
    static List<com.liferay.portal.kernel.model.Organization>
    getUserOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId)
     
    static void
    setGroupOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] organizationIds)
     
    static void
    unsetGroupOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] organizationIds)
     
    static void
    unsetPasswordPolicyOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long passwordPolicyId, long[] organizationIds)
     
    static com.liferay.portal.kernel.model.Organization
    updateLogo(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId, byte[] logoBytes)
     
    static com.liferay.portal.kernel.model.Organization
    updateOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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)
     
    static com.liferay.portal.kernel.model.Organization
    updateOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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)
     

    Methods inherited from class java.lang.Object

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

    • OrganizationServiceHttp

      public OrganizationServiceHttp()
  • Method Details

    • addGroupOrganizations

      public static void addGroupOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrganization

      public static com.liferay.portal.kernel.model.Organization addOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrganization

      public static com.liferay.portal.kernel.model.Organization addOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrganizationUserByEmailAddress

      public static com.liferay.portal.kernel.model.User addOrganizationUserByEmailAddress(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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 static com.liferay.portal.kernel.model.Organization addOrUpdateOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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 static void addPasswordPolicyOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long passwordPolicyId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addUserOrganizationByEmailAddress

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

      public static void deleteLogo(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteOrganization

      public static void deleteOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteUserOrganizationByEmailAddress

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

      public static com.liferay.portal.kernel.model.Organization fetchOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchOrganizationByExternalReferenceCode

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

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

      public static com.liferay.portal.kernel.model.Organization getOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long organizationId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOrganizationByExternalReferenceCode

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

      public static long getOrganizationId(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOrganizations

      public static List<com.liferay.portal.kernel.model.Organization> getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId)
    • getOrganizations

      public static List<com.liferay.portal.kernel.model.Organization> getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId, int start, int end)
    • getOrganizations

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

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

      public static List<com.liferay.portal.kernel.model.Organization> getOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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 static int getOrganizationsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentOrganizationId)
    • getOrganizationsCount

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

      public static List<com.liferay.portal.kernel.model.Organization> getUserOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setGroupOrganizations

      public static void setGroupOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsetGroupOrganizations

      public static void unsetGroupOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsetPasswordPolicyOrganizations

      public static void unsetPasswordPolicyOrganizations(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long passwordPolicyId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLogo

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

      public static com.liferay.portal.kernel.model.Organization updateOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateOrganization

      public static com.liferay.portal.kernel.model.Organization updateOrganization(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, 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
      Throws:
      com.liferay.portal.kernel.exception.PortalException