gov.nist.hl7.ws.profilevalidation
Interface ProfileValidationInterface

public interface ProfileValidationInterface

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)

setProfile

boolean setProfile(java.lang.String xmlProfile,
                   java.lang.String profileId)
                   throws java.lang.Exception

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

Throws:

java.lang.Exception

setProfileValidationContext

boolean setProfileValidationContext(java.lang.String xmlProfileValidationContext)
                                    throws java.lang.Exception

Set the ProfileValidationContext

Parameters:

xmlProfileValidationContext - a ProfileValidationContext encoded as an XML String

Returns:

true if the ProfileValidationContext has been set

Throws:

java.lang.Exception

validate

boolean validate()
                 throws java.lang.Exception

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

Throws:

java.lang.Exception

getProfileValidationReport

java.lang.String getProfileValidationReport()
                                            throws java.lang.Exception

Get the ProfileValidationReport associated with the previous validation

Returns:

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

Throws:

java.lang.Exception

getLastExceptionMessage

java.lang.String getLastExceptionMessage()

Get the messsage of the last exception caught

Returns:

a String containing the last exception message