oracle.adf.businesseditor.objects

Interface GlobalFunction

public interface GlobalFunction

A global function. Note that new methods may be added to this interface without notice. Do not extend this interface for custom classes.

Method Summary

Methods

Modifier and Type	Method and Description
FunctionParameter	addParameter(java.lang.String name, java.lang.String type) Adds a parameter to this function.
void	deleteParameter(java.lang.String name) Deletes a parameter from this function.
java.lang.String	getBody() Returns the body of this global function.
java.lang.String	getDescription() Returns the description of the function.
java.lang.String	getExample() Returns the example of this global function.
java.lang.String	getId() Returns the id of this global function.
java.lang.String	getName() Returns the name of this function.
java.util.Collection<FunctionParameter>	getParameters() Returns a collection of parameters for this function.
boolean	getPrivileged() Returns if this global function is preivileged.
java.lang.String	getReturnType() Returns the return type of this global function.
void	setBody(java.lang.String body) Sets the body of this global function.
void	setDescription(java.lang.String text) Sets the description of the function.
void	setExample(java.lang.String example) Sets the example of this global function.
void	setName(java.lang.String name) Sets the name of this function.
void	setPrivileged(boolean privileged) Sets if this global function is privileged
void	setReturnType(java.lang.String returnType) Sets the return type of this global function.

Method Detail

getName

java.lang.String getName()

Returns the name of this function.

Returns:

the name of this function

setName

void setName(java.lang.String name)

Sets the name of this function.

Parameters:

name - name of this function

setReturnType

void setReturnType(java.lang.String returnType)

Sets the return type of this global function.

Parameters:

returnType - return type of this global function

getReturnType

java.lang.String getReturnType()

Returns the return type of this global function.

Returns:

the return type of this global function

setExample

void setExample(java.lang.String example)

Sets the example of this global function.

Parameters:

example - example of this global function

getExample

java.lang.String getExample()

Returns the example of this global function.

Returns:

the example of this global function

setBody

void setBody(java.lang.String body)

Sets the body of this global function.

Parameters:

body - body of this global function

getBody

java.lang.String getBody()

Returns the body of this global function.

Returns:

the body of this global function

setPrivileged

void setPrivileged(boolean privileged)

Sets if this global function is privileged

Parameters:

privileged - if this global function is privileged

getPrivileged

boolean getPrivileged()

Returns if this global function is preivileged.

Returns:

if this global function is preivileged

setDescription

void setDescription(java.lang.String text)

Sets the description of the function.

Parameters:

text - description of the function

Throws:

getDescription

java.lang.String getDescription()

Returns the description of the function.

Returns:

the description of the function

Throws:

getId

java.lang.String getId()

Returns the id of this global function. The id is used to identify this global function when constructing the groovy expression. For new global function, the id is not available until after BusinessEditorManager.commit() is called.

Returns:

getParameters

java.util.Collection<FunctionParameter> getParameters()

Returns a collection of parameters for this function.

Returns:

a collection of parameters for this function

addParameter

FunctionParameter addParameter(java.lang.String name,
                             java.lang.String type)

Adds a parameter to this function.

Parameters:

name - name of the parameter

type - type of the parameter

Returns:

deleteParameter

void deleteParameter(java.lang.String name)

Deletes a parameter from this function.

Parameters:

name - name of the parameter to be deleted

Throws:

oracle.jbo.JboException - if no parameter exists in this function with the given name