com.anabas.sharedlet
Interface SharedletViewInfo

All Known Implementing Classes:
SharedletViewInfoImpl

public interface SharedletViewInfo

Describes the deployment configuration of a sharedlet view. Each sharedlet view must have a unique ID that distinguish it from other sharedlet view types. For example, in a baseball game sharedlet, the empire view needs an ID that distinguishes it from the pitcher's view, etc.


Method Summary
 ViewConstraints getConstraints(java.lang.String format)
          The view constraints for a particular rendering "surface".
 java.lang.String getID()
           
 java.lang.String[] getSupportedRenderingTypes()
          A list of supported rendering "surfaces" MIME Types.
 

Method Detail

getID

public java.lang.String getID()
Returns:
A unique name for the view within the sharedlet. Should be short and user understandable. Most likely displayed to a user.

getSupportedRenderingTypes

public java.lang.String[] getSupportedRenderingTypes()
A list of supported rendering "surfaces" MIME Types. For example:

Are all valid rendering surfaces. In the text/html case, the view can generate a web page that displays the view. In image/gif, the view can generate an image, etc.
Returns:
A list of supported rendering surfaces.

getConstraints

public ViewConstraints getConstraints(java.lang.String format)
The view constraints for a particular rendering "surface".
Parameters:
format - The MIME Type of the rendering "surface" to get the constraints for.
Returns:
View constraints for a particular format of rendering.