net.bioclipse.xws.component.adhoc.function
Class FunctionInformation

java.lang.Object
  extended by net.bioclipse.xws.component.adhoc.function.FunctionInformation

public class FunctionInformation
extends java.lang.Object


Field Summary
static boolean ASYNCHRONOUS
           
static boolean SYNCHRONOUS
           
 
Constructor Summary
FunctionInformation(java.lang.String functionname, java.lang.String description, java.lang.String description_details, java.lang.String input_schema, java.lang.String output_schema, boolean bIsTimeConsuming)
          Initializes a newly created FunctionInformation object.
 
Method Summary
 java.lang.String getFunctionDescription()
          Returns the XMPP Service function description.
 java.lang.String getFunctionName()
          Returns the XMPP Service function name.
 javax.xml.validation.Schema getInputSchema()
          Returns the input XML Schema.
 net.bioclipse.xws.xmpp.iodata.IoDataElement getIoDataSchemata()
          Returns the input/output XML Schemata.
 boolean isTimeConsuming()
          Returns true if this is a time consuming (delayed/asynchronous) XMPP Service function. false otherwise.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ASYNCHRONOUS

public static final boolean ASYNCHRONOUS
See Also:
Constant Field Values

SYNCHRONOUS

public static final boolean SYNCHRONOUS
See Also:
Constant Field Values
Constructor Detail

FunctionInformation

public FunctionInformation(java.lang.String functionname,
                           java.lang.String description,
                           java.lang.String description_details,
                           java.lang.String input_schema,
                           java.lang.String output_schema,
                           boolean bIsTimeConsuming)
Initializes a newly created FunctionInformation object.

Parameters:
functionname - The function name.
description - A short description of the function.
description_details - A more detailed description of the function.
input_schema - The XML Schema of the function input.
output_schema - The XML Schema of the function output.
bIsTimeConsuming - true if this is a time consuming (delayed/asynchronous) XMPP Service function. false otherwise.
Method Detail

getFunctionDescription

public java.lang.String getFunctionDescription()
Returns the XMPP Service function description.

Returns:
The XMPP Service function description.

getFunctionName

public java.lang.String getFunctionName()
Returns the XMPP Service function name.

Returns:
The XMPP Service function name.

isTimeConsuming

public boolean isTimeConsuming()
Returns true if this is a time consuming (delayed/asynchronous) XMPP Service function. false otherwise.

Returns:
true if this is a time consuming (delayed/asynchronous) XMPP Service function. false otherwise.

getIoDataSchemata

public net.bioclipse.xws.xmpp.iodata.IoDataElement getIoDataSchemata()
Returns the input/output XML Schemata.

Returns:
The input/output XML Schemata.

getInputSchema

public javax.xml.validation.Schema getInputSchema()
Returns the input XML Schema.

Returns:
The input XML Schema.