rs.sol.soloist.server.guiconfiguration.nonvisualcompoments
Class GUIServiceAccessPointComponent

java.lang.Object
  rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUINonVisualComponent
                          rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIServiceAccessPointComponent

All Implemented Interfaces:

IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

Direct Known Subclasses:

GUIClassInstancesSAPComponent

public abstract class GUIServiceAccessPointComponent
extends GUINonVisualComponent

An abstract base class for all invisible widgets that serve to access domain object space and fetch domain objects. Fetched objects are provided on the value output pin (opValue() method).

Author:

SOL Expert Group

See Also:

GUIClassInstancesSAPComponent, GUIFindAllInstancesSAPComponent, GUIFindSingleInstanceSAPComponent

Nested Class Summary

static class	GUIServiceAccessPointComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIServiceAccessPointComponent.PROPERTIES Deprecated. Not for public use.

Field Summary

IAttributeValue<Boolean>	accessOnInit Deprecated. Not for public use.
static IClass	CLASSIFIER UML class reference
IAttributeValue<Text>	element Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Text>	refresh Deprecated. Not for public use.
IAttributeValue<Text>	value Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyle, context, description, enabled, init, inputBindings, layoutData, logger, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible

Constructor Summary

GUIServiceAccessPointComponent()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
boolean	getAccessOnInit() Returns whether this widget will fetch elements as soon as it gets initialized or not.
abstract java.util.List<rs.sol.soloist.server.uml.concepts.IElement>	getValues(rs.sol.soloist.server.uml.concepts.IElement el) Returns the collection of elements in some way related to the given element.
java.lang.Object	handle(rs.sol.soloist.client.common.requests.Request request) Handles single request from the client (browser) and returns an appropriate response.
ISlot<?>	ipElement() Returns the element input pin; when event occurs, this widget will fetch elements based on the element from the binding message received on this pin, and provide them on the value output pin (opValue() method).
ISlot<?>	ipRefresh() Returns the refresh input pin; when event occurs, this widget will re-fetch elements based on the last element received on the element input pin (ipElement() method), and provide them on the value output pin (opValue() method).
ISlot<?>	opValue() Returns the value output pin; when event occurs on either element input pin (ipElement() method) or refresh input pin (ipRefresh() method) this widget will fetch a collection of elements and provide it on this pin.
void	setAccessOnInit(boolean accessOnInit) Returns whether this widget will fetch elements as soon as it gets initialized or not.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUINonVisualComponent

setCellAlignment, setCellSize, setCellStyle, setCenter, setDirectionAndSize, setLeftRightWidth, setRowColumn, setRowColumn, setSize, setTopBottomHeight, setXY

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setContext, setDescription, setEnabled, setLayoutData, setName, setSlot, setSlot, setStyle, setTooltip, setVisible, toTranslateDescriptors, translatePinName, updateInfo, validate, validateParts, validateParts

Methods inherited from class rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance

destroy, equals, getAssociationEndInstance, getAssociationEndInstances, getAttributeValue, getAttributeValues, getMyClass, getMyID, getSlot, getSlot, getSlots, getUMLClass, hashCode, isMarkedAsDeleted, toString

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance

accept, accept, exists, getAssociationEndInstance, getAssociationEndInstance, getAssociationEndInstance, getClassifier, hasIdentity, isClassInstance, isDataTypeInstance, isEqualTo, makeClone, markAsDeleted

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getMElement, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf, isKindOf, isModelElement, isRTElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement

getMElement

Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement

isKindOf, isModelElement, isRTElement

Field Detail

accessOnInit

@Deprecated
public IAttributeValue<Boolean> accessOnInit

Deprecated. Not for public use.

element

@Deprecated
public IAttributeValue<Text> element

Deprecated. Not for public use.

refresh

@Deprecated
public IAttributeValue<Text> refresh

Deprecated. Not for public use.

value

@Deprecated
public IAttributeValue<Text> value

Deprecated. Not for public use.

FQ_TYPE_NAME

public static final java.lang.String FQ_TYPE_NAME

Fully qualified UML class name

See Also:

Constant Field Values

CLASSIFIER

public static final IClass CLASSIFIER

UML class reference

Constructor Detail

GUIServiceAccessPointComponent

public GUIServiceAccessPointComponent()

Method Detail

constructor

public void constructor()

Description copied from interface: IClassifierInstance

The domain-specific constructor of the Classifier.

Specified by:

constructor in interface IClassifierInstance

Overrides:

constructor in class GUINonVisualComponent

getValues

public abstract java.util.List<rs.sol.soloist.server.uml.concepts.IElement> getValues(rs.sol.soloist.server.uml.concepts.IElement el)

Returns the collection of elements in some way related to the given element.

Parameters:

el - the element for which the related elements should be retrieved

Returns:

the collection of elements related to the given element

handle

public java.lang.Object handle(rs.sol.soloist.client.common.requests.Request request)

Description copied from class: GUIComponent

Handles single request from the client (browser) and returns an appropriate response. It is meant to be overriden in sub-classes.

Overrides:

handle in class GUIComponent

Parameters:

request - a Request from client deserialized and ready to be handeled

Returns:

an Object representing the server's response to a request

ipElement

public ISlot<?> ipElement()

Returns the element input pin; when event occurs, this widget will fetch elements based on the element from the binding message received on this pin, and provide them on the value output pin (opValue() method).

Returns:

the element input pin

See Also:

GUIComponentBinding

ipRefresh

public ISlot<?> ipRefresh()

Returns the refresh input pin; when event occurs, this widget will re-fetch elements based on the last element received on the element input pin (ipElement() method), and provide them on the value output pin (opValue() method).

The content of the binding message accepted on this pin is of no importance. Only event is what matters.

Returns:

the refresh input pin

See Also:

GUIComponentBinding

opValue

public ISlot<?> opValue()

Returns the value output pin; when event occurs on either element input pin (ipElement() method) or refresh input pin (ipRefresh() method) this widget will fetch a collection of elements and provide it on this pin.

Returns:

the value output pin

See Also:

GUIComponentBinding

getAccessOnInit

public boolean getAccessOnInit()

Returns whether this widget will fetch elements as soon as it gets initialized or not.

Returns:

a boolean that tells whether this widget will fetch elements as soon as it gets initialized or not

setAccessOnInit

public void setAccessOnInit(boolean accessOnInit)

Returns whether this widget will fetch elements as soon as it gets initialized or not.

Parameters:

accessOnInit - a boolean that tells whether this widget will fetch elements as soon as it gets initialized or not