de.smartics.properties.api.core.domain
Interface PropertyContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

MandatoryPropertyContext

public interface PropertyContext
     
     

      
      extends 
      
      Serializable
     
     

Provides context information for a given property.

Where PropertiesContext provides context information for all properties that are of that context (i.e. loaded from the same archive), instances of this class provide convenient access to that context information by storing the key (i.e. the descriptor) for further requests. Clients are therefore only required to reference the property context instance and not the properties context instance together with the property descriptor.

Method Summary

String	getHomePageUrl() Returns the URL to the home page of the project.
String	getHomePageUrl(Locale locale) Returns the URL to the home page of the project in the given locale.
PropertiesContext	getPropertiesContext() Returns the context of the properties.
String	getPropertiesReportIndexUrl() Returns the URL to the index document of properties reports.
String	getPropertiesReportIndexUrl(Locale locale) Returns the URL to the index document of properties reports.
String	getPropertiesReportUrl() Returns the URL to the root directory of properties reports.
String	getPropertiesReportUrl(Locale locale) Returns the URL to the root directory of properties reports.
String	getPropertyReportUrl() Returns the URL to the report documentation for the given descriptor.
String	getPropertyReportUrl(Locale locale) Returns the URL to the report documentation for the given descriptor.
List<Locale>	getSupportedLocales() Returns the list of supported locales.

Method Detail

getPropertiesContext

PropertiesContext getPropertiesContext()

Returns the context of the properties.

Returns:

the context of the properties.

getHomePageUrl

String getHomePageUrl()

Returns the URL to the home page of the project.

Returns:

the URL to the home page of the project.

getHomePageUrl

String getHomePageUrl(Locale locale)

Returns the URL to the home page of the project in the given locale. Returns a default URL, if the given locale is not supported.

Parameters:

locale - the identifier of the requested localized resource.

Returns:

the URL to the home page of the project.

getPropertiesReportIndexUrl

String getPropertiesReportIndexUrl()

Returns the URL to the index document of properties reports.

Returns:

the URL to the index document of properties reports.

getPropertiesReportIndexUrl

String getPropertiesReportIndexUrl(Locale locale)

Returns the URL to the index document of properties reports.

Parameters:

locale - the identifier of the requested localized resource.

Returns:

the URL to the index document of properties reports.

getPropertiesReportUrl

String getPropertiesReportUrl()

Returns the URL to the root directory of properties reports.

Returns:

the URL to the root directory of properties reports.

getPropertiesReportUrl

String getPropertiesReportUrl(Locale locale)

Returns the URL to the root directory of properties reports.

Parameters:

locale - the identifier of the requested localized resource.

Returns:

the URL to the root directory of properties reports.

getPropertyReportUrl

String getPropertyReportUrl()

Returns the URL to the report documentation for the given descriptor.

Returns:

the absolute URL to the report.

getPropertyReportUrl

String getPropertyReportUrl(Locale locale)

Returns the URL to the report documentation for the given descriptor.

Parameters:

locale - the identifier of the requested localized resource.

Returns:

the absolute URL to the report.

getSupportedLocales

List<Locale> getSupportedLocales()

Returns the list of supported locales. The list contains locales the context provides localized information for.

Returns:

the list of supported locales.