com.liferay.portal.service.UserGroupServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the remote service utility for UserGroup. This utility wraps
* {@link com.liferay.portal.service.impl.UserGroupServiceImpl} and is the
* primary access point for service operations in application layer code running
* on a remote server. Methods of this service are expected to have security
* checks based on the propagated JAAS credentials because this service can be
* accessed remotely.
*
* @author Brian Wing Shun Chan
* @see UserGroupService
* @see com.liferay.portal.service.base.UserGroupServiceBaseImpl
* @see com.liferay.portal.service.impl.UserGroupServiceImpl
* @generated
*/
@ProviderType
public class UserGroupServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
/**
* Adds the user groups to the group.
*
* @param groupId the primary key of the group
* @param userGroupIds the primary keys of the user groups
* @throws PortalException if a group or user group with the primary key
could not be found, or if the user did not have permission to
assign group members
* @throws SystemException if a system exception occurred
*/
public static void addGroupUserGroups(long groupId, long[] userGroupIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().addGroupUserGroups(groupId, userGroupIds);
}
/**
* Adds the user groups to the team
*
* @param teamId the primary key of the team
* @param userGroupIds the primary keys of the user groups
* @throws PortalException if a team or user group with the primary key
could not be found, or if the user did not have permission to
assign team members
* @throws SystemException if a system exception occurred
*/
public static void addTeamUserGroups(long teamId, long[] userGroupIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().addTeamUserGroups(teamId, userGroupIds);
}
/**
* Adds a user group.
*
*
* This method handles the creation and bookkeeping of the user group,
* including its resources, metadata, and internal data structures.
*
*
* @param name the user group's name
* @param description the user group's description
* @return the user group
* @throws PortalException if the user group's information was invalid
or if the user did not have permission to add the user group
* @throws SystemException if a system exception occurred
* @deprecated As of 6.2.0, replaced by {@link #addUserGroup(String, String,
ServiceContext)}
*/
public static com.liferay.portal.model.UserGroup addUserGroup(
java.lang.String name, java.lang.String description)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().addUserGroup(name, description);
}
/**
* Adds a user group.
*
*
* This method handles the creation and bookkeeping of the user group,
* including its resources, metadata, and internal data structures.
*
*
* @param name the user group's name
* @param description the user group's description
* @param serviceContext the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.
* @return the user group
* @throws PortalException if the user group's information was invalid or if
the user did not have permission to add the user group
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserGroup addUserGroup(
java.lang.String name, java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().addUserGroup(name, description, serviceContext);
}
/**
* Deletes the user group.
*
* @param userGroupId the primary key of the user group
* @throws PortalException if a user group with the primary key could not be
found, if the user did not have permission to delete the user
group, or if the user group had a workflow in approved status
* @throws SystemException if a system exception occurred
*/
public static void deleteUserGroup(long userGroupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteUserGroup(userGroupId);
}
/**
* Returns the user group with the primary key.
*
* @param userGroupId the primary key of the user group
* @return Returns the user group with the primary key
* @throws PortalException if a user group with the primary key could not be
found or if the user did not have permission to view the user
group
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserGroup getUserGroup(
long userGroupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getUserGroup(userGroupId);
}
/**
* Returns the user group with the name.
*
* @param name the user group's name
* @return Returns the user group with the name
* @throws PortalException if a user group with the name could not be found
or if the user did not have permission to view the user group
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserGroup getUserGroup(
java.lang.String name)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getUserGroup(name);
}
/**
* Returns all the user groups to which the user belongs.
*
* @param userId the primary key of the user
* @return the user groups to which the user belongs
* @throws PortalException if the current user did not have permission to
view the user or any one of the user group members
* @throws SystemException if a system exception occurred
*/
public static java.util.List getUserUserGroups(
long userId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getUserUserGroups(userId);
}
/**
* Removes the user groups from the group.
*
* @param groupId the primary key of the group
* @param userGroupIds the primary keys of the user groups
* @throws PortalException if the user did not have permission to assign
group members
* @throws SystemException if a system exception occurred
*/
public static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().unsetGroupUserGroups(groupId, userGroupIds);
}
/**
* Removes the user groups from the team.
*
* @param teamId the primary key of the team
* @param userGroupIds the primary keys of the user groups
* @throws PortalException if the user did not have permission to assign
team members
* @throws SystemException if a system exception occurred
*/
public static void unsetTeamUserGroups(long teamId, long[] userGroupIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().unsetTeamUserGroups(teamId, userGroupIds);
}
/**
* Updates the user group.
*
* @param userGroupId the primary key of the user group
* @param name the user group's name
* @param description the the user group's description
* @return the user group
* @throws PortalException if a user group with the primary key was not
found, if the new information was invalid, or if the user did
not have permission to update the user group information
* @throws SystemException if a system exception occurred
* @deprecated As of 6.2.0, replaced by {@link #updateUserGroup(long,
String, String, ServiceContext)}
*/
public static com.liferay.portal.model.UserGroup updateUserGroup(
long userGroupId, java.lang.String name, java.lang.String description)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().updateUserGroup(userGroupId, name, description);
}
/**
* Updates the user group.
*
* @param userGroupId the primary key of the user group
* @param name the user group's name
* @param description the the user group's description
* @param serviceContext the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.
* @return the user group
* @throws PortalException if a user group with the primary key was not
found, if the new information was invalid, or if the user did not
have permission to update the user group information
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.UserGroup updateUserGroup(
long userGroupId, java.lang.String name, java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateUserGroup(userGroupId, name, description,
serviceContext);
}
public static UserGroupService getService() {
if (_service == null) {
_service = (UserGroupService)PortalBeanLocatorUtil.locate(UserGroupService.class.getName());
ReferenceRegistry.registerReference(UserGroupServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(UserGroupService service) {
}
private static UserGroupService _service;
}