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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addGroupOrganizations
(long groupId, long[] organizationIds) Adds the organizations to the group.addOrganization
(String externalReferenceCode, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, ServiceContext serviceContext) Adds an 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) Adds an organization with additional parameters.addOrganizationUserByEmailAddress
(String emailAddress, long organizationId, ServiceContext serviceContext) 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) 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) fetchOrganization
(long organizationId) Returns the organization with the primary key.fetchOrganizationByExternalReferenceCode
(String externalReferenceCode, long companyId) getGtOrganizations
(long gtOrganizationId, long companyId, long parentOrganizationId, int size) getOrganization
(long organizationId) Returns the organization with the primary key.getOrganizationByExternalReferenceCode
(String externalReferenceCode, long companyId) long
getOrganizationId
(long companyId, String name) Returns the primary key of the organization with the name.getOrganizations
(long companyId, long parentOrganizationId) Returns all the organizations belonging to the parent organization.getOrganizations
(long companyId, long parentOrganizationId, int start, int end) Returns a range of all the organizations belonging to the parent organization.getOrganizations
(long companyId, long parentOrganizationId, int start, int end, OrderByComparator<Organization> orderByComparator) getOrganizations
(long companyId, long parentOrganizationId, String name, int start, int end) getOrganizations
(long companyId, long parentOrganizationId, String name, int start, int end, OrderByComparator<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) Returns the OSGi service identifier.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
setWrappedService
(OrganizationService organizationService) 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.updateLogo
(long organizationId, byte[] logoBytes) 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) Updates the organization with additional parameters.updateOrganization
(String externalReferenceCode, long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusListTypeId, String comments, boolean site, ServiceContext serviceContext) Updates the organization.
-
Constructor Details
-
OrganizationServiceWrapper
public OrganizationServiceWrapper() -
OrganizationServiceWrapper
-
-
Method Details
-
addGroupOrganizations
Adds the organizations to the group.- Specified by:
addGroupOrganizations
in interfaceOrganizationService
- Parameters:
groupId
- the primary key of the grouporganizationIds
- 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 interfaceOrganizationService
- Parameters:
parentOrganizationId
- the primary key of the organization's parent organizationname
- the organization's nametype
- the organization's typeregionId
- the primary key of the organization's regioncountryId
- the primary key of the organization's countrystatusListTypeId
- the organization's workflow statuscomments
- the comments about the organizationsite
- whether the organization is to be associated with a main siteaddresses
- the organization's addressesemailAddresses
- the organization's email addressesorgLabors
- the organization's hours of operationphones
- the organization's phone numberswebsites
- the organization's websitesserviceContext
- the service context to be applied (optionallynull
). 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 interfaceOrganizationService
- Parameters:
parentOrganizationId
- the primary key of the organization's parent organizationname
- the organization's nametype
- the organization's typeregionId
- the primary key of the organization's regioncountryId
- the primary key of the organization's countrystatusListTypeId
- the organization's workflow statuscomments
- the comments about the organizationsite
- whether the organization is to be associated with a main siteserviceContext
- the service context to be applied (optionallynull
). 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 interfaceOrganizationService
- 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 interfaceOrganizationService
- 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 interfaceOrganizationService
- Parameters:
passwordPolicyId
- the primary key of the password policyorganizationIds
- the primary keys of the organizations- Throws:
PortalException
-
addUserOrganizationByEmailAddress
public void addUserOrganizationByEmailAddress(String emailAddress, long organizationId) throws PortalException - Specified by:
addUserOrganizationByEmailAddress
in interfaceOrganizationService
- Throws:
PortalException
-
deleteLogo
Deletes the organization's logo.- Specified by:
deleteLogo
in interfaceOrganizationService
- Parameters:
organizationId
- the primary key of the organization- Throws:
PortalException
-
deleteOrganization
Deletes the organization. The organization's associated resources and assets are also deleted.- Specified by:
deleteOrganization
in interfaceOrganizationService
- Parameters:
organizationId
- the primary key of the organization- Throws:
PortalException
-
deleteUserOrganizationByEmailAddress
public void deleteUserOrganizationByEmailAddress(String emailAddress, long organizationId) throws PortalException - Specified by:
deleteUserOrganizationByEmailAddress
in interfaceOrganizationService
- Throws:
PortalException
-
fetchOrganization
Returns the organization with the primary key.- Specified by:
fetchOrganization
in interfaceOrganizationService
- 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 interfaceOrganizationService
- Throws:
PortalException
-
getGtOrganizations
public List<Organization> getGtOrganizations(long gtOrganizationId, long companyId, long parentOrganizationId, int size) - Specified by:
getGtOrganizations
in interfaceOrganizationService
-
getOrganization
Returns the organization with the primary key.- Specified by:
getOrganization
in interfaceOrganizationService
- 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 interfaceOrganizationService
- Throws:
PortalException
-
getOrganizationId
Returns the primary key of the organization with the name.- Specified by:
getOrganizationId
in interfaceOrganizationService
- Parameters:
companyId
- the primary key of the organization's companyname
- 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
Returns all the organizations belonging to the parent organization.- Specified by:
getOrganizations
in interfaceOrganizationService
- Parameters:
companyId
- the primary key of the organizations' companyparentOrganizationId
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Specified by:
getOrganizations
in interfaceOrganizationService
- Parameters:
companyId
- the primary key of the organizations' companyparentOrganizationId
- the primary key of the organizations' parent organizationstart
- the lower bound of the range of organizations to returnend
- 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 interfaceOrganizationService
-
getOrganizations
public List<Organization> getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end) - Specified by:
getOrganizations
in interfaceOrganizationService
-
getOrganizations
public List<Organization> getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end, OrderByComparator<Organization> orderByComparator) - Specified by:
getOrganizations
in interfaceOrganizationService
-
getOrganizationsCount
public int getOrganizationsCount(long companyId, long parentOrganizationId) Returns the number of organizations belonging to the parent organization.- Specified by:
getOrganizationsCount
in interfaceOrganizationService
- Parameters:
companyId
- the primary key of the organizations' companyparentOrganizationId
- 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 interfaceOrganizationService
- Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceOrganizationService
- Returns:
- the OSGi service identifier
-
getUserOrganizations
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 interfaceOrganizationService
- Parameters:
userId
- the primary key of the user- Returns:
- the organizations with which the user is explicitly associated
- Throws:
PortalException
-
setGroupOrganizations
Sets the organizations in the group, removing and adding organizations to the group as necessary.- Specified by:
setGroupOrganizations
in interfaceOrganizationService
- Parameters:
groupId
- the primary key of the grouporganizationIds
- the primary keys of the organizations- Throws:
PortalException
-
unsetGroupOrganizations
Removes the organizations from the group.- Specified by:
unsetGroupOrganizations
in interfaceOrganizationService
- Parameters:
groupId
- the primary key of the grouporganizationIds
- 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 interfaceOrganizationService
- Parameters:
passwordPolicyId
- the primary key of the password policyorganizationIds
- the primary keys of the organizations- Throws:
PortalException
-
updateLogo
- Specified by:
updateLogo
in interfaceOrganizationService
- 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 interfaceOrganizationService
- Parameters:
organizationId
- the primary key of the organizationparentOrganizationId
- the primary key of the organization's parent organizationname
- the organization's nametype
- the organization's typeregionId
- the primary key of the organization's regioncountryId
- the primary key of the organization's countrystatusListTypeId
- the organization's workflow statuscomments
- the comments about the organizationhasLogo
- if the organization has a custom logologoBytes
- the new logo image datasite
- whether the organization is to be associated with a main siteaddresses
- the organization's addressesemailAddresses
- the organization's email addressesorgLabors
- the organization's hours of operationphones
- the organization's phone numberswebsites
- the organization's websitesserviceContext
- the service context to be applied (optionallynull
). 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 interfaceOrganizationService
- Parameters:
organizationId
- the primary key of the organizationparentOrganizationId
- the primary key of the organization's parent organizationname
- the organization's nametype
- the organization's typeregionId
- the primary key of the organization's regioncountryId
- the primary key of the organization's countrystatusListTypeId
- the organization's workflow statuscomments
- the comments about the organizationsite
- whether the organization is to be associated with a main siteserviceContext
- the service context to be applied (optionallynull
). 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
- Specified by:
getWrappedService
in interfaceServiceWrapper<OrganizationService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<OrganizationService>
-