org.wso2.carbon.dataservices.core.engine

Class OutputElement

java.lang.Object

org.wso2.carbon.dataservices.core.engine.XMLWriterHelper

org.wso2.carbon.dataservices.core.engine.OutputElement

Direct Known Subclasses:

CallQuery, OutputElementGroup, StaticOutputElement

public abstract class OutputElement
extends XMLWriterHelper

Represents an entity which can yield a result, i.e. elements in a result section.

Constructor Summary

Constructors

Constructor and Description
OutputElement(String namespace, Set<String> requiredRoles)
OutputElement(String name, String namespace, Set<String> requiredRoles, String arrayName)
OutputElement(String name, String namespace, Set<String> requiredRoles, String param, String paramType, String arrayName)

Method Summary

Modifier and Type	Method and Description
void	execute(XMLStreamWriter xmlWriter, ExternalParamCollection params, int queryLevel, boolean escapeNonPrintableChar) Executes and writes the contents of this element, given the parameters.
protected abstract void	executeElement(XMLStreamWriter xmlWriter, ExternalParamCollection params, int queryLevel, boolean escapeNonPrintableChar)
String	getArrayName()
String	getName()
String	getParam()
String	getParamType()
Set<String>	getRequiredRoles() Returns the requires roles to view this element.
boolean	isOptional() Checks if this element is optional, if so, this has to be mentioned in the schema for WSDL generation.
boolean	isOptionalOverride()
void	setOptionalOverride(boolean optionalOverride)

Methods inherited from class org.wso2.carbon.dataservices.core.engine.XMLWriterHelper

addAttribute, endElement, getNamespace, setNamespace, startRowElement, startWrapperElement, writeResultElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputElement

public OutputElement(String namespace,
                     Set<String> requiredRoles)

OutputElement

public OutputElement(String name,
                     String namespace,
                     Set<String> requiredRoles,
                     String arrayName)

OutputElement

public OutputElement(String name,
                     String namespace,
                     Set<String> requiredRoles,
                     String param,
                     String paramType,
                     String arrayName)

Method Detail

execute

public void execute(XMLStreamWriter xmlWriter,
                    ExternalParamCollection params,
                    int queryLevel,
                    boolean escapeNonPrintableChar)
             throws DataServiceFault

Executes and writes the contents of this element, given the parameters.

Throws:

DataServiceFault

executeElement

protected abstract void executeElement(XMLStreamWriter xmlWriter,
                                       ExternalParamCollection params,
                                       int queryLevel,
                                       boolean escapeNonPrintableChar)
                                throws DataServiceFault

Throws:

DataServiceFault

getRequiredRoles

public Set<String> getRequiredRoles()

Returns the requires roles to view this element.

isOptional

public boolean isOptional()

Checks if this element is optional, if so, this has to be mentioned in the schema for WSDL generation.

isOptionalOverride

public boolean isOptionalOverride()

setOptionalOverride

public void setOptionalOverride(boolean optionalOverride)

getArrayName

public String getArrayName()

getParam

public String getParam()

getName

public String getName()

getParamType

public String getParamType()