Remote Systems
v6.4.1

com.ibm.etools.systems.model
Interface SystemProfileManager

All Known Implementing Classes:
SystemProfileManagerImpl

public interface SystemProfileManager


Field Summary
static String copyright
           
 
Method Summary
 SystemProfile cloneSystemProfile(SystemProfile profile, String newName)
          Clone the given profile
 SystemProfile createSystemProfile(String name, boolean makeActive)
          Create a new profile with the given name, and add to the list.
 void deleteSystemProfile(SystemProfile profile)
          Delete the given profile
 String[] getActiveSystemProfileNames()
          Return the profile names currently selected by the user as his "active" profiles
 int getActiveSystemProfilePosition(String profileName)
          Return 0-based position of the given active profile within the list of active profiles.
 SystemProfile[] getActiveSystemProfiles()
          Return the profiles identified via preferences as the active profiles...
 SystemProfile getDefaultPrivateSystemProfile()
          Return the default private profile created at first touch.
 SystemProfile getDefaultTeamSystemProfile()
          Return the default team profile created at first touch.
 ISystemValidator getProfileNameValidator(String profileName)
          Reusable method to return a name validator for renaming a profile.
 ISystemValidator getProfileNameValidator(SystemProfile profile)
          Reusable method to return a name validator for renaming a profile.
 EList getProfiles()
           
 SystemProfile getSystemProfile(String name)
          Get a profile given its name.
 String[] getSystemProfileNames()
          Get an array of all existing profile names.
 Vector getSystemProfileNamesVector()
          Get a vector of all existing profile names.
 SystemProfile[] getSystemProfiles()
          Get an array of all existing profiles.
 boolean isSystemProfileActive(String profileName)
          Return true if the given profile is active
 void makeSystemProfileActive(SystemProfile profile, boolean makeActive)
          Toggle an existing profile's state between active and inactive
 void renameSystemProfile(SystemProfile profile, String newName)
          Rename the given profile.
 void save()
          Save all profiles to disk
 void save(SystemProfile profile)
          Attempt to save single profile to disk.
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

createSystemProfile

public SystemProfile 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.

The underlying folder is created in the file system.

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(SystemProfile profile,
                                    boolean makeActive)
Toggle an existing profile's state between active and inactive


getSystemProfiles

public SystemProfile[] getSystemProfiles()
Get an array of all existing profiles.


getSystemProfileNames

public String[] getSystemProfileNames()
Get an array of all existing profile names.


getSystemProfileNamesVector

public Vector getSystemProfileNamesVector()
Get a vector of all existing profile names.


getSystemProfile

public SystemProfile getSystemProfile(String name)
Get a profile given its name.


getActiveSystemProfiles

public SystemProfile[] getActiveSystemProfiles()
Return the profiles identified via preferences as the active profiles...


getActiveSystemProfileNames

public String[] getActiveSystemProfileNames()
Return the profile names currently selected by the user as his "active" profiles


getActiveSystemProfilePosition

public int getActiveSystemProfilePosition(String profileName)
Return 0-based position of the given active profile within the list of active profiles.


getDefaultPrivateSystemProfile

public SystemProfile getDefaultPrivateSystemProfile()
Return the default private profile created at first touch. Will return null if it has been renamed!


getDefaultTeamSystemProfile

public SystemProfile getDefaultTeamSystemProfile()
Return the default team profile created at first touch. Will return null if it has been renamed!


renameSystemProfile

public void renameSystemProfile(SystemProfile profile,
                                String newName)
Rename the given profile.


deleteSystemProfile

public void deleteSystemProfile(SystemProfile profile)
Delete the given profile


cloneSystemProfile

public SystemProfile cloneSystemProfile(SystemProfile profile,
                                        String newName)
Clone the given profile


isSystemProfileActive

public boolean isSystemProfileActive(String profileName)
Return true if the given profile is active

See Also:
SystemProfile.isActive()

getProfileNameValidator

public ISystemValidator getProfileNameValidator(String profileName)
Reusable method to return a name validator for renaming a profile.


getProfileNameValidator

public ISystemValidator getProfileNameValidator(SystemProfile profile)
Reusable method to return a name validator for renaming a profile.


save

public void save()
Save all profiles to disk


save

public void save(SystemProfile profile)
          throws Exception
Attempt to save single profile to disk.

Throws:
Exception

getProfiles

public EList getProfiles()
Returns:
The list of Profiles references

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.