com.wewebu.ow.server.app
Interface OwSettingsProperty

All Known Implementing Classes:
OwSettingsPropertyBagWrapper, OwSettingsPropertyBaseImpl, OwSettingsPropertyBoolean, OwSettingsPropertyBPMProxy, OwSettingsPropertyClipboardBehavior, OwSettingsPropertyControl, OwSettingsPropertyDisplayCombo, OwSettingsPropertyInteger, OwSettingsPropertyIntegerCombo, OwSettingsPropertyKeyBoardMapping, OwSettingsPropertyLanguageString, OwSettingsPropertyMasterRoles, OwSettingsPropertyObject, OwSettingsPropertyRefreshBootConfig, OwSettingsPropertyRefreshClassDescriptions, OwSettingsPropertySort, OwSettingsPropertyStartupPlugin, OwSettingsPropertyString, OwSettingsPropertyStringCombo, OwSettingsPropertyStringConfigurationBox, OwSettingsPropertyWindowPositions

public interface OwSettingsProperty

Base interface for a single settings property used in the OwSettings for the plugins.
Unlike configuration node entries, the settings are stored for each user or for a site, where the configuration via getConfigNode is only set during startup.

You can retrieve settings by calling getSafeSetting form within your plugin function, document or view class.

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 String ITEM_VALUE_NODE
          node name of a list item for list properties
 
Method Summary
 String getName()
          get ID of property
 Object getValue()
          get current value of property
 Node getValueNode(Document doc_p)
          return the property value as a DOM Node for serialization
 void init(Node propertyDefinitionNode_p, Node valueNode_p, String strSetName_p)
          set current value of property, to be overridden
 boolean isEditable()
          get flag indicating if property can be edited
 boolean isUser()
          get flag indicating if property can be edited
 void setDefault()
          set the default value
 void setValue(Object value_p)
          set current value of property, to be overridden
 

Field Detail

ITEM_VALUE_NODE

static final String ITEM_VALUE_NODE
node name of a list item for list properties

See Also:
Constant Field Values
Method Detail

setDefault

void setDefault()
set the default value


getValueNode

Node getValueNode(Document doc_p)
return the property value as a DOM Node for serialization

Parameters:
doc_p - DOM Document to add to
Returns:
Node

isUser

boolean isUser()
get flag indicating if property can be edited

Returns:
boolean true = editable

isEditable

boolean isEditable()
get flag indicating if property can be edited

Returns:
boolean true = editable

getName

String getName()
get ID of property

Returns:
String with ID

init

void init(Node propertyDefinitionNode_p,
          Node valueNode_p,
          String strSetName_p)
          throws Exception
set current value of property, to be overridden

Parameters:
propertyDefinitionNode_p - the node which defines the property in the plugin descriptors setting
valueNode_p - the node with the current value
strSetName_p - name of the property set for which the property is created
Throws:
Exception

getValue

Object getValue()
get current value of property

Returns:
Object if isList() is true, Object otherwise

setValue

void setValue(Object value_p)
set current value of property, to be overridden

Parameters:
value_p - Object


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.