Class ObjectStateLocalServiceUtil

java.lang.Object
com.liferay.object.service.ObjectStateLocalServiceUtil

public class ObjectStateLocalServiceUtil extends Object
Provides the local service utility for ObjectState. This utility wraps com.liferay.object.service.impl.ObjectStateLocalServiceImpl 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 Details

    • ObjectStateLocalServiceUtil

      public ObjectStateLocalServiceUtil()
  • Method Details

    • addObjectState

      public static ObjectState addObjectState(long userId, long listTypeEntryId, long objectStateFlowId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addObjectState

      public static ObjectState addObjectState(ObjectState objectState)
      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

      public static ObjectState createObjectState(long objectStateId)
      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

      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
    • deleteListTypeEntryObjectStates

      public static void deleteListTypeEntryObjectStates(long listTypeEntryId)
    • deleteObjectState

      public static 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

      public static ObjectState deleteObjectState(ObjectState objectState)
      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

      public static void deleteObjectStateFlowObjectStates(long objectStateFlowId)
    • 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

      public 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.
      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 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.ObjectStateModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - 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 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.ObjectStateModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      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 query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchObjectState

      public static ObjectState fetchObjectState(long objectStateId)
    • fetchObjectStateByUuidAndCompanyId

      public static ObjectState fetchObjectStateByUuidAndCompanyId(String uuid, long companyId)
      Returns the object state with the matching UUID and company.
      Parameters:
      uuid - the object state's UUID
      companyId - the primary key of the company
      Returns:
      the matching object state, or null if a matching object state could not be found
    • fetchObjectStateFlowObjectState

      public static ObjectState fetchObjectStateFlowObjectState(long listTypeEntryId, long objectStateFlowId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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()
    • getNextObjectStates

      public static List<ObjectState> getNextObjectStates(long sourceObjectStateId)
    • getObjectState

      public static 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

      public static 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 UUID
      companyId - 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

      public static ObjectState getObjectStateFlowObjectState(long listTypeEntryId, long objectStateFlowId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectStateFlowObjectStates

      public static List<ObjectState> getObjectStateFlowObjectStates(long objectStateFlowId)
    • getObjectStates

      public static 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 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.ObjectStateModelImpl.

      Parameters:
      start - the lower bound of the range of object states
      end - the upper bound of the range of object states (not inclusive)
      Returns:
      the range of object states
    • getObjectStatesCount

      public static int getObjectStatesCount()
      Returns the number of object states.
      Returns:
      the number of object states
    • getOSGiServiceIdentifier

      public static String 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
    • updateObjectState

      public static ObjectState updateObjectState(ObjectState objectState)
      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
    • getService

      public static ObjectStateLocalService getService()