Poseidon for UMLTM
  UMLdoc
 PREV      NEXT       FRAMES    NO FRAMES      

com.gentleware.poseidon.model_management

Interface Profile

com.gentleware.poseidon.model_management.Profile

public interface Profile


This interface covers handling of single profiles.


 Attribute Summary
String  GENERAL_ACTIVE_STATUS_KEY_PREFIX
 
String  LOADED_KEY_PREFIX
 
arrow_up
 

 Method Summary
public ResourceId   getDescriptionResourceId()
 
public boolean   getGeneralActivityStatus()
tests the general settings, if this profile should be active, if create new project. 
public String   getLanguage()
 
public String   getLocation()
Returns the location of the file holding the content of this profile. 
public InputStream   getLocationStream()
Returns the location of the file holding the content of this profile as stream. 
public String   getModuleName()
 
public RefObject   getProfileModel()
Returns the model instance of this profile. 
public String   getProfileName()
Returns the name of this profile. 
public PoseidonProject   getProject()
Returns the project this profile is valid for. 
public String   getUniqueId()
Returns the unique identifier for this profile. 
public boolean   isActive()
Tests, if this profile is active. 
public boolean   isLoaded()
Tests, if this profile is already loaded, i.e. 
public void   setActive(boolean isActive)
 
public void   setGeneralActiveStatus(boolean isActive)
 
public void   setLocation(String location)
Sets the location of the file holding the content of this profile. 
public void   setProfileModel(RefObject model)
Sets the model instance for this profile. 
public void   setProfileName(String name)
Sets the name of this profile. 
public void   setProject(PoseidonProject project)
Sets the project this profile should be valid for. 
public void   setUniqueId(String newId)
Sets the unique identifier for this profile. 
public String   toString()
 
arrow_up
 

Tagged Values
static false
gentleware-imported-line-number 17
gentleware-imported-package-statement-line-number 5
 

 Attribute Detail

GENERAL_ACTIVE_STATUS_KEY_PREFIX

String GENERAL_ACTIVE_STATUS_KEY_PREFIX

arrow_up


LOADED_KEY_PREFIX

String LOADED_KEY_PREFIX

arrow_up
 Method Detail

getDescriptionResourceId

public ResourceId getDescriptionResourceId()

Returns:
arrow_up


getGeneralActivityStatus

public boolean getGeneralActivityStatus()


tests the general settings, if this profile should be active, if create new project.  
Returns:
True, if the profile should be active, otherwise false.
arrow_up


getLanguage

public String getLanguage()

Returns:
arrow_up


getLocation

public String getLocation()


Returns the location of the file holding the content of this profile.  
Returns:
The string representation of the file location.
arrow_up


getLocationStream

public InputStream getLocationStream()


Returns the location of the file holding the content of this profile as stream. The location can be either within the file system or the classpath (enabling files to be part of jars).  
Returns:
An input stream pointing to the location of the content file.
arrow_up


getModuleName

public String getModuleName()

Returns:
arrow_up


getProfileModel

public RefObject getProfileModel()


Returns the model instance of this profile.  
Returns:
The model instance.
arrow_up


getProfileName

public String getProfileName()


Returns the name of this profile.  
Returns:
The name.
arrow_up


getProject

public PoseidonProject getProject()


Returns the project this profile is valid for.  
Returns:
The project instance this profile is valid for.
arrow_up


getUniqueId

public String getUniqueId()


Returns the unique identifier for this profile.  
Returns:
arrow_up


isActive

public boolean isActive()


Tests, if this profile is active.  
Returns:
True, if the profile is active, otherwise false.
arrow_up


isLoaded

public boolean isLoaded()


Tests, if this profile is already loaded, i.e. if the content is loaded from the content file and the profile model is set.  
Returns:
True, if the content is loaded, otherwise false.
arrow_up


setActive

public void setActive(boolean isActive)

Parameters:
isActive -
arrow_up


setGeneralActiveStatus

public void setGeneralActiveStatus(boolean isActive)

Parameters:
isActive -
arrow_up


setLocation

public void setLocation(String location)


Sets the location of the file holding the content of this profile. The location is checked for existance in the file system or the classpath.  
Parameters:
location - The string representation of the location of the content file.
arrow_up


setProfileModel

public void setProfileModel(RefObject model)


Sets the model instance for this profile. Typically, this operation is called after loading the profile content.  
Parameters:
model - The new model instance.
arrow_up


setProfileName

public void setProfileName(String name)


Sets the name of this profile.  
Parameters:
name - The new name of the profile.
arrow_up


setProject

public void setProject(PoseidonProject project)


Sets the project this profile should be valid for.  
Parameters:
project - The project instance.
arrow_up


setUniqueId

public void setUniqueId(String newId)


Sets the unique identifier for this profile.  
Parameters:
newId - The new unique identifier.
arrow_up


toString

public String toString()

Returns:
arrow_up
Created  2004 - 12 - 1

    Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in Germany, USA and other countries. Copyright 2003-2004 Gentleware AG, Schanzenstr. 70, 20357 Hamburg, Germany. All Rights Reserved.

UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.