Class SAPEntryLocalServiceUtil

java.lang.Object
com.liferay.portal.security.service.access.policy.service.SAPEntryLocalServiceUtil

public class SAPEntryLocalServiceUtil extends Object
Provides the local service utility for SAPEntry. This utility wraps com.liferay.portal.security.service.access.policy.service.impl.SAPEntryLocalServiceImpl 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

    • SAPEntryLocalServiceUtil

      public SAPEntryLocalServiceUtil()
  • Method Details

    • addSAPEntry

      public static SAPEntry addSAPEntry(long userId, String allowedServiceSignatures, boolean defaultSAPEntry, boolean enabled, String name, Map<Locale,String> titleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSAPEntry

      public static SAPEntry addSAPEntry(SAPEntry sapEntry)
      Adds the sap entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect SAPEntryLocalServiceImpl 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:
      sapEntry - the sap entry
      Returns:
      the sap entry that was added
    • checkSystemSAPEntries

      public static void checkSystemSAPEntries(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • createSAPEntry

      public static SAPEntry createSAPEntry(long sapEntryId)
      Creates a new sap entry with the primary key. Does not add the sap entry to the database.
      Parameters:
      sapEntryId - the primary key for the new sap entry
      Returns:
      the new sap entry
    • 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
    • deleteSAPEntry

      public static SAPEntry deleteSAPEntry(long sapEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the sap entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect SAPEntryLocalServiceImpl 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:
      sapEntryId - the primary key of the sap entry
      Returns:
      the sap entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a sap entry with the primary key could not be found
    • deleteSAPEntry

      public static SAPEntry deleteSAPEntry(SAPEntry sapEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the sap entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect SAPEntryLocalServiceImpl 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:
      sapEntry - the sap entry
      Returns:
      the sap entry that was removed
      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.portal.security.service.access.policy.model.impl.SAPEntryModelImpl.

      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.portal.security.service.access.policy.model.impl.SAPEntryModelImpl.

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

      public static SAPEntry fetchSAPEntry(long sapEntryId)
    • fetchSAPEntry

      public static SAPEntry fetchSAPEntry(long companyId, String name)
    • fetchSAPEntryByUuidAndCompanyId

      public static SAPEntry fetchSAPEntryByUuidAndCompanyId(String uuid, long companyId)
      Returns the sap entry with the matching UUID and company.
      Parameters:
      uuid - the sap entry's UUID
      companyId - the primary key of the company
      Returns:
      the matching sap entry, or null if a matching sap entry could not be found
    • getActionableDynamicQuery

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

      public static List<SAPEntry> getCompanySAPEntries(long companyId, int start, int end)
    • getCompanySAPEntries

      public static List<SAPEntry> getCompanySAPEntries(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SAPEntry> orderByComparator)
    • getCompanySAPEntriesCount

      public static int getCompanySAPEntriesCount(long companyId)
    • getDefaultSAPEntries

      public static List<SAPEntry> getDefaultSAPEntries(long companyId, boolean defaultSAPEntry)
    • 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()
    • 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
    • getSAPEntries

      public static List<SAPEntry> getSAPEntries(int start, int end)
      Returns a range of all the sap 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.portal.security.service.access.policy.model.impl.SAPEntryModelImpl.

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

      public static int getSAPEntriesCount()
      Returns the number of sap entries.
      Returns:
      the number of sap entries
    • getSAPEntry

      public static SAPEntry getSAPEntry(long sapEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the sap entry with the primary key.
      Parameters:
      sapEntryId - the primary key of the sap entry
      Returns:
      the sap entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a sap entry with the primary key could not be found
    • getSAPEntry

      public static SAPEntry getSAPEntry(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSAPEntryByUuidAndCompanyId

      public static SAPEntry getSAPEntryByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the sap entry with the matching UUID and company.
      Parameters:
      uuid - the sap entry's UUID
      companyId - the primary key of the company
      Returns:
      the matching sap entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching sap entry could not be found
    • updateSAPEntry

      public static SAPEntry updateSAPEntry(long sapEntryId, String allowedServiceSignatures, boolean defaultSAPEntry, boolean enabled, String name, Map<Locale,String> titleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSAPEntry

      public static SAPEntry updateSAPEntry(SAPEntry sapEntry)
      Updates the sap entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SAPEntryLocalServiceImpl 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:
      sapEntry - the sap entry
      Returns:
      the sap entry that was updated
    • getService

      public static SAPEntryLocalService getService()