org.eclipse.stp.core.sca
Interface SCAObject

All Known Subinterfaces:
AbstractImplementation, AbstractReference, AbstractService, Binding, Component, ComponentType, ComponentWireHandle, Composite, EntryPoint, ExternalService, Implementation, ImplementationComponent, Interface, JavaImplementation, JavaInterface, Module, ModuleComponent, ModuleFragment, ModuleImplementation, ModuleReference, ModuleService, ModuleWire, Property, PropertyValue, PropertyValues, PropertyValuesSet, Reference, ReferenceValue, ReferenceValuesSet, SCABinding, SCACoreRoot, Service, SLSBBinding, Subsystem, SystemWire, UnknownImplementation, WebServiceBinding, WireSource, WireTarget, WSDLPortType

public interface SCAObject

This interface is not intended to be implemented by clients.

Since:
1.0

Method Summary
 MultiStatus addStatus(IStatus aNewStatus)
          A modeled object will not overwrite any existing status unless a client calls clearStatus().
 void clearStatus()
          Reset the status to just IStatus.OK
 EObject getEObject()
          Return an EObject for this SOAObject.
 int getFlags()
          Return an int for the flags associated with this SOAObject.
 java.lang.String getName()
           
 MultiStatus getStatus()
          Will never return null.
 void setName(java.lang.String name)
           
 

Method Detail

getFlags

int getFlags()
Return an int for the flags associated with this SOAObject. Use Flags to test the flags returned as well as constants for the flags.

Returns:
int
See Also:
Flags

getEObject

EObject getEObject()
Return an EObject for this SOAObject.

Returns:
EObject

setName

void setName(java.lang.String name)
Parameters:
name - The name of this SCAObject

getName

java.lang.String getName()
Returns:
The name of this SCAObject

addStatus

MultiStatus addStatus(IStatus aNewStatus)
A modeled object will not overwrite any existing status unless a client calls clearStatus(). Whenever a client calls addStatus(), either a new MultiStatus is created with the parameters of the given status, or the given aNewStatus is added to an existing MultiStatus. The resultant combined MultiStatus is returned.

Parameters:
aNewStatus - A status for this model object (could be warning, error, info, or OK)
Returns:
The current status of this SCAObject

clearStatus

void clearStatus()
Reset the status to just IStatus.OK


getStatus

MultiStatus getStatus()
Will never return null. If no status has been explicitly set, this method returns Status.OK_STATUS.

Returns:
The current status to indicate if there are known problems with this model object.