oracle.adf.businesseditor.objects

Interface BusinessObjectFunction

public interface BusinessObjectFunction

A function for a business object. 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 business object function.
java.lang.String	getDescription() Returns the description of the business object function.
java.lang.String	getExample() Returns the example of this business object function.
java.lang.String	getId() Returns the id of this business object function.
java.lang.String	getName() Returns the name of the object.
java.util.Collection<FunctionParameter>	getParameters() Returns a collection of parameters for this function.
boolean	getPrivileged() Returns if this business object function is preivileged.
java.lang.String	getReturnType() Returns the return type of this business object function.
void	setBody(java.lang.String body) Sets the body of this business object function.
void	setDescription(java.lang.String text) Sets the description of the business object function.
void	setExample(java.lang.String example) Sets the example of this business object function.
void	setName(java.lang.String name) Sets the name of this business object function.
void	setPrivileged(boolean privileged) Sets if this business object function is privileged
void	setReturnType(java.lang.String returnType) Sets the return type of this business object function.

Method Detail

setName

void setName(java.lang.String name)

Sets the name of this business object function.

Parameters:

name - name of this business object function

getName

java.lang.String getName()

Returns the name of the object.

Returns:

the name of the object

Throws:

setDescription

void setDescription(java.lang.String text)

Sets the description of the business object function.

Parameters:

text - description of the business object function

Throws:

getDescription

java.lang.String getDescription()

Returns the description of the business object function.

Returns:

the description of the business object function

Throws:

setReturnType

void setReturnType(java.lang.String returnType)

Sets the return type of this business object function.

Parameters:

returnType - return type of this business object function

getReturnType

java.lang.String getReturnType()

Returns the return type of this business object function.

Returns:

the return type of this business object function

setExample

void setExample(java.lang.String example)

Sets the example of this business object function.

Parameters:

example - example of this business object function

getExample

java.lang.String getExample()

Returns the example of this business object function.

Returns:

the example of this business object function

setBody

void setBody(java.lang.String body)

Sets the body of this business object function.

Parameters:

body - body of this business object function

getBody

java.lang.String getBody()

Returns the body of this business object function.

Returns:

the body of this business object function

setPrivileged

void setPrivileged(boolean privileged)

Sets if this business object function is privileged

Parameters:

privileged - if this business object function is privileged

getPrivileged

boolean getPrivileged()

Returns if this business object function is preivileged.

Returns:

if this business object function is preivileged

getId

java.lang.String getId()

Returns the id of this business object function. The id is used to identify this business object function when constructing the groovy expression. For new business object 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