Interface ObjectFolderLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
ObjectFolderLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddObjectFolder(ObjectFolder objectFolder) Adds the object folder to the database.addObjectFolder(String externalReferenceCode, long userId, Map<Locale, String> labelMap, String name) createObjectFolder(long objectFolderId) Creates a new object folder with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) voiddeleteCompanyObjectFolders(long companyId) deleteObjectFolder(long objectFolderId) Deletes the object folder with the primary key from the database.deleteObjectFolder(ObjectFolder objectFolder) Deletes the object folder from the database.com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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.fetchDefaultObjectFolder(long companyId) fetchObjectFolder(long objectFolderId) fetchObjectFolder(long companyId, String name) fetchObjectFolderByExternalReferenceCode(String externalReferenceCode, long companyId) fetchObjectFolderByUuidAndCompanyId(String uuid, long companyId) Returns the object folder with the matching UUID and company.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerygetDefaultObjectFolder(long companyId) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerygetObjectFolder(long objectFolderId) Returns the object folder with the primary key.getObjectFolder(long companyId, String name) getObjectFolderByExternalReferenceCode(String externalReferenceCode, long companyId) getObjectFolderByUuidAndCompanyId(String uuid, long companyId) Returns the object folder with the matching UUID and company.getObjectFolders(int start, int end) Returns a range of all the object folders.intReturns the number of object folders.intgetObjectFoldersCount(long companyId) getOrAddDefaultObjectFolder(long companyId) Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) updateObjectFolder(ObjectFolder objectFolder) Updates the object folder in the database or adds it if it does not yet exist.updateObjectFolder(String externalReferenceCode, long objectFolderId, Map<Locale, String> labelMap) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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
@Indexable(type=REINDEX) 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
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteCompanyObjectFolders
void deleteCompanyObjectFolders(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteObjectFolder
@Indexable(type=DELETE) 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
@Indexable(type=DELETE) @SystemEvent(type=1) 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
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
@Transactional(propagation=SUPPORTS, readOnly=true) <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchDefaultObjectFolder(long companyId) -
fetchObjectFolder
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchObjectFolder(long objectFolderId) -
fetchObjectFolder
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchObjectFolder(long companyId, String name) -
fetchObjectFolderByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchObjectFolderByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchObjectFolderByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchObjectFolderByUuidAndCompanyId(String uuid, long companyId) 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
nullif a matching object folder could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDefaultObjectFolder
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder getDefaultObjectFolder(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getObjectFolder
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder getObjectFolder(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getObjectFolderByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder getObjectFolderByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getObjectFolderByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectFolder> getObjectFolders(int start, int end) Returns a range of all the object folders.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
@Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFoldersCount()Returns the number of object folders.- Returns:
- the number of object folders
-
getObjectFoldersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFoldersCount(long companyId) -
getOrAddDefaultObjectFolder
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder getOrAddDefaultObjectFolder(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- 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
@Indexable(type=REINDEX) ObjectFolder updateObjectFolder(String externalReferenceCode, long objectFolderId, Map<Locale, String> labelMap) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-