Interface ApplicationConfigService


public interface ApplicationConfigService
  • Method Summary

    Modifier and Type
    Method
    Description
    getSchema(String appInstanceKey)
    This API Method is used for getting the schema of the given application instance key.
    getSchema(SearchCriteria criteria, Map<String,Object> configParams)
    This API Method is used for getting the schema with the given search criteria and configParams , if config params has locale information , this method will return respective Localized basic attributes , otherwise it will take default en-US locale and will return attributes in us English.
  • Method Details

    • getSchema

      Set<BasicAttribute> getSchema(String appInstanceKey) throws AccessDeniedException, Exception
      This API Method is used for getting the schema of the given application instance key.
      Parameters:
      appInstanceKey - - Application instance key.
      Returns:
      Set of BasicAttributes for the given app instance key.
      Throws:
      AccessDeniedException - if logged in user is not authorized to perform this operation.
      Exception - If any other exception occurs while performing this operation.
    • getSchema

      Set<BasicAttribute> getSchema(SearchCriteria criteria, Map<String,Object> configParams) throws AccessDeniedException, Exception
      This API Method is used for getting the schema with the given search criteria and configParams , if config params has locale information , this method will return respective Localized basic attributes , otherwise it will take default en-US locale and will return attributes in us English.
      Parameters:
      criteria - - Currently supports only "AccountSearchAttribute.APPINST_ID.getId()".
      configParams - - Config params can contain locale information.supports Locale object or String with language-country code format for example en-US , if no locale is present , en-US locale will be used. Locale key in config params should be passed with the key "ProvisioningConstants.LOCALE".
      Returns:
      Set of BasicAttributes for the given search criteria and config params.
      Throws:
      AccessDeniedException - If logged in user is not authorized to perform this operation.
      Exception - If any other exception occurs while performing this operation.