Package org.opencastproject.smil.api

Interface SmilResponse

All Known Implementing Classes:

SmilResponseImpl

public interface SmilResponse

SmilService response container for Smil and SmilObjects as entities.

Method Summary

Modifier and Type	Method	Description
SmilObject[]	getEntities()	Returns SmilObjects if there are any or throws SmilException.
int	getEntitiesCount()	Returns number of entities defined with this response.
SmilObject	getEntity()	Returns SmilObject if only one entity stored.
Smil	getSmil()	Returns Smil object from response.
String	toXml()	Return XML serialized instance of this SmilResponse.

Method Details

getSmil

Smil getSmil()

Returns Smil object from response.

Returns:

Smil object

getEntitiesCount

int getEntitiesCount()

Returns number of entities defined with this response.

Returns:

number of entities

getEntity

SmilObject getEntity()
              throws SmilException

Returns SmilObject if only one entity stored. Throws SmilException otherwise.

Returns:

SmilObject

Throws:

SmilException - if entities count not one

getEntities

SmilObject[] getEntities()
                  throws SmilException

Returns SmilObjects if there are any or throws SmilException.

Returns:

SmilObjects as array

Throws:

SmilException - if there are no entities defined by response.

toXml

String toXml()
      throws javax.xml.bind.JAXBException

Return XML serialized instance of this SmilResponse.

Returns:

SmilResponse as XML

Throws:

javax.xml.bind.JAXBException - if serialization failed