RSE
Release 1.0

org.eclipse.rse.core.model
Interface ISystemProfile

All Superinterfaces:
IPropertySetContainer, IRSEModelObject, org.eclipse.rse.core.persistance.IRSEPersistableContainer

public interface ISystemProfile
extends IRSEModelObject

The interface that RSE system profiles implement.

A profile represents a user or name which is used to key important user-data by:


Method Summary
 IHost createHost(String systemType, String connectionName, String hostName, String description)
          Convenience method for create a new connection within this profile.
 ISystemFilterPool[] getFilterPools()
          Return all filter pools for this profile
 ISystemFilterPool[] getFilterPools(ISubSystemConfiguration ssf)
          Return all filter pools for this profile, scoped by a given subsystem factory
 IHost[] getHosts()
          Return all connections for this profile
 String getName()
           
 ISystemProfileManager getProfileManager()
          Get the in-memory pointer back to the parent system profile manager
 boolean isActive()
          Return true if this profile is currently active for this user
 boolean isDefaultPrivate()
           
 void setDefaultPrivate(boolean value)
           
 void setName(String value)
           
 void setProfileManager(ISystemProfileManager mgr)
          Set the in-memory pointer back to the parent system profile manager
 
Methods inherited from interface org.eclipse.rse.core.model.IRSEModelObject
getDescription
 
Methods inherited from interface org.eclipse.rse.core.model.IPropertySetContainer
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet
 
Methods inherited from interface org.eclipse.rse.core.persistance.IRSEPersistableContainer
commit, isDirty, setDirty, setWasRestored, wasRestored
 

Method Detail

setProfileManager

public void setProfileManager(ISystemProfileManager mgr)
Set the in-memory pointer back to the parent system profile manager


getProfileManager

public ISystemProfileManager getProfileManager()
Get the in-memory pointer back to the parent system profile manager


createHost

public IHost createHost(String systemType,
                        String connectionName,
                        String hostName,
                        String description)
                 throws Exception
Convenience method for create a new connection within this profile. Shortcut for ISystemRegistry.createHost(String,String,String,String)

Throws:
Exception

getName

public String getName()
Specified by:
getName in interface IRSEModelObject
Returns:
The value of the Name attribute

setName

public void setName(String value)
Parameters:
value - The new value of the Name attribute

isDefaultPrivate

public boolean isDefaultPrivate()
Returns:
The value of the DefaultPrivate attribute Is this profile created automatically, and is it the profile that is unique for this developer?

setDefaultPrivate

public void setDefaultPrivate(boolean value)
Parameters:
value - The new value of the DefaultPrivate attribute

getHosts

public IHost[] getHosts()
Return all connections for this profile


getFilterPools

public ISystemFilterPool[] getFilterPools()
Return all filter pools for this profile


getFilterPools

public ISystemFilterPool[] getFilterPools(ISubSystemConfiguration ssf)
Return all filter pools for this profile, scoped by a given subsystem factory


isActive

public boolean isActive()
Return true if this profile is currently active for this user


RSE
Release 1.0

Copyright (c) IBM Corporation and others 2000, 2006. All Rights Reserved.