@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface CompanyLocalService extends BaseLocalService, PersistedModelLocalService
CompanyLocalServiceUtil
,
CompanyLocalServiceBaseImpl
,
CompanyLocalServiceImpl
Modifier and Type | Method and Description |
---|---|
Company |
addCompany(Company company)
Adds the company to the database.
|
Company |
addCompany(String webId,
String virtualHostname,
String mx,
boolean system,
int maxUsers,
boolean active)
Adds a company.
|
Company |
checkCompany(String webId)
Returns the company with the web domain.
|
Company |
checkCompany(String webId,
String mx)
Returns the company with the web domain and mail domain.
|
void |
checkCompanyKey(long companyId)
Checks if the company has an encryption key.
|
Company |
createCompany(long companyId)
Creates a new company with the primary key.
|
Company |
deleteCompany(Company company)
Deletes the company from the database.
|
Company |
deleteCompany(long companyId)
Deletes the company with the primary key from the database.
|
Company |
deleteLogo(long companyId)
Deletes the company's logo.
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
DynamicQuery |
dynamicQuery() |
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> 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 matching the dynamic query.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
Company |
fetchCompany(long companyId) |
Company |
fetchCompanyById(long companyId)
Returns the company with the primary key.
|
Company |
fetchCompanyByVirtualHost(String virtualHostname)
Returns the company with the virtual host name.
|
ActionableDynamicQuery |
getActionableDynamicQuery() |
List<Company> |
getCompanies()
Returns all the companies.
|
List<Company> |
getCompanies(boolean system)
Returns all the companies used by WSRP.
|
List<Company> |
getCompanies(boolean system,
int start,
int end) |
List<Company> |
getCompanies(int start,
int end)
Returns a range of all the companies.
|
int |
getCompaniesCount()
Returns the number of companies.
|
int |
getCompaniesCount(boolean system)
Returns the number of companies used by WSRP.
|
Company |
getCompany(long companyId)
Returns the company with the primary key.
|
Company |
getCompanyById(long companyId)
Returns the company with the primary key.
|
Company |
getCompanyByLogoId(long logoId)
Returns the company with the logo.
|
Company |
getCompanyByMx(String mx)
Returns the company with the mail domain.
|
Company |
getCompanyByVirtualHost(String virtualHostname)
Returns the company with the virtual host name.
|
Company |
getCompanyByWebId(String webId)
Returns the company with the web domain.
|
long |
getCompanyIdByUserId(long userId)
Returns the user's company.
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
void |
removePreferences(long companyId,
String[] keys)
Removes the values that match the keys of the company's preferences.
|
Hits |
search(long companyId,
long userId,
String keywords,
int start,
int end)
Returns an ordered range of all assets that match the keywords in the
company.
|
Hits |
search(long companyId,
long userId,
String portletId,
long groupId,
String type,
String keywords,
int start,
int end)
Returns an ordered range of all assets that match the keywords in the
portlet within the company.
|
Company |
updateCompany(Company company)
Updates the company in the database or adds it if it does not yet exist.
|
Company |
updateCompany(long companyId,
String virtualHostname,
String mx,
int maxUsers,
boolean active)
Updates the company.
|
Company |
updateCompany(long companyId,
String virtualHostname,
String mx,
String homeURL,
boolean logo,
byte[] logoBytes,
String name,
String legalName,
String legalId,
String legalType,
String sicCode,
String tickerSymbol,
String industry,
String type,
String size)
Update the company with additional account information.
|
Company |
updateCompany(long companyId,
String virtualHostname,
String mx,
String homeURL,
String name,
String legalName,
String legalId,
String legalType,
String sicCode,
String tickerSymbol,
String industry,
String type,
String size)
Deprecated.
As of Wilberforce (7.0.x), replaced by
updateCompany(long, String, String, String, boolean, byte[],
String, String, String, String, String, String, String,
String, String) |
void |
updateDisplay(long companyId,
String languageId,
String timeZoneId)
Update the company's display.
|
void |
updateDisplayGroupNames(long companyId) |
Company |
updateLogo(long companyId,
byte[] bytes)
Updates the company's logo.
|
Company |
updateLogo(long companyId,
File file)
Updates the company's logo.
|
Company |
updateLogo(long companyId,
InputStream is)
Update the company's logo.
|
void |
updatePreferences(long companyId,
UnicodeProperties properties)
Updates the company's preferences.
|
void |
updateSecurity(long companyId,
String authType,
boolean autoLogin,
boolean sendPassword,
boolean strangers,
boolean strangersWithMx,
boolean strangersVerify,
boolean siteLogo)
Updates the company's security properties.
|
@Indexable(type=REINDEX) Company addCompany(Company company)
company
- the companyCompany addCompany(String webId, String virtualHostname, String mx, boolean system, int maxUsers, boolean active) throws PortalException
webId
- the the company's web domainvirtualHostname
- the company's virtual host namemx
- the company's mail domainsystem
- whether the company is the very first company (i.e., the
super company)maxUsers
- the max number of company users (optionally
0
)active
- whether the company is activePortalException
Company checkCompany(String webId) throws PortalException
webId
- the company's web domainPortalException
@Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) Company checkCompany(String webId, String mx) throws PortalException
webId
- the company's web domainmx
- the company's mail domainPortalException
void checkCompanyKey(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
@Transactional(enabled=false) Company createCompany(long companyId)
companyId
- the primary key for the new company@Indexable(type=DELETE) Company deleteCompany(Company company) throws PortalException
company
- the companyPortalException
@Indexable(type=DELETE) Company deleteCompany(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
- if a company with the primary key could not be foundCompany deleteLogo(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, 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. 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 CompanyModelImpl
. 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)@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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 CompanyModelImpl
. 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
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) Company fetchCompany(long companyId)
@Transactional(propagation=SUPPORTS, readOnly=true) Company fetchCompanyById(long companyId)
companyId
- the primary key of the companynull
if a company
with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Company fetchCompanyByVirtualHost(String virtualHostname)
virtualHostname
- the virtual host namenull
if a
company with the virtual host could not be found@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Company> getCompanies()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Company> getCompanies(boolean system)
system
- whether the company is the very first company (i.e., the
super company)@Transactional(propagation=SUPPORTS, readOnly=true) List<Company> getCompanies(boolean system, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Company> getCompanies(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. 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 CompanyModelImpl
. 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 companiesend
- the upper bound of the range of companies (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) int getCompaniesCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getCompaniesCount(boolean system)
system
- whether the company is the very first company (i.e., the
super company)@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompany(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
- if a company with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyById(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByLogoId(long logoId) throws PortalException
logoId
- the ID of the company's logoPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByMx(String mx) throws PortalException
mx
- the company's mail domainPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByVirtualHost(String virtualHostname) throws PortalException
virtualHostname
- the company's virtual host namePortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Company getCompanyByWebId(String webId) throws PortalException
webId
- the company's web domainPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) long getCompanyIdByUserId(long userId) throws Exception
userId
- the primary key of the user0
otherwiseException
- if a user with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
PortalException
void removePreferences(long companyId, String[] keys)
com.liferay.portlet.portalsettings.action.EditLDAPServerAction
remotely
through CompanyService
.companyId
- the primary key of the companykeys
- the company's preferences keys to be remove@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long companyId, long userId, String keywords, int start, int end)
PortalOpenSearchImpl
which is not longer used
by the Search portlet.companyId
- the primary key of the companyuserId
- the primary key of the userkeywords
- the keywords (space separated),which may occur in assets
in the company (optionally null
)start
- the lower bound of the range of assets to returnend
- the upper bound of the range of assets to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long companyId, long userId, String portletId, long groupId, String type, String keywords, int start, int end)
companyId
- the primary key of the companyuserId
- the primary key of the userportletId
- the primary key of the portlet (optionally
null
)groupId
- the primary key of the group (optionally 0
)type
- the mime type of assets to return(optionally
null
)keywords
- the keywords (space separated), which may occur in any
assets in the portlet (optionally null
)start
- the lower bound of the range of assets to returnend
- the upper bound of the range of assets to return (not
inclusive)@Indexable(type=REINDEX) Company updateCompany(Company company)
company
- the companyCompany updateCompany(long companyId, String virtualHostname, String mx, int maxUsers, boolean active) throws PortalException
companyId
- the primary key of the companyvirtualHostname
- the company's virtual host namemx
- the company's mail domainmaxUsers
- the max number of company users (optionally
0
)active
- whether the company is activePortalException
Company updateCompany(long companyId, String virtualHostname, String mx, String homeURL, boolean logo, byte[] logoBytes, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size) throws PortalException
companyId
- the primary key of the companyvirtualHostname
- the company's virtual host namemx
- the company's mail domainhomeURL
- the company's home URL (optionally null
)logo
- whether to update the company's logologoBytes
- the new logo image dataname
- the company's account name(optionally null
)legalName
- the company's account legal name (optionally
null
)legalId
- the company's account legal ID (optionally
null
)legalType
- the company's account legal type (optionally
null
)sicCode
- the company's account SIC code (optionally
null
)tickerSymbol
- the company's account ticker symbol (optionally
null
)industry
- the company's account industry (optionally
null
)type
- the company's account type (optionally null
)size
- the company's account size (optionally null
)PortalException
@Deprecated Company updateCompany(long companyId, String virtualHostname, String mx, String homeURL, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size) throws PortalException
updateCompany(long, String, String, String, boolean, byte[],
String, String, String, String, String, String, String,
String, String)
companyId
- the primary key of the companyvirtualHostname
- the company's virtual host namemx
- the company's mail domainhomeURL
- the company's home URL (optionally null
)name
- the company's account name(optionally null
)legalName
- the company's account legal name (optionally
null
)legalId
- the company's account legal ID (optionally
null
)legalType
- the company's account legal type (optionally
null
)sicCode
- the company's account SIC code (optionally
null
)tickerSymbol
- the company's account ticker symbol (optionally
null
)industry
- the company's account industry (optionally
null
)type
- the company's account type (optionally
null
)size
- the company's account size (optionally
null
)PortalException
void updateDisplay(long companyId, String languageId, String timeZoneId) throws PortalException
companyId
- the primary key of the companylanguageId
- the ID of the company's default user's languagetimeZoneId
- the ID of the company's default user's time zonePortalException
@Async void updateDisplayGroupNames(long companyId) throws PortalException
PortalException
Company updateLogo(long companyId, byte[] bytes) throws PortalException
companyId
- the primary key of the companybytes
- the bytes of the company's logo imagePortalException
Company updateLogo(long companyId, File file) throws PortalException
companyId
- the primary key of the companyfile
- the file of the company's logo imagePortalException
Company updateLogo(long companyId, InputStream is) throws PortalException
companyId
- the primary key of the companyis
- the input stream of the company's logo imagePortalException
void updatePreferences(long companyId, UnicodeProperties properties) throws PortalException
companyId
- the primary key of the companyproperties
- the company's properties. See UnicodeProperties
PortalException
void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo)
companyId
- the primary key of the companyauthType
- the company's method of authenticating usersautoLogin
- whether to allow users to select the "remember me"
featuresendPassword
- whether to allow users to ask the company to send
their passwordstrangers
- whether to allow strangers to create accounts register
themselves in the companystrangersWithMx
- whether to allow strangers to create accounts with
email addresses that match the company mail suffixstrangersVerify
- whether to require strangers who create accounts
to be verified via emailsiteLogo
- whether to allow site administrators to use their own
logo instead of the enterprise logo