@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface OrganizationLocalService extends BaseLocalService, PersistedModelLocalService
OrganizationLocalServiceUtil,
OrganizationLocalServiceBaseImpl,
com.liferay.portal.service.impl.OrganizationLocalServiceImpl| Modifier and Type | Method and Description |
|---|---|
void |
addGroupOrganization(long groupId,
long organizationId) |
void |
addGroupOrganization(long groupId,
Organization organization) |
void |
addGroupOrganizations(long groupId,
java.util.List<Organization> Organizations) |
void |
addGroupOrganizations(long groupId,
long[] organizationIds) |
Organization |
addOrganization(long userId,
long parentOrganizationId,
java.lang.String name,
boolean site)
Adds an organization.
|
Organization |
addOrganization(long userId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
int statusId,
java.lang.String comments,
boolean site,
ServiceContext serviceContext)
Deprecated.
As of 6.2.0, replaced by
addOrganization(long, long,
String, String, long, long, int, String, boolean,
ServiceContext) |
Organization |
addOrganization(long userId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
long regionId,
long countryId,
int statusId,
java.lang.String comments,
boolean site,
ServiceContext serviceContext)
Adds an organization.
|
Organization |
addOrganization(Organization organization)
Adds the organization to the database.
|
void |
addOrganizationResources(long userId,
Organization organization)
Adds a resource for each type of permission available on the
organization.
|
void |
addPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
Assigns the password policy to the organizations, removing any other
currently assigned password policies.
|
void |
addUserOrganization(long userId,
long organizationId) |
void |
addUserOrganization(long userId,
Organization organization) |
void |
addUserOrganizations(long userId,
java.util.List<Organization> Organizations) |
void |
addUserOrganizations(long userId,
long[] organizationIds) |
void |
clearGroupOrganizations(long groupId) |
void |
clearUserOrganizations(long userId) |
Organization |
createOrganization(long organizationId)
Creates a new organization with the primary key.
|
void |
deleteGroupOrganization(long groupId,
long organizationId) |
void |
deleteGroupOrganization(long groupId,
Organization organization) |
void |
deleteGroupOrganizations(long groupId,
java.util.List<Organization> Organizations) |
void |
deleteGroupOrganizations(long groupId,
long[] organizationIds) |
void |
deleteLogo(long organizationId)
Deletes the logo of the organization.
|
Organization |
deleteOrganization(long organizationId)
Deletes the organization with the primary key from the database.
|
Organization |
deleteOrganization(Organization organization)
Deletes the organization from the database.
|
void |
deleteUserOrganization(long userId,
long organizationId) |
void |
deleteUserOrganization(long userId,
Organization organization) |
void |
deleteUserOrganizations(long userId,
java.util.List<Organization> Organizations) |
void |
deleteUserOrganizations(long userId,
long[] organizationIds) |
DynamicQuery |
dynamicQuery() |
java.util.List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
java.util.List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
java.util.List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query.
|
Organization |
fetchOrganization(long organizationId) |
Organization |
fetchOrganization(long companyId,
java.lang.String name) |
Organization |
fetchOrganizationByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the organization with the matching UUID and company.
|
java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
java.util.List<Organization> |
getGroupOrganizations(long groupId) |
java.util.List<Organization> |
getGroupOrganizations(long groupId,
int start,
int end) |
java.util.List<Organization> |
getGroupOrganizations(long groupId,
int start,
int end,
OrderByComparator orderByComparator) |
int |
getGroupOrganizationsCount(long groupId) |
java.util.List<Organization> |
getNoAssetOrganizations() |
Organization |
getOrganization(long organizationId)
Returns the organization with the primary key.
|
Organization |
getOrganization(long companyId,
java.lang.String name)
Returns the organization with the name.
|
Organization |
getOrganizationByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the organization with the matching UUID and company.
|
long |
getOrganizationId(long companyId,
java.lang.String name)
Returns the primary key of the organization with the name.
|
java.util.List<Organization> |
getOrganizations(int start,
int end)
Returns a range of all the organizations.
|
java.util.List<Organization> |
getOrganizations(long[] organizationIds)
Returns the organizations with the primary keys.
|
java.util.List<Organization> |
getOrganizations(long userId,
int start,
int end,
OrderByComparator obc) |
java.util.List<Organization> |
getOrganizations(long companyId,
long parentOrganizationId)
Returns all the organizations belonging to the parent organization.
|
java.util.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()
Returns the number of organizations.
|
int |
getOrganizationsCount(long companyId,
long parentOrganizationId)
Returns the number of organizations belonging to the parent organization.
|
java.util.List<Organization> |
getParentOrganizations(long organizationId)
Returns the parent organizations in order by closest ancestor.
|
PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
java.util.List<Organization> |
getSuborganizations(java.util.List<Organization> organizations)
Returns the suborganizations of the organizations.
|
java.util.List<Organization> |
getSuborganizations(long companyId,
long organizationId)
Returns the suborganizations of the organization.
|
int |
getSuborganizationsCount(long companyId,
long organizationId)
Returns the count of suborganizations of the organization.
|
java.util.List<Organization> |
getSubsetOrganizations(java.util.List<Organization> allOrganizations,
java.util.List<Organization> availableOrganizations)
Returns the intersection of
allOrganizations and
availableOrganizations. |
java.util.List<Organization> |
getUserOrganizations(long userId) |
java.util.List<Organization> |
getUserOrganizations(long userId,
boolean includeAdministrative)
Returns all the organizations associated with the user.
|
java.util.List<Organization> |
getUserOrganizations(long userId,
int start,
int end) |
java.util.List<Organization> |
getUserOrganizations(long userId,
int start,
int end,
OrderByComparator orderByComparator) |
int |
getUserOrganizationsCount(long userId) |
boolean |
hasGroupOrganization(long groupId,
long organizationId) |
boolean |
hasGroupOrganizations(long groupId) |
boolean |
hasPasswordPolicyOrganization(long passwordPolicyId,
long organizationId)
Returns
true if the password policy has been assigned to the
organization. |
boolean |
hasUserOrganization(long userId,
long organizationId) |
boolean |
hasUserOrganization(long userId,
long organizationId,
boolean inheritSuborganizations,
boolean includeSpecifiedOrganization)
Returns
true if the user is a member of the organization,
optionally focusing on suborganizations or the specified organization. |
boolean |
hasUserOrganizations(long userId) |
void |
rebuildTree(long companyId)
Rebuilds the organizations tree.
|
Hits |
search(long companyId,
long parentOrganizationId,
java.lang.String keywords,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end,
Sort sort)
Returns an ordered range of all the organizations that match the
keywords, using the indexer.
|
java.util.List<Organization> |
search(long companyId,
long parentOrganizationId,
java.lang.String keywords,
java.lang.String type,
java.lang.Long regionId,
java.lang.Long countryId,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end)
Returns a name ordered range of all the organizations that match the
keywords, type, region, and country, without using the indexer.
|
java.util.List<Organization> |
search(long companyId,
long parentOrganizationId,
java.lang.String keywords,
java.lang.String type,
java.lang.Long regionId,
java.lang.Long countryId,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the organizations that match the
keywords, type, region, and country, without using the indexer.
|
java.util.List<Organization> |
search(long companyId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
java.lang.String street,
java.lang.String city,
java.lang.String zip,
java.lang.Long regionId,
java.lang.Long countryId,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andOperator,
int start,
int end)
Returns a name ordered range of all the organizations with the type,
region, and country, and whose name, street, city, and zipcode match the
keywords specified for them, without using the indexer.
|
java.util.List<Organization> |
search(long companyId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
java.lang.String street,
java.lang.String city,
java.lang.String zip,
java.lang.Long regionId,
java.lang.Long countryId,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the organizations with the type, region,
and country, and whose name, street, city, and zipcode match the keywords
specified for them, without using the indexer.
|
Hits |
search(long companyId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
java.lang.String street,
java.lang.String city,
java.lang.String zip,
java.lang.String region,
java.lang.String country,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
Returns an ordered range of all the organizations whose name, type, or
location fields match the keywords specified for them, using the indexer.
|
int |
searchCount(long companyId,
long parentOrganizationId,
java.lang.String keywords,
java.lang.String type,
java.lang.Long regionId,
java.lang.Long countryId,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
Returns the number of organizations that match the keywords, type,
region, and country.
|
int |
searchCount(long companyId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
java.lang.String street,
java.lang.String city,
java.lang.String zip,
java.lang.Long regionId,
java.lang.Long countryId,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andOperator)
Returns the number of organizations with the type, region, and country,
and whose name, street, city, and zipcode match the keywords specified
for them.
|
void |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
void |
setGroupOrganizations(long groupId,
long[] organizationIds) |
void |
setUserOrganizations(long userId,
long[] organizationIds) |
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.
|
void |
updateAsset(long userId,
Organization organization,
long[] assetCategoryIds,
java.lang.String[] assetTagNames)
Updates the organization's asset with the new asset categories and tag
names, removing and adding asset categories and tag names as necessary.
|
Organization |
updateOrganization(long companyId,
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,
ServiceContext serviceContext)
Deprecated.
|
Organization |
updateOrganization(long companyId,
long organizationId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
long regionId,
long countryId,
int statusId,
java.lang.String comments,
boolean site,
ServiceContext serviceContext)
Updates the organization.
|
Organization |
updateOrganization(Organization organization)
Updates the organization in the database or adds it if it does not yet exist.
|
@Indexable(type=REINDEX) Organization addOrganization(Organization organization) throws SystemException
organization - the organizationSystemException - if a system exception occurredOrganization createOrganization(long organizationId)
organizationId - the primary key for the new organization@Indexable(type=DELETE) Organization deleteOrganization(long organizationId) throws PortalException, SystemException
organizationId - the primary key of the organizationPortalException - if a organization with the primary key could not be foundSystemException - if a system exception occurred@Indexable(type=DELETE) Organization deleteOrganization(Organization organization) throws PortalException, SystemException
organization - the organizationPortalExceptionSystemException - if a system exception occurredDynamicQuery dynamicQuery()
java.util.List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery - the dynamic querySystemException - if a system exception occurredjava.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from OrganizationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)SystemException - if a system exception occurredjava.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from OrganizationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)SystemException - if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery - the dynamic querySystemException - if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery - the dynamic queryprojection - the projection to apply to the querySystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Organization fetchOrganization(long organizationId) throws SystemException
SystemException@Transactional(propagation=SUPPORTS, readOnly=true) Organization fetchOrganizationByUuidAndCompanyId(java.lang.String uuid, long companyId) throws SystemException
uuid - the organization's UUIDcompanyId - the primary key of the companynull if a matching organization could not be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Organization getOrganization(long organizationId) throws PortalException, SystemException
organizationId - the primary key of the organizationPortalException - if a organization with the primary key could not be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel in interface PersistedModelLocalServicePortalExceptionSystemException@Transactional(propagation=SUPPORTS, readOnly=true) Organization getOrganizationByUuidAndCompanyId(java.lang.String uuid, long companyId) throws PortalException, SystemException
uuid - the organization's UUIDcompanyId - the primary key of the companyPortalException - if a matching organization could not be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getOrganizations(int start, int end) throws SystemException
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from OrganizationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start - the lower bound of the range of organizationsend - the upper bound of the range of organizations (not inclusive)SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getOrganizationsCount() throws SystemException
SystemException - if a system exception occurred@Indexable(type=REINDEX) Organization updateOrganization(Organization organization) throws SystemException
organization - the organizationSystemException - if a system exception occurredvoid addGroupOrganization(long groupId,
long organizationId)
throws SystemException
SystemException - if a system exception occurredvoid addGroupOrganization(long groupId,
Organization organization)
throws SystemException
SystemException - if a system exception occurredvoid addGroupOrganizations(long groupId,
long[] organizationIds)
throws PortalException,
SystemException
PortalExceptionSystemException - if a system exception occurredvoid addGroupOrganizations(long groupId,
java.util.List<Organization> Organizations)
throws PortalException,
SystemException
PortalExceptionSystemException - if a system exception occurredvoid clearGroupOrganizations(long groupId)
throws SystemException
SystemException - if a system exception occurredvoid deleteGroupOrganization(long groupId,
long organizationId)
throws SystemException
SystemException - if a system exception occurredvoid deleteGroupOrganization(long groupId,
Organization organization)
throws SystemException
SystemException - if a system exception occurredvoid deleteGroupOrganizations(long groupId,
long[] organizationIds)
throws SystemException
SystemException - if a system exception occurredvoid deleteGroupOrganizations(long groupId,
java.util.List<Organization> Organizations)
throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getGroupOrganizations(long groupId) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getGroupOrganizations(long groupId, int start, int end) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getGroupOrganizations(long groupId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupOrganizationsCount(long groupId) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasGroupOrganization(long groupId, long organizationId) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasGroupOrganizations(long groupId) throws SystemException
SystemException - if a system exception occurredvoid setGroupOrganizations(long groupId,
long[] organizationIds)
throws PortalException,
SystemException
PortalExceptionSystemException - if a system exception occurredvoid addUserOrganization(long userId,
long organizationId)
throws SystemException
SystemException - if a system exception occurredvoid addUserOrganization(long userId,
Organization organization)
throws SystemException
SystemException - if a system exception occurredvoid addUserOrganizations(long userId,
long[] organizationIds)
throws SystemException
SystemException - if a system exception occurredvoid addUserOrganizations(long userId,
java.util.List<Organization> Organizations)
throws SystemException
SystemException - if a system exception occurredvoid clearUserOrganizations(long userId)
throws SystemException
SystemException - if a system exception occurredvoid deleteUserOrganization(long userId,
long organizationId)
throws SystemException
SystemException - if a system exception occurredvoid deleteUserOrganization(long userId,
Organization organization)
throws SystemException
SystemException - if a system exception occurredvoid deleteUserOrganizations(long userId,
long[] organizationIds)
throws SystemException
SystemException - if a system exception occurredvoid deleteUserOrganizations(long userId,
java.util.List<Organization> Organizations)
throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getUserOrganizations(long userId) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getUserOrganizations(long userId, int start, int end) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getUserOrganizations(long userId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getUserOrganizationsCount(long userId) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserOrganization(long userId, long organizationId) throws SystemException
SystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserOrganizations(long userId) throws SystemException
SystemException - if a system exception occurredvoid setUserOrganizations(long userId,
long[] organizationIds)
throws SystemException
SystemException - if a system exception occurredjava.lang.String getBeanIdentifier()
void setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanOrganization addOrganization(long userId, long parentOrganizationId, java.lang.String name, boolean site) throws PortalException, SystemException
This method handles the creation and bookkeeping of the organization
including its resources, metadata, and internal data structures. It is
not necessary to make a subsequent call to addOrganizationResources(long, Organization).
userId - the primary key of the creator/owner of the organizationparentOrganizationId - the primary key of the organization's parent
organizationname - the organization's namesite - whether the organization is to be associated with a main
sitePortalException - if a creator or parent organization with the
primary key could not be found or if the organization's
information was invalidSystemException - if a system exception occurredOrganization addOrganization(long userId, long parentOrganizationId, java.lang.String name, java.lang.String type, boolean recursable, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, ServiceContext serviceContext) throws PortalException, SystemException
addOrganization(long, 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. It is
not necessary to make a subsequent call to addOrganizationResources(long, Organization).
userId - the primary key of the creator/owner 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
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 a creator or parent organization with the
primary key could not be found or if the organization's
information was invalidSystemException - if a system exception occurredOrganization addOrganization(long userId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, ServiceContext serviceContext) throws PortalException, SystemException
This method handles the creation and bookkeeping of the organization
including its resources, metadata, and internal data structures. It is
not necessary to make a subsequent call to addOrganizationResources(long, Organization).
userId - the primary key of the creator/owner 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, asset tag names,
and expando bridge attributes for the organization.PortalException - if a creator or parent organization with the
primary key could not be found or if the organization's
information was invalidSystemException - if a system exception occurredvoid addOrganizationResources(long userId,
Organization organization)
throws PortalException,
SystemException
userId - the primary key of the creator/owner of the organizationorganization - the organizationPortalException - if a portal exception occurredSystemException - if a system exception occurredvoid addPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws SystemException
passwordPolicyId - the primary key of the password policyorganizationIds - the primary keys of the organizationsSystemException - if a system exception occurredvoid deleteLogo(long organizationId)
throws PortalException,
SystemException
organizationId - the primary key of the organizationPortalException - if an organization or parent organization with
the primary key could not be found or if the organization's logo
could not be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Organization fetchOrganization(long companyId, java.lang.String name) throws SystemException
SystemException@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getNoAssetOrganizations() throws SystemException
SystemException@Transactional(propagation=SUPPORTS, readOnly=true) Organization getOrganization(long companyId, java.lang.String name) throws PortalException, SystemException
companyId - the primary key of the organization's companyname - the organization's namePortalException - if the organization with the name could not be
foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) long getOrganizationId(long companyId, java.lang.String name) throws SystemException
companyId - the primary key of the organization's companyname - the organization's name0 if the organization could not be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getOrganizations(long userId, int start, int end, OrderByComparator obc) throws PortalException, SystemException
PortalExceptionSystemException@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getOrganizations(long companyId, long parentOrganizationId) throws SystemException
companyId - the primary key of the organization's companyparentOrganizationId - the primary key of the organization's parent
organizationSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getOrganizations(long companyId, long parentOrganizationId, int start, int end) throws SystemException
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 organization's companyparentOrganizationId - the primary key of the organization's parent
organizationstart - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)SystemException - if a system exception occurredOrganizationPersistence.findByC_P(
long, long, int, int)@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getOrganizations(long[] organizationIds) throws PortalException, SystemException
organizationIds - the primary keys of the organizationsPortalException - if any one of the organizations could not be
foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getOrganizationsCount(long companyId, long parentOrganizationId) throws SystemException
companyId - the primary key of the organization's companyparentOrganizationId - the primary key of the organization's parent
organizationSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getParentOrganizations(long organizationId) throws PortalException, SystemException
organizationId - the primary key of the organizationPortalException - if an organization with the primary key could not
be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getSuborganizations(java.util.List<Organization> organizations) throws SystemException
organizations - the organizations from which to get
suborganizationsSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getSuborganizations(long companyId, long organizationId) throws SystemException
companyId - the primary key of the organization's companyorganizationId - the primary key of the organizationSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getSuborganizationsCount(long companyId, long organizationId) throws SystemException
companyId - the primary key of the organization's companyorganizationId - the primary key of the organizationSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getSubsetOrganizations(java.util.List<Organization> allOrganizations, java.util.List<Organization> availableOrganizations)
allOrganizations and
availableOrganizations.allOrganizations - the organizations to check for availabilityavailableOrganizations - the available organizationsallOrganizations and
availableOrganizations@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> getUserOrganizations(long userId, boolean includeAdministrative) throws PortalException, SystemException
true, the result includes those
organizations that are not directly associated to the user but he is an
administrator or an owner of the organization.userId - the primary key of the userincludeAdministrative - whether to includes organizations that are
indirectly associated to the user because he is an administrator
or an owner of the organizationPortalException - if a user with the primary key could not be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasPasswordPolicyOrganization(long passwordPolicyId, long organizationId) throws SystemException
true if the password policy has been assigned to the
organization.passwordPolicyId - the primary key of the password policyorganizationId - the primary key of the organizationtrue if the password policy has been assigned to the
organization; false otherwiseSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserOrganization(long userId, long organizationId, boolean inheritSuborganizations, boolean includeSpecifiedOrganization) throws PortalException, SystemException
true if the user is a member of the organization,
optionally focusing on suborganizations or the specified organization.
This method is usually called to determine if the user has view access to
a resource belonging to the organization.
inheritSuborganizations=false:
the method checks whether the user belongs to the organization specified
by organizationId. The parameter
includeSpecifiedOrganization is ignored.
includeSpecifiedOrganization is
ignored unless inheritSuborganizations is also
true.
inheritSuborganizations=true and
includeSpecifiedOrganization=false: the method
checks
whether the user belongs to one of the child organizations of the one
specified by organizationId.
inheritSuborganizations=true and
includeSpecifiedOrganization=true: the method
checks whether
the user belongs to the organization specified by
organizationId or any of
its child organizations.
userId - the primary key of the organization's userorganizationId - the primary key of the organizationinheritSuborganizations - if true suborganizations are
considered in the determinationincludeSpecifiedOrganization - if true the
organization specified by organizationId is
considered in the determinationtrue if the user has access to the organization;
false otherwisePortalException - if an organization with the primary key could not
be foundSystemException - if a system exception occurredOrganizationFindervoid rebuildTree(long companyId)
throws PortalException,
SystemException
Only call this method if the tree has become stale through operations other than normal CRUD. Under normal circumstances the tree is automatically rebuilt whenever necessary.
companyId - the primary key of the organization's companyPortalException - if an organization with the primary key could not
be foundSystemException - if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long companyId, long parentOrganizationId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, Sort sort) throws SystemException
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 organization's companyparentOrganizationId - the primary key of the organization's parent
organizationkeywords - the keywords (space separated), which may occur in the
organization's name, street, city, zipcode, type, region or
country (optionally null)params - the finder parameters (optionally null). For
more information see OrganizationIndexerstart - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)sort - the field and direction by which to sort (optionally
null)SystemException - if a system exception occurredOrganizationIndexer@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> search(long companyId, long parentOrganizationId, java.lang.String keywords, java.lang.String type, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end) throws SystemException
search(long, long, String,
LinkedHashMap, int, int, Sort) instead of this method wherever possible
for performance reasons.
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 organization's companyparentOrganizationId - the primary key of the organization's parent
organizationkeywords - the keywords (space separated), which may occur in the
organization's name, street, city, or zipcode (optionally
null)type - the organization's type (optionally null)regionId - the primary key of the organization's region (optionally
null)countryId - the primary key of the organization's country
(optionally null)params - the finder params. For more information see OrganizationFinderstart - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)SystemException - if a system exception occurredOrganizationFinder@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> search(long companyId, long parentOrganizationId, java.lang.String keywords, java.lang.String type, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc) throws SystemException
search(long, long, String,
String, String, String, String, String, String, LinkedHashMap, boolean,
int, int, Sort) instead of this method wherever possible for performance
reasons.
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 organization's companyparentOrganizationId - the primary key of the organization's parent
organizationkeywords - the keywords (space separated), which may occur in the
organization's name, street, city, or zipcode (optionally
null)type - the organization's type (optionally null)regionId - the primary key of the organization's region (optionally
null)countryId - the primary key of the organization's country
(optionally null)params - the finder params. For more information see OrganizationFinderstart - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)obc - the comparator to order the organizations (optionally
null)obcSystemException - if a system exception occurredOrganizationFinder@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> search(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end) throws SystemException
search(long, long, String, String,
String, String, String, String, String, LinkedHashMap, boolean, int, int,
Sort) instead of this method wherever possible for performance reasons.
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 organization's companyparentOrganizationId - the primary key of the organization's parentname - the name keywords (space separated, optionally
null)type - the organization's type (optionally null)street - the street keywords (optionally null)city - the city keywords (optionally null)zip - the zipcode keywords (optionally null)regionId - the primary key of the organization's region (optionally
null)countryId - the primary key of the organization's country
(optionally null)params - the finder parameters (optionally null). For
more information see OrganizationFinderandOperator - whether every field must match its keywords, or just
one field. For example, "organizations with the name
'Employees' and city 'Chicago'" vs "organizations with
the name 'Employees' or the city 'Chicago'".start - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)SystemException - if a system exception occurredOrganizationFinder@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Organization> search(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator obc) throws SystemException
search(long, long, String, String, String,
String, String, String, String, LinkedHashMap, boolean, int, int, Sort)
instead of this method wherever possible for performance reasons.
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 organization's companyparentOrganizationId - the primary key of the organization's parent
organizationname - the name keywords (space separated, optionally
null)type - the organization's type (optionally null)street - the street keywords (optionally null)city - the city keywords (optionally null)zip - the zipcode keywords (optionally null)regionId - the primary key of the organization's region (optionally
null)countryId - the primary key of the organization's country
(optionally null)params - the finder parameters (optionally null). For
more information see OrganizationFinderandOperator - whether every field must match its keywords, or just
one field. For example, "organizations with the name
'Employees' and city 'Chicago'" vs "organizations with
the name 'Employees' or the city 'Chicago'".start - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)obc - the comparator to order the organizations (optionally
null)obcSystemException - if a system exception occurredOrganizationFinder@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.String region, java.lang.String country, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, Sort sort) throws SystemException
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 organization's companyparentOrganizationId - the primary key of the organization's parent
organizationname - the name keywords (space separated, optionally
null)type - the type keywords (optionally null)street - the street keywords (optionally null)city - the city keywords (optionally null)zip - the zipcode keywords (optionally null)region - the region keywords (optionally null)country - the country keywords (optionally null)params - the finder parameters (optionally null). For
more information see OrganizationIndexer.andSearch - whether every field must match its keywords or just one
fieldstart - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)sort - the field and direction by which to sort (optionally
null)sortSystemException - if a system exception occurredOrganizationIndexer@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long parentOrganizationId, java.lang.String keywords, java.lang.String type, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params) throws SystemException
companyId - the primary key of the organization's companyparentOrganizationId - the primary key of the organization's parent
organizationkeywords - the keywords (space separated), which may occur in the
organization's name, street, city, or zipcode (optionally
null)type - the organization's type (optionally null)regionId - the primary key of the organization's region (optionally
null)countryId - the primary key of the organization's country
(optionally null)params - the finder parameters (optionally null). For
more information see OrganizationFinderSystemException - if a system exception occurredOrganizationFinder@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long parentOrganizationId, java.lang.String name, java.lang.String type, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.Long regionId, java.lang.Long countryId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator) throws SystemException
companyId - the primary key of the organization's companyparentOrganizationId - the primary key of the organization's parent
organizationname - the name keywords (space separated, optionally
null)type - the organization's type (optionally null)street - the street keywords (optionally null)city - the city keywords (optionally null)zip - the zipcode keywords (optionally null)regionId - the primary key of the organization's region (optionally
null)countryId - the primary key of the organization's country
(optionally null)params - the finder parameters (optionally null). For
more information see OrganizationFinderandOperator - whether every field must match its keywords, or just
one field. For example, "organizations with the name
'Employees' and city 'Chicago'" vs "organizations with
the name 'Employees' or the city 'Chicago'".SystemException - if a system exception occurredOrganizationFindervoid unsetGroupOrganizations(long groupId,
long[] organizationIds)
throws PortalException,
SystemException
groupId - the primary key of the grouporganizationIds - the primary keys of the organizationsPortalException - if a portal exception occurredSystemException - if a system exception occurredvoid unsetPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws SystemException
passwordPolicyId - the primary key of the password policyorganizationIds - the primary keys of the organizationsSystemException - if a system exception occurredvoid updateAsset(long userId,
Organization organization,
long[] assetCategoryIds,
java.lang.String[] assetTagNames)
throws PortalException,
SystemException
userId - the primary key of the userorganization - the organizationassetCategoryIds - the primary keys of the asset categoriesassetTagNames - the asset tag namesPortalException - if a user with the primary key could not be foundSystemException - if a system exception occurredOrganization updateOrganization(long companyId, 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, ServiceContext serviceContext) throws PortalException, SystemException
updateOrganization(long,
long, long, String, String, long, long, int, String, boolean,
ServiceContext)companyId - the primary key of the organization's companyorganizationId - the primary key of the organizationparentOrganizationId - the primary key of 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 or if the new
information was invalidSystemException - if a system exception occurredOrganization updateOrganization(long companyId, long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, int statusId, java.lang.String comments, boolean site, ServiceContext serviceContext) throws PortalException, SystemException
companyId - the primary key of the organization's companyorganizationId - the primary key of the organizationparentOrganizationId - the primary key of 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 or if the new information was
invalidSystemException - if a system exception occurred