IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.profile.defauld.defaultprofile
Interface Profile

All Superinterfaces:
EObject, Notifier

public interface Profile
extends EObject

A representation of the model object ' Profile'. xmi:ordered=true property order is (these are role names) 1. description 2. relatedProfile An asset is defined by one profile; a profile describes the asset's type. The profile can have different versions and should declare its lineage or ancestry from other profiles. The related-profile captures information on the profile's lineage. The Profile element in the XML schema includes information about the format of the manifest itself. It identifies exactly which version of this specification and which RAS profile should be used to validate the manifest document for compliance. A profile defines the structure and semantics of an asset's manifest document. Every RAS manifest document must identify the profile that can be used to validate it. Every profile is derived from another profile with the one exception being the original Core profile, which was defined by the first version of the RAS and for which there is no XML Schema produced. Profiles can extend directly from Core RAS or from any other profile such as the Default Profile for version 2.1. These derived profiles can only add elements and attributes to the manifest's XML Schema, and/or associate new semantics to existing elements. They cannot remove elements or attributes from the XML Schema. In general derived profiles are more restrictive. This attempts to make it easier for tools to gracefully handle assets created with profiles defined after the tooling was created.

The following features are supported:

See Also:
DefaultprofilePackage.getProfile()

Method Summary
 Description getDescription()
          Returns the value of the 'Description' containment reference.
 String getIdHistory()
          Returns the value of the 'Id History' attribute
 String getName()
          Returns the value of the 'Name' attribute.
 Artifact getReference()
          Returns the value of the 'Reference' reference.
 EList getRelatedProfile()
          Returns the value of the 'Related Profile' containment reference list.
 int getVersionMajor()
          Returns the value of the 'Version Major' attribute
 int getVersionMinor()
          Returns the value of the 'Version Minor' attribute
 void setDescription(Description value)
          Sets the value of the ' Description' containment reference.
 void setIdHistory(String value)
          Sets the value of the ' Id History' attribute.
 void setName(String value)
          Sets the value of the ' Name' attribute.
 void setReference(Artifact value)
          Sets the value of the ' Reference' reference.
 void setVersionMajor(int value)
          Sets the value of the ' Version Major' attribute.
 void setVersionMinor(int value)
          Sets the value of the ' Version Minor' attribute.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getName

public String getName()
Returns the value of the 'Name' attribute. Each profile specifies a human readable name that reflects the purpose or scope of the profile.

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), DefaultprofilePackage.getProfile_Name()

setName

public void setName(String value)
Sets the value of the ' Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getIdHistory

public String getIdHistory()
Returns the value of the 'Id History' attribute. The id-history is a composite key that is made up of the profile id followed by the profile ids of all the profiles that it is derived from. A profile is derived from exactly one parent profile with the notable exception of the first and original Core profile introduced with the RAS 1.0 specification. As an example the following is the id history for the RAS Default profile version 2.1: F1C842AD-CE85-4261-ACA7-178C457018A1::31E5BFBF-B16E-4253-8037-98D70D07F35F It indicates that the profile identified by: "F1C842AD-CE85-4261-ACA7-178C457018A1" is derived from the profile identified by "31E5BFBF-B16E-4253-8037-98D70D07F35F", which is the Core profile defined in the first version of the RAS specification. If a new profile was defined a new GUID would be generated and it would be pre-pended to the id-history of the profile that it derived from. For example it might be: F8C49799-25C9-4312-B798-D5D2E1FBC656::F1C842AD-CE85-4261-ACA7-178C457018A1::31E5BFBF-B16E-4253-8037-98D70D07F35F This new profile defines a new set of elements, attributes and semantics that extend those already defined by all of the other profiles in the id-history.

Returns:
the value of the 'Id History' attribute.
See Also:
setIdHistory(String), DefaultprofilePackage.getProfile_IdHistory()

setIdHistory

public void setIdHistory(String value)
Sets the value of the ' Id History' attribute.

Parameters:
value - the new value of the 'Id History' attribute.
See Also:
getIdHistory()

getVersionMajor

public int getVersionMajor()
Returns the value of the 'Version Major' attribute. The version-major and version-minor attributes help identify the profile version, and in particular helps distinguish it from previous profiles with the same name. These attributes are integers. Often these two values are combined together with a period, and form what appears to be a floating-point number. For example a version major of 2, and version minor of 1 might be written as version 2.1. Changes in the version major and version minor values should be made when a profile is updated and when its name remains the same. This would be the case when a profile is updated but its target purpose or scope, and hence name remains the same.

Returns:
the value of the 'Version Major' attribute.
See Also:
setVersionMajor(int), DefaultprofilePackage.getProfile_VersionMajor()

setVersionMajor

public void setVersionMajor(int value)
Sets the value of the ' Version Major' attribute.

Parameters:
value - the new value of the 'Version Major' attribute.
See Also:
getVersionMajor()

getVersionMinor

public int getVersionMinor()
Returns the value of the 'Version Minor' attribute. The version-major and version-minor attributes help identify the profile version, and in particular helps distinguish it from previous profiles with the same name. These attributes are integers. Often these two values are combined together with a period, and form what appears to be a floating-point number. For example a version major of 2, and version minor of 1 might be written as version 2.1. Changes in the version major and version minor values should be made when a profile is updated and when its name remains the same. This would be the case when a profile is updated but its target purpose or scope, and hence name remains the same.

Returns:
the value of the 'Version Minor' attribute.
See Also:
setVersionMinor(int), DefaultprofilePackage.getProfile_VersionMinor()

setVersionMinor

public void setVersionMinor(int value)
Sets the value of the ' Version Minor' attribute.

Parameters:
value - the new value of the 'Version Minor' attribute.
See Also:
getVersionMinor()

getReference

public Artifact getReference()
Returns the value of the 'Reference' reference.

Returns:
the value of the 'Reference' reference.
See Also:
setReference(Artifact), DefaultprofilePackage.getProfile_Reference()

setReference

public void setReference(Artifact value)
Sets the value of the ' Reference' reference.

Parameters:
value - the new value of the 'Reference' reference.
See Also:
getReference()

getDescription

public Description getDescription()
Returns the value of the 'Description' containment reference.

Returns:
the value of the 'Description' containment reference.
See Also:
setDescription(Description), DefaultprofilePackage.getProfile_Description()

setDescription

public void setDescription(Description value)
Sets the value of the ' Description' containment reference.

Parameters:
value - the new value of the 'Description' containment reference.
See Also:
getDescription()

getRelatedProfile

public EList getRelatedProfile()
Returns the value of the 'Related Profile' containment reference list. The list contents are of type RelatedProfile.

Returns:
the value of the 'Related Profile' containment reference list.
See Also:
DefaultprofilePackage.getProfile_RelatedProfile()

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.