com.liferay.portal.service.impl

Class OrganizationServiceImpl

java.lang.Object

com.liferay.portal.service.BaseServiceImpl

com.liferay.portal.service.base.OrganizationServiceBaseImpl

com.liferay.portal.service.impl.OrganizationServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.bean.IdentifiableBean, com.liferay.portal.service.BaseService, com.liferay.portal.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.service.base.OrganizationServiceBaseImpl

accountLocalService, accountPersistence, accountService, addressLocalService, addressPersistence, addressService, assetCategoryFinder, assetCategoryLocalService, assetCategoryPersistence, assetCategoryService, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetEntryService, assetTagFinder, assetTagLocalService, assetTagPersistence, assetTagService, backgroundTaskLocalService, backgroundTaskPersistence, backgroundTaskService, browserTrackerLocalService, browserTrackerPersistence, classNameLocalService, classNamePersistence, classNameService, clusterGroupLocalService, clusterGroupPersistence, cmisRepositoryLocalService, companyLocalService, companyPersistence, companyService, contactLocalService, contactPersistence, contactService, counterLocalService, countryPersistence, countryService, emailAddressLocalService, emailAddressPersistence, emailAddressService, expandoRowLocalService, expandoRowPersistence, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, layoutBranchLocalService, layoutBranchPersistence, layoutBranchService, layoutFinder, layoutFriendlyURLLocalService, layoutFriendlyURLPersistence, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutPrototypeService, layoutRevisionLocalService, layoutRevisionPersistence, layoutRevisionService, layoutService, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetBranchService, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, layoutSetPrototypeService, layoutSetService, layoutTemplateLocalService, listTypePersistence, listTypeService, lockFinder, lockLocalService, lockPersistence, membershipRequestLocalService, membershipRequestPersistence, membershipRequestService, organizationFinder, organizationLocalService, organizationPersistence, organizationService, orgGroupRolePersistence, orgLaborLocalService, orgLaborPersistence, orgLaborService, passwordPolicyFinder, passwordPolicyLocalService, passwordPolicyPersistence, passwordPolicyRelLocalService, passwordPolicyRelPersistence, passwordPolicyService, passwordTrackerLocalService, passwordTrackerPersistence, permissionService, phoneLocalService, phonePersistence, phoneService, pluginSettingLocalService, pluginSettingPersistence, pluginSettingService, portalLocalService, portalPreferencesLocalService, portalPreferencesPersistence, portalService, portletItemLocalService, portletItemPersistence, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, portletService, quartzLocalService, regionPersistence, regionService, releaseLocalService, releasePersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceActionLocalService, resourceActionPersistence, resourceBlockFinder, resourceBlockLocalService, resourceBlockPermissionLocalService, resourceBlockPermissionPersistence, resourceBlockPersistence, resourceBlockService, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService, resourceTypePermissionFinder, resourceTypePermissionLocalService, resourceTypePermissionPersistence, roleFinder, roleLocalService, rolePersistence, roleService, serviceComponentLocalService, serviceComponentPersistence, shardLocalService, shardPersistence, stagingLocalService, stagingService, subscriptionLocalService, subscriptionPersistence, systemEventLocalService, systemEventPersistence, teamFinder, teamLocalService, teamPersistence, teamService, themeLocalService, themeService, ticketLocalService, ticketPersistence, userFinder, userGroupFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userGroupRoleService, userGroupService, userIdMapperLocalService, userIdMapperPersistence, userLocalService, userNotificationDeliveryLocalService, userNotificationDeliveryPersistence, userNotificationEventLocalService, userNotificationEventPersistence, userPersistence, userService, userTrackerLocalService, userTrackerPathLocalService, userTrackerPathPersistence, userTrackerPersistence, virtualHostLocalService, virtualHostPersistence, webDAVPropsLocalService, webDAVPropsPersistence, websiteLocalService, websitePersistence, websiteService, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence

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

ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS

Constructor Summary

Constructors

Constructor and Description
OrganizationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addGroupOrganizations(long groupId, long[] organizationIds) Adds the organizations to the group.
com.liferay.portal.model.Organization	addOrganization(long parentOrganizationId, java.lang.String name, java.lang.String type, boolean recursable, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, java.util.List<com.liferay.portal.model.Address> addresses, java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses, java.util.List<com.liferay.portal.model.OrgLabor> orgLabors, java.util.List<com.liferay.portal.model.Phone> phones, java.util.List<com.liferay.portal.model.Website> websites, com.liferay.portal.service.ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by addOrganization(long, String, String, long, long, int, String, boolean, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, ServiceContext)
com.liferay.portal.model.Organization	addOrganization(long parentOrganizationId, java.lang.String name, java.lang.String type, boolean recursable, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, com.liferay.portal.service.ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by addOrganization(long, String, String, long, long, int, String, boolean, ServiceContext)
com.liferay.portal.model.Organization	addOrganization(long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, java.util.List<com.liferay.portal.model.Address> addresses, java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses, java.util.List<com.liferay.portal.model.OrgLabor> orgLabors, java.util.List<com.liferay.portal.model.Phone> phones, java.util.List<com.liferay.portal.model.Website> websites, com.liferay.portal.service.ServiceContext serviceContext) Adds an organization with additional parameters.
com.liferay.portal.model.Organization	addOrganization(long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, com.liferay.portal.service.ServiceContext serviceContext) Adds an organization.
void	addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) Assigns the password policy to the organizations, removing any other currently assigned password policies.
void	deleteLogo(long organizationId) Deletes the logo of the organization.
void	deleteOrganization(long organizationId) Deletes the organization.
java.util.List<com.liferay.portal.model.Organization>	getManageableOrganizations(java.lang.String actionId, int max) Deprecated. As of 6.2.0, replaced by getOrganizations(long, long, int, int)
com.liferay.portal.model.Organization	getOrganization(long organizationId) Returns the organization with the primary key.
long	getOrganizationId(long companyId, java.lang.String name) Returns the primary key of the organization with the name.
java.util.List<com.liferay.portal.model.Organization>	getOrganizations(long companyId, long parentOrganizationId) Returns all the organizations belonging to the parent organization.
java.util.List<com.liferay.portal.model.Organization>	getOrganizations(long companyId, long parentOrganizationId, int start, int end) Returns a range of all the organizations belonging to the parent organization.
int	getOrganizationsCount(long companyId, long parentOrganizationId) Returns the number of organizations belonging to the parent organization.
java.util.List<com.liferay.portal.model.Organization>	getUserOrganizations(long userId) Returns all the organizations associated with the user.
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.model.Organization	updateOrganization(long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, boolean recursable, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, java.util.List<com.liferay.portal.model.Address> addresses, java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses, java.util.List<com.liferay.portal.model.OrgLabor> orgLabors, java.util.List<com.liferay.portal.model.Phone> phones, java.util.List<com.liferay.portal.model.Website> websites, com.liferay.portal.service.ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by updateOrganization(long, long, String, String, long, long, int, String, boolean, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, ServiceContext)
com.liferay.portal.model.Organization	updateOrganization(long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, boolean recursable, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, com.liferay.portal.service.ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by updateOrganization(long, long, String, String, long, long, int, String, boolean, ServiceContext)
com.liferay.portal.model.Organization	updateOrganization(long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, java.util.List<com.liferay.portal.model.Address> addresses, java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses, java.util.List<com.liferay.portal.model.OrgLabor> orgLabors, java.util.List<com.liferay.portal.model.Phone> phones, java.util.List<com.liferay.portal.model.Website> websites, com.liferay.portal.service.ServiceContext serviceContext) Updates the organization with additional parameters.
com.liferay.portal.model.Organization	updateOrganization(long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, com.liferay.portal.service.ServiceContext serviceContext) Updates the organization.

Methods inherited from class com.liferay.portal.service.base.OrganizationServiceBaseImpl

afterPropertiesSet, destroy, getAccountLocalService, getAccountPersistence, getAccountService, getAddressLocalService, getAddressPersistence, getAddressService, getAssetCategoryFinder, getAssetCategoryLocalService, getAssetCategoryPersistence, getAssetCategoryService, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetEntryService, getAssetTagFinder, getAssetTagLocalService, getAssetTagPersistence, getAssetTagService, getBackgroundTaskLocalService, getBackgroundTaskPersistence, getBackgroundTaskService, getBeanIdentifier, getBrowserTrackerLocalService, getBrowserTrackerPersistence, getClassNameLocalService, getClassNamePersistence, getClassNameService, getClusterGroupLocalService, getClusterGroupPersistence, getCMISRepositoryLocalService, getCompanyLocalService, getCompanyPersistence, getCompanyService, getContactLocalService, getContactPersistence, getContactService, getCounterLocalService, getCountryPersistence, getCountryService, getEmailAddressLocalService, getEmailAddressPersistence, getEmailAddressService, getExpandoRowLocalService, getExpandoRowPersistence, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getImageLocalService, getImagePersistence, getImageService, getLayoutBranchLocalService, getLayoutBranchPersistence, getLayoutBranchService, getLayoutFinder, getLayoutFriendlyURLLocalService, getLayoutFriendlyURLPersistence, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutPrototypeService, getLayoutRevisionLocalService, getLayoutRevisionPersistence, getLayoutRevisionService, getLayoutService, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetBranchService, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getLayoutSetPrototypeService, getLayoutSetService, getLayoutTemplateLocalService, getListTypePersistence, getListTypeService, getLockFinder, getLockLocalService, getLockPersistence, getMembershipRequestLocalService, getMembershipRequestPersistence, getMembershipRequestService, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationLocalService, getOrganizationPersistence, getOrganizationService, getOrgGroupRolePersistence, getOrgLaborLocalService, getOrgLaborPersistence, getOrgLaborService, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPasswordPolicyRelLocalService, getPasswordPolicyRelPersistence, getPasswordPolicyService, getPasswordTrackerLocalService, getPasswordTrackerPersistence, getPermissionService, getPhoneLocalService, getPhonePersistence, getPhoneService, getPluginSettingLocalService, getPluginSettingPersistence, getPluginSettingService, getPortalLocalService, getPortalPreferencesLocalService, getPortalPreferencesPersistence, getPortalService, getPortletItemLocalService, getPortletItemPersistence, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getPortletService, getQuartzLocalService, getRegionPersistence, getRegionService, getReleaseLocalService, getReleasePersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceActionLocalService, getResourceActionPersistence, getResourceBlockFinder, getResourceBlockLocalService, getResourceBlockPermissionLocalService, getResourceBlockPermissionPersistence, getResourceBlockPersistence, getResourceBlockService, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, getResourceTypePermissionFinder, getResourceTypePermissionLocalService, getResourceTypePermissionPersistence, getRoleFinder, getRoleLocalService, getRolePersistence, getRoleService, getServiceComponentLocalService, getServiceComponentPersistence, getShardLocalService, getShardPersistence, getStagingLocalService, getStagingService, getSubscriptionLocalService, getSubscriptionPersistence, getSystemEventLocalService, getSystemEventPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getThemeLocalService, getThemeService, getTicketLocalService, getTicketPersistence, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupLocalService, getUserGroupPersistence, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroupRoleService, getUserGroupService, getUserIdMapperLocalService, getUserIdMapperPersistence, getUserLocalService, getUserNotificationDeliveryLocalService, getUserNotificationDeliveryPersistence, getUserNotificationEventLocalService, getUserNotificationEventPersistence, getUserPersistence, getUserService, getUserTrackerLocalService, getUserTrackerPathLocalService, getUserTrackerPathPersistence, getUserTrackerPersistence, getVirtualHostLocalService, getVirtualHostPersistence, getWebDAVPropsLocalService, getWebDAVPropsPersistence, getWebsiteLocalService, getWebsitePersistence, getWebsiteService, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, runSQL, setAccountLocalService, setAccountPersistence, setAccountService, setAddressLocalService, setAddressPersistence, setAddressService, setAssetCategoryFinder, setAssetCategoryLocalService, setAssetCategoryPersistence, setAssetCategoryService, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetEntryService, setAssetTagFinder, setAssetTagLocalService, setAssetTagPersistence, setAssetTagService, setBackgroundTaskLocalService, setBackgroundTaskPersistence, setBackgroundTaskService, setBeanIdentifier, setBrowserTrackerLocalService, setBrowserTrackerPersistence, setClassNameLocalService, setClassNamePersistence, setClassNameService, setClusterGroupLocalService, setClusterGroupPersistence, setCMISRepositoryLocalService, setCompanyLocalService, setCompanyPersistence, setCompanyService, setContactLocalService, setContactPersistence, setContactService, setCounterLocalService, setCountryPersistence, setCountryService, setEmailAddressLocalService, setEmailAddressPersistence, setEmailAddressService, setExpandoRowLocalService, setExpandoRowPersistence, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setLayoutBranchLocalService, setLayoutBranchPersistence, setLayoutBranchService, setLayoutFinder, setLayoutFriendlyURLLocalService, setLayoutFriendlyURLPersistence, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutPrototypeService, setLayoutRevisionLocalService, setLayoutRevisionPersistence, setLayoutRevisionService, setLayoutService, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetBranchService, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setLayoutSetPrototypeService, setLayoutSetService, setLayoutTemplateLocalService, setListTypePersistence, setListTypeService, setLockFinder, setLockLocalService, setLockPersistence, setMembershipRequestLocalService, setMembershipRequestPersistence, setMembershipRequestService, setOrganizationFinder, setOrganizationLocalService, setOrganizationPersistence, setOrganizationService, setOrgGroupRolePersistence, setOrgLaborLocalService, setOrgLaborPersistence, setOrgLaborService, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPasswordPolicyRelLocalService, setPasswordPolicyRelPersistence, setPasswordPolicyService, setPasswordTrackerLocalService, setPasswordTrackerPersistence, setPermissionService, setPhoneLocalService, setPhonePersistence, setPhoneService, setPluginSettingLocalService, setPluginSettingPersistence, setPluginSettingService, setPortalLocalService, setPortalPreferencesLocalService, setPortalPreferencesPersistence, setPortalService, setPortletItemLocalService, setPortletItemPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setPortletService, setQuartzLocalService, setRegionPersistence, setRegionService, setReleaseLocalService, setReleasePersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceActionLocalService, setResourceActionPersistence, setResourceBlockFinder, setResourceBlockLocalService, setResourceBlockPermissionLocalService, setResourceBlockPermissionPersistence, setResourceBlockPersistence, setResourceBlockService, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService, setResourceTypePermissionFinder, setResourceTypePermissionLocalService, setResourceTypePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService, setServiceComponentLocalService, setServiceComponentPersistence, setShardLocalService, setShardPersistence, setStagingLocalService, setStagingService, setSubscriptionLocalService, setSubscriptionPersistence, setSystemEventLocalService, setSystemEventPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setThemeLocalService, setThemeService, setTicketLocalService, setTicketPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroupRoleService, setUserGroupService, setUserIdMapperLocalService, setUserIdMapperPersistence, setUserLocalService, setUserNotificationDeliveryLocalService, setUserNotificationDeliveryPersistence, setUserNotificationEventLocalService, setUserNotificationEventPersistence, setUserPersistence, setUserService, setUserTrackerLocalService, setUserTrackerPathLocalService, setUserTrackerPathPersistence, setUserTrackerPersistence, setVirtualHostLocalService, setVirtualHostPersistence, setWebDAVPropsLocalService, setWebDAVPropsPersistence, setWebsiteLocalService, setWebsitePersistence, setWebsiteService, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence

Methods inherited from class com.liferay.portal.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 Detail

OrganizationServiceImpl

public OrganizationServiceImpl()

Method Detail

addGroupOrganizations

public void addGroupOrganizations(long groupId,
                         long[] organizationIds)
                           throws com.liferay.portal.kernel.exception.PortalException,
                                  com.liferay.portal.kernel.exception.SystemException

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 - if a group or organization with the primary key could not be found or if the user did not have permission to assign group members

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addOrganization

public com.liferay.portal.model.Organization addOrganization(long parentOrganizationId,
                                                    java.lang.String name,
                                                    java.lang.String type,
                                                    boolean recursable,
                                                    long regionId,
                                                    long countryId,
                                                    int statusId,
                                                    java.lang.String comments,
                                                    boolean site,
                                                    java.util.List<com.liferay.portal.model.Address> addresses,
                                                    java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
                                                    java.util.List<com.liferay.portal.model.OrgLabor> orgLabors,
                                                    java.util.List<com.liferay.portal.model.Phone> phones,
                                                    java.util.List<com.liferay.portal.model.Website> websites,
                                                    com.liferay.portal.service.ServiceContext serviceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException,
                                                             com.liferay.portal.kernel.exception.SystemException

Deprecated. As of 6.2.0, replaced by addOrganization(long, String, String, long, long, int, String, boolean, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, ServiceContext)

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

recursable - whether the permissions of the organization are to be inherited by its suborganizations

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - 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 - if a parent organization with the primary key could not be found, if the organization's information was invalid, or if the user did not have permission to add the organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addOrganization

public com.liferay.portal.model.Organization addOrganization(long parentOrganizationId,
                                                    java.lang.String name,
                                                    java.lang.String type,
                                                    boolean recursable,
                                                    long regionId,
                                                    long countryId,
                                                    int statusId,
                                                    java.lang.String comments,
                                                    boolean site,
                                                    com.liferay.portal.service.ServiceContext serviceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException,
                                                             com.liferay.portal.kernel.exception.SystemException

Deprecated. As of 6.2.0, replaced by addOrganization(long, String, String, long, long, int, String, boolean, ServiceContext)

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

recursable - whether the permissions of the organization are to be inherited by its suborganizations

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - 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 - if the parent organization with the primary key could not be found, if the organization information was invalid, or if the user did not have permission to add the organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addOrganization

public com.liferay.portal.model.Organization addOrganization(long parentOrganizationId,
                                                    java.lang.String name,
                                                    java.lang.String type,
                                                    long regionId,
                                                    long countryId,
                                                    int statusId,
                                                    java.lang.String comments,
                                                    boolean site,
                                                    java.util.List<com.liferay.portal.model.Address> addresses,
                                                    java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
                                                    java.util.List<com.liferay.portal.model.OrgLabor> orgLabors,
                                                    java.util.List<com.liferay.portal.model.Phone> phones,
                                                    java.util.List<com.liferay.portal.model.Website> websites,
                                                    com.liferay.portal.service.ServiceContext serviceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException,
                                                             com.liferay.portal.kernel.exception.SystemException

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

statusId - 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 - if a parent organization with the primary key could not be found, if the organization's information was invalid, or if the user did not have permission to add the organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addOrganization

public com.liferay.portal.model.Organization addOrganization(long parentOrganizationId,
                                                    java.lang.String name,
                                                    java.lang.String type,
                                                    long regionId,
                                                    long countryId,
                                                    int statusId,
                                                    java.lang.String comments,
                                                    boolean site,
                                                    com.liferay.portal.service.ServiceContext serviceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException,
                                                             com.liferay.portal.kernel.exception.SystemException

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

statusId - 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 - if the parent organization with the primary key could not be found, if the organization information was invalid, or if the user did not have permission to add the organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addPasswordPolicyOrganizations

public void addPasswordPolicyOrganizations(long passwordPolicyId,
                                  long[] organizationIds)
                                    throws com.liferay.portal.kernel.exception.PortalException,
                                           com.liferay.portal.kernel.exception.SystemException

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 - if the user did not have permission to update the password policy

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteLogo

public void deleteLogo(long organizationId)
                throws com.liferay.portal.kernel.exception.PortalException,
                       com.liferay.portal.kernel.exception.SystemException

Deletes the logo of the organization.

Parameters:

organizationId - the primary key of the organization

Throws:

com.liferay.portal.kernel.exception.PortalException - if an organization with the primary key could not be found, if the organization's logo could not be found, or if the user did not have permission to update the organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteOrganization

public void deleteOrganization(long organizationId)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException

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 - if an organization with the primary key could not be found, if the user did not have permission to delete the organization, if the organization had a workflow in approved status, or if the organization was a parent organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getManageableOrganizations

public java.util.List<com.liferay.portal.model.Organization> getManageableOrganizations(java.lang.String actionId,
                                                                               int max)
                                                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                                                        com.liferay.portal.kernel.exception.SystemException

Deprecated. As of 6.2.0, replaced by getOrganizations(long, long, int, int)

Returns all the organizations which the user has permission to manage.

Parameters:

actionId - the permitted action

max - the maximum number of the organizations to be considered

Returns:

the organizations which the user has permission to manage

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getOrganization

public com.liferay.portal.model.Organization getOrganization(long organizationId)
                                                      throws com.liferay.portal.kernel.exception.PortalException,
                                                             com.liferay.portal.kernel.exception.SystemException

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 - if an organization with the primary key could not be found or if the user did not have permission to view the organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getOrganizationId

public long getOrganizationId(long companyId,
                     java.lang.String name)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException

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 - if the user did not have permission to view the organization

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getOrganizations

public java.util.List<com.liferay.portal.model.Organization> getOrganizations(long companyId,
                                                                     long parentOrganizationId)
                                                                       throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getOrganizations

public java.util.List<com.liferay.portal.model.Organization> getOrganizations(long companyId,
                                                                     long parentOrganizationId,
                                                                     int start,
                                                                     int end)
                                                                       throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getOrganizationsCount

public int getOrganizationsCount(long companyId,
                        long parentOrganizationId)
                          throws com.liferay.portal.kernel.exception.SystemException

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getUserOrganizations

public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(long userId)
                                                                           throws com.liferay.portal.kernel.exception.PortalException,
                                                                                  com.liferay.portal.kernel.exception.SystemException

Returns all the organizations associated with the user.

Parameters:

userId - the primary key of the user

Returns:

the organizations associated with the user

Throws:

com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

setGroupOrganizations

public void setGroupOrganizations(long groupId,
                         long[] organizationIds)
                           throws com.liferay.portal.kernel.exception.PortalException,
                                  com.liferay.portal.kernel.exception.SystemException

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 - if a group or organization with the primary key could not be found or if the user did not have permission to assign group members

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

unsetGroupOrganizations

public void unsetGroupOrganizations(long groupId,
                           long[] organizationIds)
                             throws com.liferay.portal.kernel.exception.PortalException,
                                    com.liferay.portal.kernel.exception.SystemException

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 - if a group or organization with the primary key could not be found or if the user did not have permission to assign group members

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

unsetPasswordPolicyOrganizations

public void unsetPasswordPolicyOrganizations(long passwordPolicyId,
                                    long[] organizationIds)
                                      throws com.liferay.portal.kernel.exception.PortalException,
                                             com.liferay.portal.kernel.exception.SystemException

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 - if a password policy or organization with the primary key could not be found, or if the user did not have permission to update the password policy

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateOrganization

public com.liferay.portal.model.Organization updateOrganization(long organizationId,
                                                       long parentOrganizationId,
                                                       java.lang.String name,
                                                       java.lang.String type,
                                                       boolean recursable,
                                                       long regionId,
                                                       long countryId,
                                                       int statusId,
                                                       java.lang.String comments,
                                                       boolean site,
                                                       java.util.List<com.liferay.portal.model.Address> addresses,
                                                       java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
                                                       java.util.List<com.liferay.portal.model.OrgLabor> orgLabors,
                                                       java.util.List<com.liferay.portal.model.Phone> phones,
                                                       java.util.List<com.liferay.portal.model.Website> websites,
                                                       com.liferay.portal.service.ServiceContext serviceContext)
                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                com.liferay.portal.kernel.exception.SystemException

Deprecated. As of 6.2.0, replaced by updateOrganization(long, long, String, String, long, long, int, String, boolean, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, ServiceContext)

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

recursable - whether the permissions of the organization are to be inherited by its suborganizations

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - 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 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 - if an organization or parent organization with the primary key could not be found, if the user did not have permission to update the organization information, or if the new information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateOrganization

public com.liferay.portal.model.Organization updateOrganization(long organizationId,
                                                       long parentOrganizationId,
                                                       java.lang.String name,
                                                       java.lang.String type,
                                                       boolean recursable,
                                                       long regionId,
                                                       long countryId,
                                                       int statusId,
                                                       java.lang.String comments,
                                                       boolean site,
                                                       com.liferay.portal.service.ServiceContext serviceContext)
                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                com.liferay.portal.kernel.exception.SystemException

Deprecated. As of 6.2.0, replaced by updateOrganization(long, long, String, String, long, long, int, String, boolean, ServiceContext)

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

recursable - whether permissions of the organization are to be inherited by its suborganizations

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - 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 - if an organization or parent organization with the primary key could not be found, if the user did not have permission to update the organization, or if the new information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateOrganization

public com.liferay.portal.model.Organization updateOrganization(long organizationId,
                                                       long parentOrganizationId,
                                                       java.lang.String name,
                                                       java.lang.String type,
                                                       long regionId,
                                                       long countryId,
                                                       int statusId,
                                                       java.lang.String comments,
                                                       boolean site,
                                                       java.util.List<com.liferay.portal.model.Address> addresses,
                                                       java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
                                                       java.util.List<com.liferay.portal.model.OrgLabor> orgLabors,
                                                       java.util.List<com.liferay.portal.model.Phone> phones,
                                                       java.util.List<com.liferay.portal.model.Website> websites,
                                                       com.liferay.portal.service.ServiceContext serviceContext)
                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                com.liferay.portal.kernel.exception.SystemException

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

statusId - 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 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 - if an organization or parent organization with the primary key could not be found, if the user did not have permission to update the organization information, or if the new information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateOrganization

public com.liferay.portal.model.Organization updateOrganization(long organizationId,
                                                       long parentOrganizationId,
                                                       java.lang.String name,
                                                       java.lang.String type,
                                                       long regionId,
                                                       long countryId,
                                                       int statusId,
                                                       java.lang.String comments,
                                                       boolean site,
                                                       com.liferay.portal.service.ServiceContext serviceContext)
                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                com.liferay.portal.kernel.exception.SystemException

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

statusId - 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 - if an organization or parent organization with the primary key could not be found, if the user did not have permission to update the organization, or if the new information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred