| |
org.eclipse.rse.core.model
Interface IPropertySetContainer
-
All Known Subinterfaces:
-
IConnectorService,
IDelegatingConnectorService,
IFileServiceSubSystem,
IHost,
IProcessServiceSubSystem,
IPropertySet,
IRemoteCmdSubSystem,
IRemoteFileSubSystem,
IRemoteProcessSubSystem,
IRemoteServerLauncher,
IRSEModelObject,
IServerLauncherProperties,
IShellServiceSubSystem,
ISubSystem,
ISystemFilter,
ISystemFilterPool,
ISystemFilterPoolReference,
ISystemFilterString,
ISystemProfile,
ITerminalServiceSubSystem
-
All Known Implementing Classes:
-
AbstractConnectorService,
AbstractDelegatingConnectorService,
AuthenticatingConnectorService,
BasicConnectorService,
DStoreConnectorService,
DummyHost,
FileServiceSubSystem,
Host,
ProcessServiceSubSystem,
PropertyList,
PropertySet,
PropertySetContainer,
RemoteCmdSubSystem,
RemoteFileSubSystem,
RemoteProcessSubSystemImpl,
RemoteServerLauncher,
RSEModelObject,
ServerLauncher,
ShellServiceSubSystem,
StandardConnectorService,
SubSystem,
SystemFilterReference,
SystemReferencedObject,
SystemReferencingObject,
TerminalServiceSubSystem
-
public interface IPropertySetContainer
A property set container is capable of containing property sets. This interface allows for the
addition, retrieval, and deletion of property sets from the container. A property set may have only
one container.
getPropertySets
IPropertySet[] getPropertySets()
- Retrieves an array all property sets known to this container. It will return an empty array if this
container has property sets. The order of these property sets is not dictated by the interface.
-
-
Returns:
- an array of property sets.
getPropertySet
IPropertySet getPropertySet(
String name)
- Retrieves a particular property set by its name.
-
-
Parameters:
-
name - the name of the property set.
-
Returns:
- the named property set or null if one by that name does not exist.
createPropertySet
IPropertySet createPropertySet(
String name)
- Creates a new property set of a particular name in this container.
If one already exists by this name, it is replaced with a new empty
property set.
In order to have the property set persisted, the implementing class
should also implement
IRSEPersistableContainer. The
IRSEPersistableContainer.commit() method must then be used to
commit any changes into persistent storage.
-
-
Parameters:
-
name - the name of the property set.
-
Returns:
- The property set.
createPropertySet
IPropertySet createPropertySet(
String name,
String description)
- Creates a new property set of a particular name and description in this
container. If one already exists by this name it is replaced with a new
empty property set.
In order to have the property set persisted, the implementing class
should also implement
IRSEPersistableContainer. The
IRSEPersistableContainer.commit() method must then be used to
commit any changes into persistent storage.
-
-
Parameters:
-
name - the name of the property set. -
description - the description (usually already localized) for this
property set.
-
Returns:
- the newly created property set.
addPropertySet
boolean addPropertySet(
IPropertySet set)
- Adds an existing property set to this container. If the property set already has a container
it is removed from that container and added to this one. If this container already
has a property set by this name, this one replaces it.
-
-
Parameters:
-
set - the property set to be added.
-
Returns:
- true if the property set was added.
addPropertySets
boolean addPropertySets(
IPropertySet[] sets)
- Adds a number of existing property sets to this container.
-
-
Parameters:
-
sets - the sets to be added
-
Returns:
- true if all property sets were added.
-
See Also:
-
addPropertySet(IPropertySet)
removePropertySet
boolean removePropertySet(
String name)
- Removes a particular property set from this container.
-
-
Parameters:
-
name - the name of the property set to be removed
-
Returns:
- true if the property set was removed;
false if a property set was not removed, usually if it does not exist in the container.
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.
|
|
