|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IArtifactDescriptorManager
interface manages all the
IArtifactDescriptor
objects used in RAS. It provides a
mechanism to allow additional user defined descriptors to added and used by
RAS. It provides the support for loading and persisting the descriptors. This
interface is not intended to be implemented by clients.
Method Summary | |
void |
add(IArtifactDescriptor theDescriptor)
Adds an artifact descriptor to the manager. |
IArtifactDescriptor |
get(String theDescriptorID)
Retrieves an artifact descriptor with the corresponding ID from the manager or null if it is not contained in the manager. |
IArtifactDescriptor[] |
getAllDescriptors()
Retrieves an array of all artifact descriptors that are being managed. |
ArtifactResourceTypeEnum |
getResourceType(String theDescriptorType)
Retrieves a member of the ArtifactResourceTypeEnum
enumeration corresponding to the type of a descriptor or
null if it is not contained in the manager. |
IStatus |
load()
Loads the persisted artifact descriptors and initializes the artifact manager to a state where it can manage them. |
void |
remove(String theDescriptorID)
Removes an artifact descriptor with the corresponding ID from the manager. |
IStatus |
restoreDefaults()
Restores the manager to a state where it contains only the default artifact descriptors that are shipped with the IArtifactDescriptorManager . |
IStatus |
save()
Persists the artifact descriptors being managed to an XML document that will be used instead of the default artifact descriptors that are shipped with the plugin. |
Method Detail |
public IArtifactDescriptor[] getAllDescriptors()
IArtifactDescriptor
interfaces.public void add(IArtifactDescriptor theDescriptor) throws IllegalArgumentException, NonEditableArtifactDescriptorException
theDescriptor
- to add to the manager.
IllegalArgumentException
- if theDescriptor
is null
.
NonEditableArtifactDescriptorException
- if an attempt is made to replace an existing artifact
descriptor that is not editable.public IArtifactDescriptor get(String theDescriptorID) throws IllegalArgumentException
null
if it is not contained in the manager.
theDescriptorID
- of the artifact descriptor to retrieve from the manager.
null
if
it doesn't exist.
IllegalArgumentException
- if theDescriptorID
is null
.public ArtifactResourceTypeEnum getResourceType(String theDescriptorType) throws IllegalArgumentException
ArtifactResourceTypeEnum
enumeration corresponding to the type of a descriptor or
null
if it is not contained in the manager.
theDescriptorType
- the artifact descriptor type to retrieve from the manager.
null
if it doesn't
exist.
IllegalArgumentException
- if theDescriptorID
is null
.public void remove(String theDescriptorID) throws IllegalArgumentException, NonEditableArtifactDescriptorException
theDescriptorID
- of the artifact descriptor to remove from the manager.
IllegalArgumentException
- if theDescriptorID
is null
.
NonEditableArtifactDescriptorException
- if an attempt is made to remove an existing artifact
descriptor that is not editable.public IStatus restoreDefaults()
IArtifactDescriptorManager
.
IStatus
indicating if the
IArtifactDescriptorManager
was restored to a
default state.public IStatus save()
IStatus
indicating if the artifact descriptors
were successfully savedpublic IStatus load()
IArtifactDescriptorManager
will automatically be
loaded once upon creation.
IStatus
indicating if the artifact descriptors
were successfully loaded
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.