Interface ObjectStateLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
ObjectStateLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddObjectState
(long userId, long listTypeEntryId, long objectStateFlowId) addObjectState
(ObjectState objectState) Adds the object state to the database.createObjectState
(long objectStateId) Creates a new object state with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) void
deleteListTypeEntryObjectStates
(long listTypeEntryId) deleteObjectState
(long objectStateId) Deletes the object state with the primary key from the database.deleteObjectState
(ObjectState objectState) Deletes the object state from the database.void
deleteObjectStateFlowObjectStates
(long objectStateFlowId) com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(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.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.fetchObjectState
(long objectStateId) fetchObjectStateByUuidAndCompanyId
(String uuid, long companyId) Returns the object state with the matching UUID and company.fetchObjectStateFlowObjectState
(long listTypeEntryId, long objectStateFlowId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getNextObjectStates
(long sourceObjectStateId) getObjectState
(long objectStateId) Returns the object state with the primary key.getObjectStateByUuidAndCompanyId
(String uuid, long companyId) Returns the object state with the matching UUID and company.getObjectStateFlowObjectState
(long listTypeEntryId, long objectStateFlowId) getObjectStateFlowObjectStates
(long objectStateFlowId) getObjectStates
(int start, int end) Returns a range of all the object states.int
Returns the number of object states.Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) updateObjectState
(ObjectState objectState) Updates the object state in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addObjectState
ObjectState addObjectState(long userId, long listTypeEntryId, long objectStateFlowId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addObjectState
Adds the object state to the database. Also notifies the appropriate model listeners.Important: Inspect ObjectStateLocalServiceImpl 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:
objectState
- the object state- Returns:
- the object state that was added
-
createObjectState
Creates a new object state with the primary key. Does not add the object state to the database.- Parameters:
objectStateId
- the primary key for the new object state- Returns:
- the new object state
-
createPersistedModel
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteListTypeEntryObjectStates
void deleteListTypeEntryObjectStates(long listTypeEntryId) -
deleteObjectState
@Indexable(type=DELETE) ObjectState deleteObjectState(long objectStateId) throws com.liferay.portal.kernel.exception.PortalException Deletes the object state with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ObjectStateLocalServiceImpl 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:
objectStateId
- the primary key of the object state- Returns:
- the object state that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a object state with the primary key could not be found
-
deleteObjectState
Deletes the object state from the database. Also notifies the appropriate model listeners.Important: Inspect ObjectStateLocalServiceImpl 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:
objectState
- the object state- Returns:
- the object state that was removed
-
deleteObjectStateFlowObjectStates
void deleteObjectStateFlowObjectStates(long objectStateFlowId) -
deletePersistedModel
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModel
in 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:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in 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 - 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.ObjectStateModelImpl
.- 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 - 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.ObjectStateModelImpl
.- 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
-
fetchObjectState
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectState fetchObjectState(long objectStateId) -
fetchObjectStateByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectState fetchObjectStateByUuidAndCompanyId(String uuid, long companyId) Returns the object state with the matching UUID and company.- Parameters:
uuid
- the object state's UUIDcompanyId
- the primary key of the company- Returns:
- the matching object state, or
null
if a matching object state could not be found
-
fetchObjectStateFlowObjectState
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectState fetchObjectStateFlowObjectState(long listTypeEntryId, long objectStateFlowId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
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() -
getNextObjectStates
@Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectState> getNextObjectStates(long sourceObjectStateId) -
getObjectState
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectState getObjectState(long objectStateId) throws com.liferay.portal.kernel.exception.PortalException Returns the object state with the primary key.- Parameters:
objectStateId
- the primary key of the object state- Returns:
- the object state
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a object state with the primary key could not be found
-
getObjectStateByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectState getObjectStateByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the object state with the matching UUID and company.- Parameters:
uuid
- the object state's UUIDcompanyId
- the primary key of the company- Returns:
- the matching object state
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching object state could not be found
-
getObjectStateFlowObjectState
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectState getObjectStateFlowObjectState(long listTypeEntryId, long objectStateFlowId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getObjectStateFlowObjectStates
@Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectState> getObjectStateFlowObjectStates(long objectStateFlowId) -
getObjectStates
@Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectState> getObjectStates(int start, int end) Returns a range of all the object states.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.ObjectStateModelImpl
.- Parameters:
start
- the lower bound of the range of object statesend
- the upper bound of the range of object states (not inclusive)- Returns:
- the range of object states
-
getObjectStatesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getObjectStatesCount()Returns the number of object states.- Returns:
- the number of object states
-
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:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateObjectState
Updates the object state in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ObjectStateLocalServiceImpl 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:
objectState
- the object state- Returns:
- the object state that was updated
-