com.wewebu.ow.server.field
Interface OwFieldProvider

All Known Subinterfaces:
OwHistoryEntry, OwObject, OwObjectLink, OwSearchTemplate, OwSemiVirtualFolder, OwVirtualFolderObject, OwWorkitem, OwWorkitemContainer
All Known Implementing Classes:
OwFileObject, OwObjectEditVersionsView, OwObjectListViewCombined.OwObjectListViewRowCombined, OwObjectListViewEXTJSGrid, OwObjectListViewFilterEXTJSGrid, OwObjectListViewFilterRow, OwObjectListViewRow, OwObjectListViewThumbnails, OwObjectPropertyFormularView, OwObjectPropertyView, OwObjectSkeleton, OwSearchCriteriaView, OwSearchNode.OwSearchNodeFieldProvider, OwSessionHistoryEntry, OwStandardDecoratorObject, OwStandardHistoryEntry, OwStandardSearchTemplate, OwStandardVirtualFolderObjectFactory

public interface OwFieldProvider

Interface for objects that provide fields, like search templates or OwObjects.

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
static int TYPE_AJAX
          type of the fieldprovider is a result list
static int TYPE_CHECKIN_OBJECT
          type of the fieldprovider is a checkin object dialog or view
static int TYPE_CREATE_OBJECT
          type of the fieldprovider is a create object dialog or view
static int TYPE_META_OBJECT
          type of the fieldprovider is a object with metadata
static int TYPE_RESULT_LIST
          type of the fieldprovider is a result list
static int TYPE_SEARCH
          type of the fieldprovider is search object / template
static int TYPE_SMALL
          type of the fieldprovider is small, fields must not use a lot of space
 
Method Summary
 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, e.g.
 Object getFieldProviderSource()
          get the source object that originally provided the fields.
 int getFieldProviderType()
          get the type of field provider can be one or more of 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
 

Field Detail

TYPE_META_OBJECT

static final int TYPE_META_OBJECT
type of the fieldprovider is a object with metadata

See Also:
Constant Field Values

TYPE_SEARCH

static final int TYPE_SEARCH
type of the fieldprovider is search object / template

See Also:
Constant Field Values

TYPE_CREATE_OBJECT

static final int TYPE_CREATE_OBJECT
type of the fieldprovider is a create object dialog or view

See Also:
Constant Field Values

TYPE_CHECKIN_OBJECT

static final int TYPE_CHECKIN_OBJECT
type of the fieldprovider is a checkin object dialog or view

See Also:
Constant Field Values

TYPE_SMALL

static final int TYPE_SMALL
type of the fieldprovider is small, fields must not use a lot of space

See Also:
Constant Field Values

TYPE_RESULT_LIST

static final int TYPE_RESULT_LIST
type of the fieldprovider is a result list

See Also:
Constant Field Values

TYPE_AJAX

static final int TYPE_AJAX
type of the fieldprovider is a result list

See Also:
Constant Field Values
Method Detail

getField

OwField getField(String strFieldClassName_p)
                 throws Exception,
                        OwObjectNotFoundException
get a field with the given field definition class name

Parameters:
strFieldClassName_p - String class name of requested fields
Returns:
OwField or throws OwObjectNotFoundException
Throws:
Exception
OwObjectNotFoundException

setField

void setField(String sName_p,
              Object value_p)
              throws Exception,
                     OwObjectNotFoundException
modify a Field value, but does not save the value right away

Parameters:
sName_p -
value_p -
Throws:
Exception
OwObjectNotFoundException

getSafeFieldValue

Object getSafeFieldValue(String sName_p,
                         Object defaultvalue_p)
retrieve the value of a Field

Parameters:
sName_p -
defaultvalue_p -
Returns:
Object the value of the Field of defaultvalue_p

getFields

Collection getFields()
                     throws Exception
get all the properties in the form

Returns:
Collection of OwField
Throws:
Exception

getFieldProviderType

int getFieldProviderType()
get the type of field provider can be one or more of TYPE_...


getFieldProviderSource

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

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

getFieldProviderName

String getFieldProviderName()
get a name that identifies the field provider, e.g. the name of the underlying JSP page

Returns:
String unique ID / Name of fieldprovider, or null


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.