Package com.sap.cds.services.mt

Interface SaasRegistryUnsubscriptionOptions

All Superinterfaces:
com.sap.cds.CdsData, com.sap.cds.JSONizable, Map<String,Object>
public interface SaasRegistryUnsubscriptionOptions extends com.sap.cds.CdsData
This interface provides named and type safe access to the options provided by UnsubscribeEventContext.getOptions().

  • Method Details

    • create

      static SaasRegistryUnsubscriptionOptions create()
      Creates a new SaasRegistryUnsubscriptionOptions
      Returns:
      the SaasRegistryUnsubscriptionOptions

    • create

      static SaasRegistryUnsubscriptionOptions create(Map<String,Object> options)
      Creates a SaasRegistryUnsubscriptionOptions view over an existing options map.
      Parameters:
      options - the options map
      Returns:
      the SaasRegistryUnsubscriptionOptions view

    • getSubscriptionGUID

      String getSubscriptionGUID()
      Unique identifier of the subscription.
      Returns:
      unique identifier of the subscription.

    • getSubscriptionAppId

      String getSubscriptionAppId()
      The application ID of the main subscribed application. Generated by XSUAA based on the xsappname.
      Returns:
      the application ID of the main subscribed application.

    • getSubscriptionAppName

      String getSubscriptionAppName()
      The name of the main subscribed application, in the SaaS Provisioning.
      Returns:
      the name of the main subscribed application, in the SaaS Provisioning.

    • getSubscribedTenantId

      String getSubscribedTenantId()
      The ID of the subscribed consumer XSUAA tenant.
      Returns:
      the ID of the subscribed consumer XSUAA tenant.

    • getSubscribedZoneId

      String getSubscribedZoneId()
      The ID of the subscribed consumer zone. This field might be missing for subaccounts that were created before the Zone ID was introduced.
      Returns:
      The ID of the subscribed consumer zone.

    • getSubscribedLicenseType

      String getSubscribedLicenseType()
      The License Type of the subscription consumer tenant. Values: UNDEFINED | CONSUMER | DEVELOPER | CUSTOMER | PARTNER | SAPDEV | SAPPROD | CUSTOMER_BETA | SYSTEM | SFSF_EXT_EVAL | TRIAL.
      Returns:
      The License Type of the subscription consumer tenant.

    • getSubscribedCrmId

      String getSubscribedCrmId()
      The CRM ID of the customer whose global account and subaccount triggered the subscription.
      Returns:
      The CRM ID of the customer whose global account and subaccount triggered the subscription.

    • getSubscribedSubdomain

      String getSubscribedSubdomain()
      The Subdomain of the subscription consumer tenant (hostname for the identityzone).
      Returns:
      The Subdomain of the subscription consumer tenant (hostname for the identityzone).

    • getSubscribedSubaccountId

      String getSubscribedSubaccountId()
      The ID of the subaccount related to the consumer tenant.
      Returns:
      The ID of the subaccount related to the consumer tenant.

    • getSubscriptionAppPlan

      String getSubscriptionAppPlan()
      The plan of the main subscribed application, as defined in CIS. If the app is not registered in the CIS catalog, or if the subscription flow is part of the "Stack Services", the subscriptionAppPlan would be null.
      Returns:
      The plan of the main subscribed application or null.

    • getSubscriptionAppAmount

      String getSubscriptionAppAmount()
      The Amount that the customer is entitled to, in CIS.
      Returns:
      The Amount that the customer is entitled to.

    • getDependentServiceInstanceAppIds

      List<String> getDependentServiceInstanceAppIds()
      The List of App IDs, generated and returned by XSUAA when creating a subscription of a service instance (aka cloning). The App ID is a combination of some prefix and client ID of the subscribed service instance. This is relevant only for the PaaS Multitenancy scenario (aka stack services), therefore this list will be empty for SaaS applications.
      Returns:
      The List of App IDs, generated and returned by XSUAA when creating a subscription of a service instance.

    • getGlobalAccountGUID

      String getGlobalAccountGUID()
      The ID of the subscribed consumer global account.
      Returns:
      The ID of the subscribed consumer global account.

    • getProviderSubaccountId

      String getProviderSubaccountId()
      The subaccount ID from which this app is provided.
      Returns:
      the subaccount ID from which this app is provided.

    • getUserId

      String getUserId()
      The ID of the user who triggered the subscription from the cockpit (can be a clientId in case of client credentials flow).
      Returns:
      The ID of the user who triggered the subscription from the cockpit.

    • getUserInfo

      SaasRegistryTriggeredByInfo getUserInfo()
      This section may contain additional information on the user that triggered the unsubscription. This field is only relevant for accounts with "feature set B". If you use an account with "feature set A" this field does not exist.
      Returns:
      additional information on the user that triggered the unsubscription or null.

    • getSubscriptionParams

      Map<Object,Object> getSubscriptionParams()
      The parameters entered by the user upon subscription to your app.
      Returns:
      The parameters entered by the user upon subscription to your app.