public interface ServiceConfigurationProperties
Title: Open Service Framework
Description: This interface is to be used by any class that needs to work with Service Configuration Properties
.
The interface allows a Service Configuration Object's
scope to narrow and be treated like a service
property collection. It will be implemented by the base abstract AbstractServiceConfigurationObject
as well as
the property run-time registry ConfigurationProperties
. The run-time
implementation only acts on the registry and cannot alter the underlying Service Configuration Object
.
Copyright: Copyright (c) 2008
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
void |
addProperty(ServiceConfigurationProperty property)
Adds a configuration property definition to the structure.
|
void |
addPropertyGroup(java.lang.String groupName)
Adds a property group to the Service definition.
|
boolean |
existsPropertyGroup(java.lang.String groupName)
Verifies is a property group exists in this
Service Configuration Object . |
java.lang.String |
getDefaultPropertyGroup()
Returns the default property group names
main.group . |
java.util.List |
getProperties()
Returns an enumeration of
ServiceConfigurationProperty instances for this configuration. |
java.util.List |
getPropertiesForGroup(java.lang.String groupName)
Returns an enumeration of properties for a specific group.
|
ServiceConfigurationProperty |
getProperty(java.lang.String name)
Gets a property instance by name.
|
java.util.List |
getPropertyGroups()
Returns an enumeration of all property groups.
|
java.util.List |
getPropertyNames()
Returns the list of all configuration property names.
|
boolean |
hasProperty(java.lang.String name)
Checck for the xistence of a configuration property with a certain name.
|
void |
removeAllProperties()
Removes all the property names from the list.
|
void |
removeProperty(java.lang.String name)
Removes a configuration property definition from the structure.
|
void |
removePropertyGroup(java.lang.String groupName)
Removes a property group from the
Service Configuration Object . |
java.lang.String getDefaultPropertyGroup()
main.group
. This group may be deleted
by developers. The method simply returns the default name.void addPropertyGroup(java.lang.String groupName)
ServiceConfigurationProperty.setGroup(String)
method. By default all properties are part of a default group called main.group
. As a convention it is
recommended that group names follow the same format and use the .group
extension.groupName
- String Group name.void removePropertyGroup(java.lang.String groupName)
Service Configuration Object
.groupName
- String Group name.boolean existsPropertyGroup(java.lang.String groupName)
Service Configuration Object
.groupName
- String Group name.True
if the group exists, otherwise false
.java.util.List getPropertyGroups()
java.util.Vector
so that its order would be preserved during serialization. In this way the group list can be used to drive UI Wizard
panel sequences or the order in which Property Cards
display their content.java.util.List getPropertiesForGroup(java.lang.String groupName) throws ServiceConfigurationException
groupName
- String Group name.ServiceConfigurationException
- if a group does not exist or if other processing errors occur.void addProperty(ServiceConfigurationProperty property) throws ServiceConfigurationException
ServiceConfigurationProperty
documentation.property
- ServiceConfigurationProperty A property structure.ServiceConfigurationException
void removeProperty(java.lang.String name) throws ServiceConfigurationException
name
- String A property name.ServiceConfigurationException
ServiceConfigurationProperty getProperty(java.lang.String name) throws ServiceConfigurationException
name
- String The name of a property.ServiceConfigurationException
java.util.List getProperties()
ServiceConfigurationProperty
instances for this configuration.java.util.List getPropertyNames()
void removeAllProperties()
boolean hasProperty(java.lang.String name)
name
- Stringfalse
.Copyright © 2015-2024 StreamScape Technologies. All rights reserved.