|
Liferay 7.0-ce-a2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface OrganizationServiceProvides the remote service interface for Organization. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
OrganizationServiceUtil,
OrganizationServiceBaseImpl,
OrganizationServiceImpl| Method Summary | |
|---|---|
void |
addGroupOrganizations(long groupId,
long[] organizationIds)
Adds the organizations to the group. |
Organization |
addOrganization(long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by #addOrganization(long,
String, String, long, long, int, String, boolean, List, List,
List, List, List, ServiceContext) |
Organization |
addOrganization(long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by #addOrganization(long,
String, String, long, long, int, String, boolean,
ServiceContext) |
Organization |
addOrganization(long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
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. |
Organization |
addOrganization(long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
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 organization's logo. |
void |
deleteOrganization(long organizationId)
Deletes the organization. |
Organization |
fetchOrganization(long organizationId)
Returns the organization with the primary key. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
List<Organization> |
getManageableOrganizations(String actionId,
int max)
Deprecated. As of 6.2.0, replaced by getOrganizations(long, long,
int, int) |
Organization |
getOrganization(long organizationId)
Returns the organization with the primary key. |
long |
getOrganizationId(long companyId,
String name)
Returns the primary key of the organization with the name. |
List<Organization> |
getOrganizations(long companyId,
long parentOrganizationId)
Returns all the organizations belonging to the parent organization. |
List<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. |
List<Organization> |
getUserOrganizations(long userId)
Returns all the organizations with which the user is explicitly associated. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
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. |
Organization |
updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by #updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext) |
Organization |
updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by #updateOrganization(long,
long, String, String, long, long, int, String, boolean,
ServiceContext) |
Organization |
updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean logo,
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. |
Organization |
updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by #updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext) |
Organization |
updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
ServiceContext serviceContext)
Updates the organization. |
| Method Detail |
|---|
void addGroupOrganizations(long groupId,
long[] organizationIds)
throws PortalException
groupId - the primary key of the grouporganizationIds - the primary keys of the organizations
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
@Deprecated
Organization addOrganization(long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
throws PortalException
#addOrganization(long,
String, String, long, long, int, String, boolean, List, List,
List, List, List, ServiceContext)
This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
parentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether the permissions of the organization are to
be inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - 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 (optionally
null). Can set asset category IDs, asset tag
names, and expando bridge attributes for the organization.
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
@Deprecated
Organization addOrganization(long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
ServiceContext serviceContext)
throws PortalException
#addOrganization(long,
String, String, long, long, int, String, boolean,
ServiceContext)
This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
parentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether the permissions of the organization are to
be inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - 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 (optionally
null). Can set asset category IDs, asset tag
names, and expando bridge attributes for the organization.
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
Organization addOrganization(long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
throws PortalException
This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
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 countrystatusId - 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 (optionally
null). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.
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
Organization addOrganization(long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
ServiceContext serviceContext)
throws PortalException
This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
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 countrystatusId - 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 (optionally
null). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.
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
void addPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws PortalException
passwordPolicyId - the primary key of the password policyorganizationIds - the primary keys of the organizations
PortalException - if the user did not have permission to update the
password policy
void deleteLogo(long organizationId)
throws PortalException
organizationId - the primary key of the organization
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
void deleteOrganization(long organizationId)
throws PortalException
organizationId - the primary key of the organization
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
@Transactional(propagation=SUPPORTS,
readOnly=true)
Organization fetchOrganization(long organizationId)
throws PortalException
organizationId - the primary key of the organization
null if an
organization with the primary key could not be found or if the
user did not have permission to view the organization
PortalException - if a portal exception occurredString getBeanIdentifier()
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Organization> getManageableOrganizations(String actionId,
int max)
throws PortalException
getOrganizations(long, long,
int, int)
actionId - the permitted actionmax - the maximum number of the organizations to be considered
PortalException - if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Organization getOrganization(long organizationId)
throws PortalException
organizationId - the primary key of the organization
PortalException - if an organization with the primary key could not
be found or if the user did not have permission to view the
organization
@Transactional(propagation=SUPPORTS,
readOnly=true)
long getOrganizationId(long companyId,
String name)
throws PortalException
companyId - the primary key of the organization's companyname - the organization's name
0 if the organization could not be found
PortalException - if the user did not have permission to view the
organization
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Organization> getOrganizations(long companyId,
long parentOrganizationId)
companyId - the primary key of the organizations' companyparentOrganizationId - the primary key of the organizations' parent
organization
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Organization> getOrganizations(long companyId,
long parentOrganizationId,
int start,
int end)
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.
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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getOrganizationsCount(long companyId,
long parentOrganizationId)
companyId - the primary key of the organizations' companyparentOrganizationId - the primary key of the organizations' parent
organization
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Organization> getUserOrganizations(long userId)
throws PortalException
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.
userId - the primary key of the user
PortalException - if a user with the primary key could not be foundvoid setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
void setGroupOrganizations(long groupId,
long[] organizationIds)
throws PortalException
groupId - the primary key of the grouporganizationIds - the primary keys of the organizations
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
void unsetGroupOrganizations(long groupId,
long[] organizationIds)
throws PortalException
groupId - the primary key of the grouporganizationIds - the primary keys of the organizations
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
void unsetPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws PortalException
passwordPolicyId - the primary key of the password policyorganizationIds - the primary keys of the organizations
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
@Deprecated
Organization updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
throws PortalException
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext)
organizationId - the primary key of the organizationparentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether the permissions of the organization are to
be inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - 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 (optionally
null). Can set asset category IDs and asset tag
names for the organization, and merge expando bridge
attributes for the organization.
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
@Deprecated
Organization updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
ServiceContext serviceContext)
throws PortalException
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
ServiceContext)
organizationId - the primary key of the organizationparentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether permissions of the organization are to be
inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - 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 (optionally
null). Can set asset category IDs and asset tag
names for the organization, and merge expando bridge
attributes for the organization.
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
Organization updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean logo,
byte[] logoBytes,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
throws PortalException
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 countrystatusId - the organization's workflow statuscomments - the comments about the organizationlogo - whether to update the ogranization's 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 (optionally
null). Can set asset category IDs and asset tag
names for the organization, and merge expando bridge attributes
for the organization.
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
@Deprecated
Organization updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
List<Address> addresses,
List<EmailAddress> emailAddresses,
List<OrgLabor> orgLabors,
List<Phone> phones,
List<Website> websites,
ServiceContext serviceContext)
throws PortalException
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext)
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 countrystatusId - 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 (optionally
null). Can set asset category IDs and asset tag
names for the organization, and merge expando bridge
attributes for the organization.
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
Organization updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
long regionId,
long countryId,
long statusId,
String comments,
boolean site,
ServiceContext serviceContext)
throws PortalException
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 countrystatusId - 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 (optionally
null). Can set asset category IDs and asset tag
names for the organization, and merge expando bridge attributes
for the organization.
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
|
Liferay 7.0-ce-a2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||