public class ObjectFolderLocalServiceUtil
extends java.lang.Object
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.ObjectFolderLocalService
Constructor and Description |
---|
ObjectFolderLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static ObjectFolder |
addObjectFolder(ObjectFolder objectFolder)
Adds the object folder to the database.
|
static ObjectFolder |
addObjectFolder(java.lang.String externalReferenceCode,
long userId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name) |
static ObjectFolder |
createObjectFolder(long objectFolderId)
Creates a new object folder with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.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 |
dynamicQuery() |
static <T> java.util.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> java.util.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> java.util.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,
java.lang.String name) |
static ObjectFolder |
fetchObjectFolderByExternalReferenceCode(java.lang.String externalReferenceCode,
long companyId) |
static ObjectFolder |
fetchObjectFolderByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object folder with the matching UUID and company.
|
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
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 |
getIndexableActionableDynamicQuery() |
static ObjectFolder |
getObjectFolder(long objectFolderId)
Returns the object folder with the primary key.
|
static ObjectFolder |
getObjectFolder(long companyId,
java.lang.String name) |
static ObjectFolder |
getObjectFolderByExternalReferenceCode(java.lang.String externalReferenceCode,
long companyId) |
static ObjectFolder |
getObjectFolderByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object folder with the matching UUID and company.
|
static java.util.List<ObjectFolder> |
getObjectFolders(int start,
int end)
Returns a range of all the object folders.
|
static int |
getObjectFoldersCount()
Returns the number of object folders.
|
static int |
getObjectFoldersCount(long companyId) |
static ObjectFolder |
getOrAddDefaultObjectFolder(long companyId) |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static ObjectFolderLocalService |
getService() |
static ObjectFolder |
updateObjectFolder(ObjectFolder objectFolder)
Updates the object folder in the database or adds it if it does not yet exist.
|
static ObjectFolder |
updateObjectFolder(java.lang.String externalReferenceCode,
long objectFolderId,
java.util.Map<java.util.Locale,java.lang.String> labelMap) |
public static ObjectFolder addObjectFolder(ObjectFolder objectFolder)
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.
objectFolder
- the object folderpublic static ObjectFolder addObjectFolder(java.lang.String externalReferenceCode, long userId, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectFolder createObjectFolder(long objectFolderId)
objectFolderId
- the primary key for the new object folderpublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void deleteCompanyObjectFolders(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectFolder deleteObjectFolder(long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException
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.
objectFolderId
- the primary key of the object foldercom.liferay.portal.kernel.exception.PortalException
- if a object folder with the primary key could not be foundpublic static ObjectFolder deleteObjectFolder(ObjectFolder objectFolder) throws com.liferay.portal.kernel.exception.PortalException
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.
objectFolder
- the object foldercom.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFolderModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFolderModelImpl
.
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
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static ObjectFolder fetchDefaultObjectFolder(long companyId)
public static ObjectFolder fetchObjectFolder(long objectFolderId)
public static ObjectFolder fetchObjectFolder(long companyId, java.lang.String name)
public static ObjectFolder fetchObjectFolderByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId)
public static ObjectFolder fetchObjectFolderByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the object folder's UUIDcompanyId
- the primary key of the companynull
if a matching object folder could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static ObjectFolder getDefaultObjectFolder(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static ObjectFolder getObjectFolder(long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException
objectFolderId
- the primary key of the object foldercom.liferay.portal.kernel.exception.PortalException
- if a object folder with the primary key could not be foundpublic static ObjectFolder getObjectFolder(long companyId, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectFolder getObjectFolderByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectFolder getObjectFolderByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the object folder's UUIDcompanyId
- the primary key of the companycom.liferay.portal.kernel.exception.PortalException
- if a matching object folder could not be foundpublic static java.util.List<ObjectFolder> getObjectFolders(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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFolderModelImpl
.
start
- the lower bound of the range of object foldersend
- the upper bound of the range of object folders (not inclusive)public static int getObjectFoldersCount()
public static int getObjectFoldersCount(long companyId)
public static ObjectFolder getOrAddDefaultObjectFolder(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectFolder updateObjectFolder(ObjectFolder objectFolder)
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.
objectFolder
- the object folderpublic static ObjectFolder updateObjectFolder(java.lang.String externalReferenceCode, long objectFolderId, java.util.Map<java.util.Locale,java.lang.String> labelMap) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectFolderLocalService getService()