gov.nist.hl7.ws.validation.profilevalidation
Interface ProfileValidation


public interface ProfileValidation

This interface provides a simple interface for validating a profile. This interface is intended for use in a web-service environment. Parameters and return values are intentionally made to be simple objects.

Author:
Sydney Henrard (NIST)

Method Summary
 java.lang.String getLastExceptionMessage()
          Get the messsage of the last exception caught
 java.lang.String getProfileValidationReport()
          Get the ProfileValidationReport associated with the previous validation
 boolean setProfile(java.lang.String xmlProfile, java.lang.String profileId)
          Set the Profile
 boolean setProfileValidationContext(java.lang.String xmlProfileValidationContext)
          Set the ProfileValidationContext
 boolean validate()
          Validate the Profile using the ProfileValidationContext.
 

Method Detail

setProfile

boolean setProfile(java.lang.String xmlProfile,
                   java.lang.String profileId)
Set the Profile

Parameters:
xmlProfile - a Profile encoded as an XML String
profileId - an id to identify the Profile (value used in the report)
Returns:
true if the Profile has been set

setProfileValidationContext

boolean setProfileValidationContext(java.lang.String xmlProfileValidationContext)
Set the ProfileValidationContext

Parameters:
xmlProfileValidationContext - a ProfileValidationContext encoded as an XML String
Returns:
true if the ProfileValidationContext has been set

validate

boolean validate()
Validate the Profile using the ProfileValidationContext. If no ProfileValidationContext is set, a default one is used

Returns:
true if the Profile is valid using the ProfileValidationContext

getProfileValidationReport

java.lang.String getProfileValidationReport()
Get the ProfileValidationReport associated with the previous validation

Returns:
a String object that contains an XML report of the profile validation results

getLastExceptionMessage

java.lang.String getLastExceptionMessage()
Get the messsage of the last exception caught

Returns:
a String containing the last exception message