Class ObjectFolderLocalServiceUtil
com.liferay.object.service.impl.ObjectFolderLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ObjectFolder
addObjectFolder
(ObjectFolder objectFolder) Adds the object folder to the database.static ObjectFolder
addObjectFolder
(String externalReferenceCode, long userId, Map<Locale, String> labelMap, String name) static ObjectFolder
createObjectFolder
(long objectFolderId) Creates a new object folder with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static void
deleteCompanyObjectFolders
(long companyId) static ObjectFolder
deleteObjectFolder
(long objectFolderId) Deletes the object folder with the primary key from the database.static ObjectFolder
deleteObjectFolder
(ObjectFolder objectFolder) Deletes the object folder from the database.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static ObjectFolder
fetchDefaultObjectFolder
(long companyId) static ObjectFolder
fetchObjectFolder
(long objectFolderId) static ObjectFolder
fetchObjectFolder
(long companyId, String name) static ObjectFolder
fetchObjectFolderByExternalReferenceCode
(String externalReferenceCode, long companyId) static ObjectFolder
fetchObjectFolderByUuidAndCompanyId
(String uuid, long companyId) Returns the object folder with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static ObjectFolder
getDefaultObjectFolder
(long companyId) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static ObjectFolder
getObjectFolder
(long objectFolderId) Returns the object folder with the primary key.static ObjectFolder
getObjectFolder
(long companyId, String name) static ObjectFolder
getObjectFolderByExternalReferenceCode
(String externalReferenceCode, long companyId) static ObjectFolder
getObjectFolderByUuidAndCompanyId
(String uuid, long companyId) Returns the object folder with the matching UUID and company.static List<ObjectFolder>
getObjectFolders
(int start, int end) Returns a range of all the object folders.static int
Returns the number of object folders.static int
getObjectFoldersCount
(long companyId) static ObjectFolder
getOrAddDefaultObjectFolder
(long companyId) static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static ObjectFolderLocalService
static ObjectFolder
updateObjectFolder
(ObjectFolder objectFolder) Updates the object folder in the database or adds it if it does not yet exist.static ObjectFolder
updateObjectFolder
(String externalReferenceCode, long objectFolderId, Map<Locale, String> labelMap)
-
Constructor Details
-
ObjectFolderLocalServiceUtil
public ObjectFolderLocalServiceUtil()
-
-
Method Details
-
addObjectFolder
Adds the object folder to the database. Also notifies the appropriate model listeners.Important: Inspect ObjectFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
objectFolder
- the object folder- Returns:
- the object folder that was added
-
addObjectFolder
public static ObjectFolder addObjectFolder(String externalReferenceCode, long userId, Map<Locale, String> labelMap, String name) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createObjectFolder
Creates a new object folder with the primary key. Does not add the object folder to the database.- Parameters:
objectFolderId
- the primary key for the new object folder- Returns:
- the new object folder
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteCompanyObjectFolders
public static void deleteCompanyObjectFolders(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteObjectFolder
public static ObjectFolder deleteObjectFolder(long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException Deletes the object folder with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ObjectFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
objectFolderId
- the primary key of the object folder- Returns:
- the object folder that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a object folder with the primary key could not be found
-
deleteObjectFolder
public static ObjectFolder deleteObjectFolder(ObjectFolder objectFolder) throws com.liferay.portal.kernel.exception.PortalException Deletes the object folder from the database. Also notifies the appropriate model listeners.Important: Inspect ObjectFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
objectFolder
- the object folder- Returns:
- the object folder that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectFolderModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectFolderModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDefaultObjectFolder
-
fetchObjectFolder
-
fetchObjectFolder
-
fetchObjectFolderByExternalReferenceCode
public static ObjectFolder fetchObjectFolderByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchObjectFolderByUuidAndCompanyId
Returns the object folder with the matching UUID and company.- Parameters:
uuid
- the object folder's UUIDcompanyId
- the primary key of the company- Returns:
- the matching object folder, or
null
if a matching object folder could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDefaultObjectFolder
public static ObjectFolder getDefaultObjectFolder(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getObjectFolder
public static ObjectFolder getObjectFolder(long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException Returns the object folder with the primary key.- Parameters:
objectFolderId
- the primary key of the object folder- Returns:
- the object folder
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a object folder with the primary key could not be found
-
getObjectFolder
public static ObjectFolder getObjectFolder(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getObjectFolderByExternalReferenceCode
public static ObjectFolder getObjectFolderByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getObjectFolderByUuidAndCompanyId
public static ObjectFolder getObjectFolderByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the object folder with the matching UUID and company.- Parameters:
uuid
- the object folder's UUIDcompanyId
- the primary key of the company- Returns:
- the matching object folder
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching object folder could not be found
-
getObjectFolders
Returns a range of all the object folders.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectFolderModelImpl
.- Parameters:
start
- the lower bound of the range of object foldersend
- the upper bound of the range of object folders (not inclusive)- Returns:
- the range of object folders
-
getObjectFoldersCount
public static int getObjectFoldersCount()Returns the number of object folders.- Returns:
- the number of object folders
-
getObjectFoldersCount
public static int getObjectFoldersCount(long companyId) -
getOrAddDefaultObjectFolder
public static ObjectFolder getOrAddDefaultObjectFolder(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateObjectFolder
Updates the object folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ObjectFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
objectFolder
- the object folder- Returns:
- the object folder that was updated
-
updateObjectFolder
public static ObjectFolder updateObjectFolder(String externalReferenceCode, long objectFolderId, Map<Locale, String> labelMap) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-