Package com.e1c.g5.v8.dt.form.extension
Interface IFormExtensionManagementService
-
public interface IFormExtensionManagementService
Extensiond management facility which is responsible to support the adoption process
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAdoptChangeListener(IAdoptEventListener listener)
Adds adopt process status listener.void
adoptObject(Object object)
Adopts form objectvoid
fireAdoptEvent(Form form, AdoptStatus status)
Trigger event on adopt processBoolean
getAdopted(Object object)
Gets the adopted status of the object (if applicable).Collection<org.eclipse.emf.ecore.EStructuralFeature>
getChangedFormItemFeatures(FormItem formItem)
Returns collection of all unchanged features of the form item.boolean
isAdoptedObject(Object object)
Returnstrue
if the object was adopted from source formboolean
isAutoAdoptedObject(Object object)
Returnstrue
if the object is in source form and not adoptedboolean
isExtensionBelongingUnderlyingObject(DataItem dataItem)
Returnstrue
if underlying object (Command or FormAttribute) of form data item has been created from the extension or adopted to the extension by user.boolean
isOwnExtensionObject(Object object)
Returnstrue
if the object was created in form extensionboolean
isUnchangedObject(Object object)
Checks if the given object is unchanged according to the rules of the form adoptionvoid
removeAdoptChangeListener(IAdoptEventListener listener)
Removes event listener
-
-
-
Method Detail
-
addAdoptChangeListener
void addAdoptChangeListener(IAdoptEventListener listener)
Adds adopt process status listener.- Parameters:
listener
- event listener, cannot benull
-
adoptObject
void adoptObject(Object object)
Adopts form object- Parameters:
eObject
- The object to adop
-
fireAdoptEvent
void fireAdoptEvent(Form form, AdoptStatus status)
Trigger event on adopt process- Parameters:
form
- form to be adopted, cannot benull
status
- adopt process status, cannot benull
-
getAdopted
Boolean getAdopted(Object object)
Gets the adopted status of the object (if applicable). Checks the hierarchy of the object to find the nearest adopted status- Parameters:
object
- The object to get adopted status for. May not benull
- Returns:
- The adopted status of the object.
null
means the non-adopted native element of the form
-
isAdoptedObject
boolean isAdoptedObject(Object object)
Returnstrue
if the object was adopted from source form- Parameters:
object
- the object being examined, cannot benull
- Returns:
true
if the object was adopted from source form
-
isAutoAdoptedObject
boolean isAutoAdoptedObject(Object object)
Returnstrue
if the object is in source form and not adopted- Parameters:
object
- the object being examined, cannot benull
- Returns:
true
if the object is in source form and not adopted
-
isOwnExtensionObject
boolean isOwnExtensionObject(Object object)
Returnstrue
if the object was created in form extension- Parameters:
object
- the object being examined, cannot benull
- Returns:
true
if the object was created in form extension
-
isUnchangedObject
boolean isUnchangedObject(Object object)
Checks if the given object is unchanged according to the rules of the form adoption- Parameters:
object
- The object to check. May not benull
- Returns:
- True if the object was changed by the user/service
-
removeAdoptChangeListener
void removeAdoptChangeListener(IAdoptEventListener listener)
Removes event listener- Parameters:
listener
- the event listener to remove (notnull
)
-
getChangedFormItemFeatures
Collection<org.eclipse.emf.ecore.EStructuralFeature> getChangedFormItemFeatures(FormItem formItem)
Returns collection of all unchanged features of the form item. The given form item should be from adopted form.- Parameters:
formItem
- the form item, cannot benull
- Returns:
- collection of all unchanged features of the form item or empty collection for not adopted or
non-extension form, never
null
-
isExtensionBelongingUnderlyingObject
boolean isExtensionBelongingUnderlyingObject(DataItem dataItem)
Returnstrue
if underlying object (Command or FormAttribute) of form data item has been created from the extension or adopted to the extension by user.- Parameters:
dataItem
- some form data item (either Button or FormField), can't benull
- Returns:
true
if underlying object has been created from the extension or adopted to the extension by user
-
-