org.gcube.application.reporting
Interface Sequentiable

All Known Subinterfaces:
Modeler
All Known Implementing Classes:
ReportSequence, ReportsModeler

public interface Sequentiable


Method Summary
 boolean addAttributeComponent(String attrName, ArrayList<Box> values, boolean allowMultiselection)
          Add a attribute component to the model instance, allow to specify if is editable or not
 boolean addAttributeComponent(String attrName, ArrayList<Box> values, boolean allowMultiselection, Property... properties)
          Add a attribute component to the model instance, allow to specify if is editable or not
 boolean addHeading(int level)
          add an empty fillable heading
 boolean addHeading(int level, String content)
          add an heading with a non editable content
 boolean addHeading(int level, String content, boolean isReadonly)
           
 boolean addInstruction(String content)
           
 boolean addReference(ReferenceReport ref)
          add the references of a given type
 boolean addTextInput(Property... properties)
          add an empty fillable text input
 boolean addTextInput(String content, boolean isReadOnly, Property... properties)
          add text input
 boolean addTextInput(String content, Property... properties)
          add a text input with some pre entered text
 

Method Detail

addHeading

boolean addHeading(int level)
                   throws IllegalArgumentException
add an empty fillable heading

Parameters:
level - of the heading
Returns:
true if the operation is performed with success, false otherwise
Throws:
IllegalArgumentException - if the heading is not [1, 5]

addHeading

boolean addHeading(int level,
                   String content)
                   throws IllegalArgumentException
add an heading with a non editable content

Parameters:
level - of the heading
content - the content you want to show in the heading
Returns:
true if the operation is performed with success, false otherwise
Throws:
IllegalArgumentException - if the heading is not [1, 5]

addHeading

boolean addHeading(int level,
                   String content,
                   boolean isReadonly)
                   throws IllegalArgumentException
Parameters:
level - of the heading
content - the content you want to show in the heading
isReadonly - tells wether the user can edit the content ot not
Returns:
true if the operation is performed with success, false otherwise
Throws:
IllegalArgumentException - if the heading is not [1, 5]

addTextInput

boolean addTextInput(Property... properties)
add an empty fillable text input

Parameters:
properties - additional properties that one may need, optional
Returns:
true if the operation is performed with success, false otherwise

addTextInput

boolean addTextInput(String content,
                     Property... properties)
add a text input with some pre entered text

Parameters:
content - the content you want to show in the textbox
properties - additional properties that one may need, optional
Returns:
true if the operation is performed with success, false otherwise

addTextInput

boolean addTextInput(String content,
                     boolean isReadOnly,
                     Property... properties)
add text input

Parameters:
content - the content you want to show in the textbox
isReadonly - tells wether the user can edit the content ot not
properties - additional properties that one may need, optional
Returns:
true if the operation is performed with success, false otherwise

addAttributeComponent

boolean addAttributeComponent(String attrName,
                              ArrayList<Box> values,
                              boolean allowMultiselection)
Add a attribute component to the model instance, allow to specify if is editable or not

Parameters:
type - the type of the component
payload - the payload, a text if is a heading or body, an encoded base64 string if an image and so on
isEditable - allow the component to be edited or not

addAttributeComponent

boolean addAttributeComponent(String attrName,
                              ArrayList<Box> values,
                              boolean allowMultiselection,
                              Property... properties)
Add a attribute component to the model instance, allow to specify if is editable or not

Parameters:
type - the type of the component
payload - the payload, a text if is a heading or body, an encoded base64 string if an image and so on
properties - additional properties that one may need, optional
isEditable - allow the component to be edited or not

addReference

boolean addReference(ReferenceReport ref)
add the references of a given type

Parameters:
ref - @see ReferenceReport
Returns:
true if the operation is performed with success, false otherwise

addInstruction

boolean addInstruction(String content)
Parameters:
content -
Returns:


Copyright © 2013. All Rights Reserved.