com.wewebu.ow.server.field

Class OwSearchNode.OwSearchNodeFieldProvider

java.lang.Object

com.wewebu.ow.server.field.OwSearchNode.OwSearchNodeFieldProvider

All Implemented Interfaces:

OwFieldProvider

Enclosing class:

OwSearchNode

public static class OwSearchNode.OwSearchNodeFieldProvider
extends Object
implements OwFieldProvider

Field provider interface for searches.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Field Summary

Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider

TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL

Constructor Summary

Constructors

Constructor and Description
OwSearchNode.OwSearchNodeFieldProvider(OwSearchNode search_p) create a field provider for the given search

Method Summary

Methods

Modifier and Type	Method and Description
OwField	getField(String strFieldClassName_p) get a field with the given field definition class name
String	getFieldProviderName() get a name that identifies the field provider, can be used to create IDs
Object	getFieldProviderSource() get the source object that originally provided the fields.
int	getFieldProviderType() get the type of field provider as defined with TYPE_...
Collection	getFields() get all the properties in the form
Object	getSafeFieldValue(String sName_p, Object defaultvalue_p) retrieve the value of a Field
void	setField(String sName_p, Object value_p) modify a Field value, but does not save the value right away

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OwSearchNode.OwSearchNodeFieldProvider

public OwSearchNode.OwSearchNodeFieldProvider(OwSearchNode search_p)

create a field provider for the given search

Parameters:

search_p - OwSearchNode

Method Detail

getFieldProviderSource

public Object getFieldProviderSource()

get the source object that originally provided the fields. e.g. the fieldprovider might be a template pattern implementation like a view, where the original provider would still be an OwObject

Specified by:

getFieldProviderSource in interface OwFieldProvider

Returns:

Object the original source object where the fields have been taken, can be a this pointer

getFieldProviderName

public String getFieldProviderName()

get a name that identifies the field provider, can be used to create IDs

Specified by:

getFieldProviderName in interface OwFieldProvider

Returns:

String unique ID / Name of fieldprovider

getField

public OwField getField(String strFieldClassName_p)
                 throws Exception,
                        OwObjectNotFoundException

get a field with the given field definition class name

Specified by:

getField in interface OwFieldProvider

Parameters:

strFieldClassName_p - String class name of requested fields

Returns:

OwField or throws OwObjectNotFoundException

Throws:

Exception

OwObjectNotFoundException

getFieldProviderType

public int getFieldProviderType()

get the type of field provider as defined with TYPE_...

Specified by:

getFieldProviderType in interface OwFieldProvider

setField

public void setField(String sName_p,
            Object value_p)
              throws Exception,
                     OwObjectNotFoundException

modify a Field value, but does not save the value right away

Specified by:

setField in interface OwFieldProvider

Parameters:

sName_p -

value_p -

Throws:

Exception

OwObjectNotFoundException

getSafeFieldValue

public Object getSafeFieldValue(String sName_p,
                       Object defaultvalue_p)

retrieve the value of a Field

Specified by:

getSafeFieldValue in interface OwFieldProvider

Parameters:

sName_p -

defaultvalue_p -

Returns:

Object the value of the Field of defaultvalue_p

getFields

public Collection getFields()
                     throws Exception

get all the properties in the form

Specified by:

getFields in interface OwFieldProvider

Returns:

Collection of OwField

Throws:

Exception