org.csapi.jr.se.fw.fw_service.integrity
Interface FwOAM
- All Superinterfaces:
- CsapiInterface, java.io.Serializable
- public interface FwOAM
- extends CsapiInterface
The OAM interface is used to query the system date and time. The service and the framework can synchronise the date and time to a certain extent. Accurate time synchronisation is outside the scope of this API. This interface and the systemDateTimeQuery() method are optional.
Method Summary |
java.lang.String |
systemDateTimeQuery(java.lang.String clientDateAndTime)
This method is used to query the system date and time. |
systemDateTimeQuery
public java.lang.String systemDateTimeQuery(java.lang.String clientDateAndTime)
throws CommonException,
InvalidTimeAndDateFormatException,
PlatformException
- This method is used to query the system date and time. The client (service) passes in its own date and time to the framework. The framework responds with the system date and time.
Returns : This is the system date and time of the framework.
- Parameters:
clientDateAndTime
- This is the date and time of the client (service). The error code P_INVALID_DATE_TIME_FORMAT is returned if the format of the parameter is invalid.
- Throws:
CommonException
- Defines the structure of the exception class which is applicable to all methods.
InvalidTimeAndDateFormatException
- Invalid date and time format provided.
PlatformException
- The implementation detected an internal (for example, communication) error