lucee.runtime

Interface Component

All Superinterfaces:

Castable, CFObject, java.lang.Cloneable, Collection, Dumpable, ForEachIteratorable, Iteratorable, java.util.Map, Objects, java.io.Serializable, Sizeable, Struct

public interface Component
extends Struct, Objects, CFObject

interface for a Component

Nested Class Summary

Nested classes/interfaces inherited from interface lucee.runtime.type.Collection

Collection.Key

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCESS_COUNT Field ACCESS_COUNT
static int	ACCESS_PACKAGE Constant for Access Mode Package
static int	ACCESS_PRIVATE Constant for Access Mode Private
static int	ACCESS_PUBLIC Constant for Access Mode Public
static int	ACCESS_REMOTE Constant for Access Mode Remote

Fields inherited from interface lucee.runtime.type.Struct

TYPE_LINKED, TYPE_REGULAR, TYPE_SOFT, TYPE_SYNC, TYPE_WEAKED

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	call(PageContext pc, java.lang.String key, java.lang.Object[] args) call a method of the component with no named arguments
java.lang.Object	callWithNamedValues(PageContext pc, java.lang.String key, Struct args) call a method of the component with named arguments
boolean	contains(PageContext pc, Collection.Key key)
boolean	equalTo(java.lang.String type)
java.lang.String	getAbsName()
java.lang.String	getBaseAbsName()
java.lang.String	getCallName()
ComponentScope	getComponentScope()
java.lang.String	getDisplayName()
java.lang.String	getExtends()
java.lang.String	getHint()
java.lang.Class	getJavaAccessClass(RefBoolean isNew) returns java class to the component interface (all UDFs), this class is generated dynamic when used
Struct	getMetaData(PageContext pc) returns Meta Data to the Component
java.lang.String	getName()
boolean	getOutput()
PageSource	getPageSource()
Property[]	getProperties(boolean onlyPeristent) return all properties from component
java.lang.String	getWSDLFile()
boolean	instanceOf(java.lang.String type) check if Component is instance of this type
boolean	isBasePeristent()
boolean	isValidAccess(int access) check if value is a valid access modifier constant
void	registerUDF(Collection.Key key, UDF udf)
void	registerUDF(Collection.Key key, UDFProperties props)
void	registerUDF(java.lang.String key, UDF udf)
void	registerUDF(java.lang.String key, UDFProperties props)
void	setProperty(Property property)

Methods inherited from interface lucee.runtime.type.Collection

clear, clone, containsKey, containsKey, duplicate, get, get, get, get, keys, remove, removeEL, set, set, setEL, setEL, size

Methods inherited from interface lucee.runtime.type.Iteratorable

entryIterator, keyIterator, keysAsStringIterator, valueIterator

Methods inherited from interface lucee.runtime.type.ForEachIteratorable

getIterator

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface lucee.runtime.type.Sizeable

sizeOf

Methods inherited from interface lucee.runtime.type.Objects

call, callWithNamedValues, get, get, set, setEL

Methods inherited from interface lucee.runtime.dump.Dumpable

toDumpData

Methods inherited from interface lucee.runtime.op.Castable

castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo

Field Detail

ACCESS_REMOTE

static final int ACCESS_REMOTE

Constant for Access Mode Remote

See Also:

Constant Field Values

ACCESS_PUBLIC

static final int ACCESS_PUBLIC

Constant for Access Mode Public

See Also:

Constant Field Values

ACCESS_PACKAGE

static final int ACCESS_PACKAGE

Constant for Access Mode Package

See Also:

Constant Field Values

ACCESS_PRIVATE

static final int ACCESS_PRIVATE

Constant for Access Mode Private

See Also:

Constant Field Values

ACCESS_COUNT

static final int ACCESS_COUNT

Field ACCESS_COUNT

See Also:

Constant Field Values

Method Detail

getJavaAccessClass

java.lang.Class getJavaAccessClass(RefBoolean isNew)
                                   throws PageException

returns java class to the component interface (all UDFs), this class is generated dynamic when used

Parameters:

isNew -

Throws:

PageException - FUTURE deprecated

getDisplayName

java.lang.String getDisplayName()

Returns:

Returns the display name.

getExtends

java.lang.String getExtends()

Returns:

Returns the Extends.

getHint

java.lang.String getHint()

Returns:

Returns the Hint.

getName

java.lang.String getName()

Returns:

Returns the Name.

getCallName

java.lang.String getCallName()

Returns:

Returns the Name.

getAbsName

java.lang.String getAbsName()

Returns:

Returns the Name.

getOutput

boolean getOutput()

Returns:

Returns the output.

instanceOf

boolean instanceOf(java.lang.String type)

check if Component is instance of this type

Parameters:

type - type to compare as String

Returns:

is instance of this type

isValidAccess

boolean isValidAccess(int access)

check if value is a valid access modifier constant

Parameters:

access -

Returns:

is valid access

getMetaData

Struct getMetaData(PageContext pc)
                   throws PageException

returns Meta Data to the Component

Parameters:

pc -

Returns:

meta data to component

Throws:

PageException

call

java.lang.Object call(PageContext pc,
                    java.lang.String key,
                    java.lang.Object[] args)
                      throws PageException

call a method of the component with no named arguments

Parameters:

pc - PageContext

key - name of the method

args - Arguments for the method

Returns:

return result of the method

Throws:

PageException

callWithNamedValues

java.lang.Object callWithNamedValues(PageContext pc,
                                   java.lang.String key,
                                   Struct args)
                                     throws PageException

call a method of the component with named arguments

Parameters:

pc - PageContext

key - name of the method

args - Named Arguments for the method

Returns:

return result of the method

Throws:

PageException

getProperties

Property[] getProperties(boolean onlyPeristent)

return all properties from component

Parameters:

onlyPeristent - if true return only columns where attribute persistent is not set to false

Returns:

setProperty

void setProperty(Property property)
                 throws PageException

Throws:

PageException

getComponentScope

ComponentScope getComponentScope()

contains

boolean contains(PageContext pc,
               Collection.Key key)

getPageSource

PageSource getPageSource()

getBaseAbsName

java.lang.String getBaseAbsName()

isBasePeristent

boolean isBasePeristent()

equalTo

boolean equalTo(java.lang.String type)

getWSDLFile

java.lang.String getWSDLFile()

registerUDF

void registerUDF(java.lang.String key,
               UDF udf)

registerUDF

void registerUDF(Collection.Key key,
               UDF udf)

registerUDF

void registerUDF(java.lang.String key,
               UDFProperties props)

registerUDF

void registerUDF(Collection.Key key,
               UDFProperties props)