Package lumis.portal.privacyterm

Interface IPrivacyTermManager

  • All Known Subinterfaces:
    IPrivacyTermManagerSPI
    All Known Implementing Classes:
    PrivacyTermManager
    @StableMinor(version="14.2",
             sinceVersion="12.3")
public interface IPrivacyTermManager
    This interface provides methods to handle privacy terms actions.
    The privacy terms are published using service instances of the service with id lumis.service.privacyterm and become bound to the service instance used to be publish them.
    Thus, any action on the privacy terms depends on a service instance of the privacy term service.
    Also, all actions are performed on the current monitored user. If there's no current monitored user (i.e. IMonitorManager.getCurrentMonitorUserId() returns null), an error will be generated.
    Since:
    12.3.0
    Version:
    $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $

    • Method Detail

      • isAllPurposesOfPrivacyTermAccepted

        boolean isAllPurposesOfPrivacyTermAccepted​(String serviceInstanceId)
                                    throws PortalException
        Returns whether current monitor user has accepted all processing purposes of the privacy term with the given service instance with the given identifier.
        Parameters:
        serviceInstanceId - the service instance identifier.
        Returns:
        whether current monitor user has accepted the privacy term.
        Throws:
        IllegalArgumentException - if the serviceInstanceId parameter is null.
        IllegalArgumentException - if the given service instance identifier does not refer to a service instance of a service with id lumis.service.privacyterm.
        PortalObjectNotFoundException - if there is no service instance with the given identifier.
        IllegalStateException - if there is no current monitored user.
        PortalException - if another error occur.
        Since:
        12.3.0

      • acceptAllPurposesOfPrivacyTerm

        void acceptAllPurposesOfPrivacyTerm​(String serviceInstanceId,
                                    String sourceIp)
                             throws PortalException
        This method is used to make the current monitored user to accept all purposes of the privacy term with the given service instance. If the user has provided the consent, nothing is performed.
        Parameters:
        serviceInstanceId - the service instance identifier.
        sourceIp - the source IP from where the accept request was performed.
        Throws:
        IllegalArgumentException - if the serviceInstanceId parameter is null.
        IllegalArgumentException - if the sourceIp parameter is null.
        IllegalArgumentException - if the given service instance identifier does not refer to a service instance of a service with id lumis.service.privacyterm.
        PortalObjectNotFoundException - if there is no service instance with the given identifier.
        PortalObjectNotFoundException - if there is no published privacy term on the given service instance.
        IllegalStateException - if there is no current monitored user.
        PortalException - if another error occur.
        Since:
        12.3.0

      • revokeConsentOfAllPurposesOfPrivacyTerm

        void revokeConsentOfAllPurposesOfPrivacyTerm​(String serviceInstanceId)
                                      throws PortalException
        Revokes the consent of the current monitored user on all purposes of the privacy term of the given service instance. If the user did not provided the consent, nothing is performed.
        Parameters:
        serviceInstanceId - the service instance identifier.
        Throws:
        IllegalArgumentException - if the serviceInstanceId parameter is null.
        IllegalArgumentException - if the given service instance identifier does not refer to a service instance of a service with id lumis.service.privacyterm.
        PortalObjectNotFoundException - if there is no service instance with the given identifier.
        PortalObjectNotFoundException - if there is no published privacy term on the given service instance.
        IllegalStateException - if there is no current monitored user.
        PortalException - if another error occur.
        Since:
        12.3.0