com.axemble.vdoc.sdk.interfaces

Interface IGenericViewTransformer

All Superinterfaces:

Serializable

public interface IGenericViewTransformer
extends Serializable

This class represents a generic view transformer.

Since:

2.1

Version:

1.0, 16/06/2009

Author:

vlygeros

Method Summary

Modifier and Type	Method and Description
void	setCount(int count) Sets the number of elements to return.
void	setIncludeLabels(boolean includeLabels) Allows to include or not the labels.
void	setOffset(int offset) Sets the first element to return.
void	setSecurityApplied(boolean securityApplied) Specifies if the security should be applied.
void	setStart(int start) Sets the start page position.
void	viewToXML(IContext context, Element viewDefinition, OutputStream outputStream) Allows to evaluate a view and transforms the result to an XML stream.

Method Detail

viewToXML

void viewToXML(IContext context,
               Element viewDefinition,
               OutputStream outputStream)
        throws IOException

Allows to evaluate a view and transforms the result to an XML stream.

Parameters:

context - The execution context.

viewDefinition - The view definition.

outputStream - The OutputStream object.

Throws:

IOException - The Exception default exception.

setSecurityApplied

void setSecurityApplied(boolean securityApplied)

Specifies if the security should be applied.

Parameters:

securityApplied - true if the security should be applied, false otherwise.

setIncludeLabels

void setIncludeLabels(boolean includeLabels)

Allows to include or not the labels. By default, the value is set to true.

Parameters:

includeLabels - Set to false to avoid labels inclusion.

setStart

void setStart(int start)

Sets the start page position.

Parameters:

start - The start page to set (1 is the first page).

setCount

void setCount(int count)

Sets the number of elements to return.

Parameters:

count -

setOffset

void setOffset(int offset)

Sets the first element to return.

Parameters:

offset - The first element to set (0 is the first element).