railo.runtime
Interface Component

All Superinterfaces:
Castable, CFObject, Cloneable, Collection, Dumpable, ForEachIteratorable, Iteratorable, Map, Objects, Serializable, Sizeable, Struct
All Known Subinterfaces:
ComponentAccess, ComponentPro
All Known Implementing Classes:
CFCProxy, ComponentAccessProxy, ComponentImpl, ComponentProxy, ComponentWrap, SuperComponent

public interface Component
extends Struct, Objects, CFObject

interface for a Component


Nested Class Summary
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
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 railo.runtime.type.Struct
TYPE_LINKED, TYPE_REGULAR, TYPE_SOFT, TYPE_SYNC, TYPE_WEAKED
 
Method Summary
 Object call(PageContext pc, String key, Object[] args)
          call a method of the component with no named arguments
 Object callWithNamedValues(PageContext pc, String key, Struct args)
          call a method of the component with named arguments
 boolean contains(PageContext pc, Collection.Key key)
           
 boolean equalTo(String type)
           
 String getAbsName()
           
 String getBaseAbsName()
           
 String getCallName()
           
 ComponentScope getComponentScope()
           
 String getDisplayName()
           
 String getExtends()
           
 String getHint()
           
 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
 String getName()
           
 boolean getOutput()
           
 PageSource getPageSource()
           
 Property[] getProperties(boolean onlyPeristent)
          return all properties from component
 String getWSDLFile()
           
 boolean instanceOf(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(String key, UDF udf)
           
 void registerUDF(String key, UDFProperties props)
           
 void setProperty(Property property)
           
 
Methods inherited from interface railo.runtime.type.Collection
clear, clone, containsKey, containsKey, duplicate, get, get, get, get, keys, remove, removeEL, set, set, setEL, setEL, size
 
Methods inherited from interface railo.runtime.type.Iteratorable
entryIterator, keyIterator, keysAsStringIterator, valueIterator
 
Methods inherited from interface railo.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 railo.runtime.type.Sizeable
sizeOf
 
Methods inherited from interface railo.runtime.type.Objects
call, callWithNamedValues, get, get, set, setEL
 
Methods inherited from interface railo.runtime.dump.Dumpable
toDumpData
 
Methods inherited from interface railo.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

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

String getDisplayName()
Returns:
Returns the display name.

getExtends

String getExtends()
Returns:
Returns the Extends.

getHint

String getHint()
Returns:
Returns the Hint.

getName

String getName()
Returns:
Returns the Name.

getCallName

String getCallName()
Returns:
Returns the Name.

getAbsName

String getAbsName()
Returns:
Returns the Name.

getOutput

boolean getOutput()
Returns:
Returns the output.

instanceOf

boolean instanceOf(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

Object call(PageContext pc,
            String key,
            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

Object callWithNamedValues(PageContext pc,
                           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

String getBaseAbsName()

isBasePeristent

boolean isBasePeristent()

equalTo

boolean equalTo(String type)

getWSDLFile

String getWSDLFile()

registerUDF

void registerUDF(String key,
                 UDF udf)

registerUDF

void registerUDF(Collection.Key key,
                 UDF udf)

registerUDF

void registerUDF(String key,
                 UDFProperties props)

registerUDF

void registerUDF(Collection.Key key,
                 UDFProperties props)


Copyright © 2012 Railo