Class DepotEntryLocalServiceUtil

java.lang.Object
com.liferay.depot.service.DepotEntryLocalServiceUtil

public class DepotEntryLocalServiceUtil extends Object
Provides the local service utility for DepotEntry. This utility wraps com.liferay.depot.service.impl.DepotEntryLocalServiceImpl 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

    • DepotEntryLocalServiceUtil

      public DepotEntryLocalServiceUtil()
  • Method Details

    • addDepotEntry

      public static DepotEntry addDepotEntry(DepotEntry depotEntry)
      Adds the depot entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect DepotEntryLocalServiceImpl 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:
      depotEntry - the depot entry
      Returns:
      the depot entry that was added
    • addDepotEntry

      public static DepotEntry addDepotEntry(com.liferay.portal.kernel.model.Group group, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addDepotEntry

      public static DepotEntry addDepotEntry(Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createDepotEntry

      public static DepotEntry createDepotEntry(long depotEntryId)
      Creates a new depot entry with the primary key. Does not add the depot entry to the database.
      Parameters:
      depotEntryId - the primary key for the new depot entry
      Returns:
      the new depot entry
    • 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
    • deleteDepotEntry

      public static DepotEntry deleteDepotEntry(DepotEntry depotEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the depot entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect DepotEntryLocalServiceImpl 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:
      depotEntry - the depot entry
      Returns:
      the depot entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteDepotEntry

      public static DepotEntry deleteDepotEntry(long depotEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the depot entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect DepotEntryLocalServiceImpl 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:
      depotEntryId - the primary key of the depot entry
      Returns:
      the depot entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a depot entry with the primary key could not be found
    • 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.depot.model.impl.DepotEntryModelImpl.

      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.depot.model.impl.DepotEntryModelImpl.

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

      public static DepotEntry fetchDepotEntry(long depotEntryId)
    • fetchDepotEntryByUuidAndGroupId

      public static DepotEntry fetchDepotEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the depot entry matching the UUID and group.
      Parameters:
      uuid - the depot entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching depot entry, or null if a matching depot entry could not be found
    • fetchGroupDepotEntry

      public static DepotEntry fetchGroupDepotEntry(long groupId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getDepotEntries

      public static List<DepotEntry> getDepotEntries(int start, int end)
      Returns a range of all the depot entries.

      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.depot.model.impl.DepotEntryModelImpl.

      Parameters:
      start - the lower bound of the range of depot entries
      end - the upper bound of the range of depot entries (not inclusive)
      Returns:
      the range of depot entries
    • getDepotEntriesByUuidAndCompanyId

      public static List<DepotEntry> getDepotEntriesByUuidAndCompanyId(String uuid, long companyId)
      Returns all the depot entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the depot entries
      companyId - the primary key of the company
      Returns:
      the matching depot entries, or an empty list if no matches were found
    • getDepotEntriesByUuidAndCompanyId

      public static List<DepotEntry> getDepotEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DepotEntry> orderByComparator)
      Returns a range of depot entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the depot entries
      companyId - the primary key of the company
      start - the lower bound of the range of depot entries
      end - the upper bound of the range of depot entries (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching depot entries, or an empty list if no matches were found
    • getDepotEntriesCount

      public static int getDepotEntriesCount()
      Returns the number of depot entries.
      Returns:
      the number of depot entries
    • getDepotEntry

      public static DepotEntry getDepotEntry(long depotEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the depot entry with the primary key.
      Parameters:
      depotEntryId - the primary key of the depot entry
      Returns:
      the depot entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a depot entry with the primary key could not be found
    • getDepotEntryByUuidAndGroupId

      public static DepotEntry getDepotEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the depot entry matching the UUID and group.
      Parameters:
      uuid - the depot entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching depot entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching depot entry could not be found
    • getDepotEntryGroupRelsByUuidAndCompanyId

      @Deprecated public static List<DepotEntry> getDepotEntryGroupRelsByUuidAndCompanyId(String uuid, long companyId)
      Deprecated.
      As of Cavanaugh (7.4.x)
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getGroupConnectedDepotEntries

      public static List<DepotEntry> getGroupConnectedDepotEntries(long groupId, boolean ddmStructuresAvailable, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroupConnectedDepotEntries

      public static List<DepotEntry> getGroupConnectedDepotEntries(long groupId, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroupConnectedDepotEntriesCount

      public static int getGroupConnectedDepotEntriesCount(long groupId)
    • getGroupDepotEntry

      public static DepotEntry getGroupDepotEntry(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • 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
    • updateDepotEntry

      public static DepotEntry updateDepotEntry(DepotEntry depotEntry)
      Updates the depot entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect DepotEntryLocalServiceImpl 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:
      depotEntry - the depot entry
      Returns:
      the depot entry that was updated
    • updateDepotEntry

      public static DepotEntry updateDepotEntry(long depotEntryId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, Map<String,Boolean> depotAppCustomizationMap, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static DepotEntryLocalService getService()