org.exoplatform.social.client.api.service
Interface VersionService

All Known Implementing Classes:

VersionServiceImpl

public interface VersionService

VersionService is used to get the latest and supported social rest api version.

Since:

Jun 29, 2011

Author:

hoatle (hoatlevan at gmail dot com)

Method Summary

String	getLatest() Gets the latest social rest api version, this version number should be used as the latest and stable version.
String[]	getSupported() Gets the supported social rest api versions, this is for backward compatible.

Method Detail

getLatest

String getLatest()
                 throws ServiceException

Gets the latest social rest api version, this version number should be used as the latest and stable version. This latest version is consider to include all new features and updates.

Returns:

the latest version

Throws:

ServiceException

getSupported

String[] getSupported()
                      throws ServiceException

Gets the supported social rest api versions, this is for backward compatible. If a client application is using an older social rest api version, it should just work. The array MUST have the latest to oldest order. For example: [v2, v1, v1-beta1], not [v1, v2, v1-beta1]

Returns:

an array of supported versions

Throws:

ServiceException