org.eclipse.rse.core.model
Interface ISystemProfileManager

public interface ISystemProfileManager

Manages a list of SystemProfile objects. System profiles should be created, deleted, restored, activated, and deactivated though this interface if event processing is not desired. If events are necessary then the system registry should be used.

Method Summary

void	addSystemProfile(ISystemProfile profile) Adds a system profile to this profile manager.
ISystemProfile	cloneSystemProfile(ISystemProfile profile, String newName) Clone the given profile
IStatus	commitSystemProfile(ISystemProfile profile) Commit a system profile
ISystemProfile	createSystemProfile(String name, boolean makeActive) Create a new profile with the given name, and add to the list.
void	deleteSystemProfile(ISystemProfile profile, boolean persist) Delete the given profile.
String[]	getActiveSystemProfileNames()
ISystemProfile[]	getActiveSystemProfiles()
ISystemProfile	getDefaultPrivateSystemProfile()
ISystemProfile	getDefaultTeamSystemProfile()
int	getSize()
ISystemProfile	getSystemProfile(String name) Get a profile given its name.
String[]	getSystemProfileNames()
ISystemProfile[]	getSystemProfiles()
boolean	isSystemProfileActive(String profileName) Get an indication of whether a profile is active or not.
void	makeSystemProfileActive(ISystemProfile profile, boolean makeActive) Toggle an existing profile's state between active and inactive.
void	renameSystemProfile(ISystemProfile profile, String newName) Rename the given profile.

Method Detail

createSystemProfile

public ISystemProfile createSystemProfile(String name,
                                          boolean makeActive)

Create a new profile with the given name, and add to the list. The name must be unique within the existing list.

Parameters:

name - What to name this profile

makeActive - true if this profile is to be added to the active profile list.

Returns:

new profile, or null if name not unique.

makeSystemProfileActive

public void makeSystemProfileActive(ISystemProfile profile,
                                    boolean makeActive)

Toggle an existing profile's state between active and inactive. The default private profile cannot be deactivated and such a request will be ignored.

Parameters:

profile - the profile to (in)activate

makeActive - the state to make this profile

getSystemProfiles

public ISystemProfile[] getSystemProfiles()

Returns:

an array of all existing profiles. This is guaranteed to contain the default private profile.

getSize

public int getSize()

Returns:

the number of profiles known to this manager.

getSystemProfileNames

public String[] getSystemProfileNames()

Returns:

an array of all existing profile names.

getSystemProfile

public ISystemProfile getSystemProfile(String name)

Get a profile given its name.

Parameters:

name - the name of the profile

Returns:

the profile

getActiveSystemProfiles

public ISystemProfile[] getActiveSystemProfiles()

Returns:

the profiles identified via preferences as the active profiles...

getActiveSystemProfileNames

public String[] getActiveSystemProfileNames()

Returns:

the profile names currently selected by the user as his "active" profiles

getDefaultPrivateSystemProfile

public ISystemProfile getDefaultPrivateSystemProfile()

Returns:

the default private profile created at first touch. Will return null if it has been renamed.

getDefaultTeamSystemProfile

public ISystemProfile getDefaultTeamSystemProfile()

Returns:

the default team profile created at first touch. Will return null if it has been renamed.

renameSystemProfile

public void renameSystemProfile(ISystemProfile profile,
                                String newName)

Rename the given profile.

Parameters:

profile - the profile to rename

newName - the new profile name

deleteSystemProfile

public void deleteSystemProfile(ISystemProfile profile,
                                boolean persist)

Delete the given profile. The default private profile cannot be deleted and such a request will be ignored.

Parameters:

profile - the name of the profile to delete.

persist - true if the deletion is meant to be persisted as well, false if the deletion is just in the model.

cloneSystemProfile

public ISystemProfile cloneSystemProfile(ISystemProfile profile,
                                         String newName)

Clone the given profile

Parameters:

profile - the profile to clone

newName - the name of the new profile

Returns:

the new profile

commitSystemProfile

public IStatus commitSystemProfile(ISystemProfile profile)

Commit a system profile

Parameters:

profile - the profile to commit

Returns:

a status object indicating the result of the commit

Since:

org.eclipse.rse.core 3.0

isSystemProfileActive

public boolean isSystemProfileActive(String profileName)

Get an indication of whether a profile is active or not.

Parameters:

profileName - the name of the profile to test

Returns:

true if the given profile is active

See Also:

ISystemProfile.isActive()

addSystemProfile

public void addSystemProfile(ISystemProfile profile)

Adds a system profile to this profile manager.

Parameters:

profile - The system profile to add.