FunctionDefinition

Name FunctionDefinition
Usage FunctionRepositoryService FunctionBoService
getFunction getFunctions createFunction updateFunction getFunctionById getFunctionByNameAndNamespace
Type Complex

Description

An immutable representation of a function definition.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Id String The unique identifier for an object. This can be null.     One No  
namespace Namespace String Returns the namespace code of this function definition. All functions
have a namespace and this value can never be null or blank. The
combination of namespace plus name must be unique within the entire
repository of functions.		 Required   One No  
name Name String Returns the name of this function definition. All functions have a name
and this value can never be null or blank. The combination of namespace
plus name must be unique within the entire repository of functions.		 Required   One No  
description Description String Returns the description of this function definition. The description is
intended to provide more information about a function and it's
appropriate usage. The description is optional.		     One No  
returnType Return Type String Returns the type of the return value of the function defined by this
function definition. This can be one of a set of "built-in" data types
or a custom data type represented as a fully qualified java class name.
All functions must have a return type so this method should never return
null or blank.		 Required   One No  
typeId Type Id String Returns the id of the {@link KrmsTypeDefinition} which defines the
actual implementation of this function such that it can be loaded into
the engine and executed.		 Required   One No  
active Active boolean The active indicator for an object. Required   One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.		     One No  
parameters Parameters FunctionParameterDefinitionList Returns an ordered, immutable list of the parameters which this function
definition requires. This list can be empty (in the case of a function
which has no arguments) but will never be null.		     Many No  
categories Categories CategoryDefinitionList Returns an ordered list of the categories which this function
definition requires. This list can be empty (in the case of a function
which has no arguments) but will never be null.		     Many No