de.aristaflow.adept2.model.activitymodel

Interface AbstractParameterTemplate

All Superinterfaces:

PluginDataContainer, UserAttributeContainer

All Known Subinterfaces:

ParameterTemplate, StorageParameterTemplate

public interface AbstractParameterTemplate
extends UserAttributeContainer, PluginDataContainer

This interface unifies the methods of a ParameterTemplate used with inheritance (in the GUI) as well as for storage.

This interface is not for public usage! It is only public due to a bug in the javadoc-generation. Never cast one of the sub-interfaces (ParameterTemplate and StorageParameterTemplate) to this interface!

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
ActivityConstants.AccessType	getAccessType() Gets the access type for the parameter of this template.
ProcessConstants.AdeptDataType	getDataType() Gets the data type for the parameter of this template.
java.lang.String	getDefaultValue() Gets the string representation for the default value for the parameter of this template.
java.lang.String	getDescription() Gets the description for the parameter of this template.
java.util.UUID	getIdentifierID() Gets the ID of the identifier for the parameter of this template.
java.lang.String	getName() Gets the name for the parameter of this template.
java.lang.String	getTemplateDescription() Gets a description for the process modeler and the administrator of the activity model.
java.lang.String	getTemplateName() Gets the unique (with respect to the corresponding entity) name of this parameter template.
java.lang.String	getUDTName() Gets the name for the user-defined data type for the parameter of this template.
boolean	isAccessTypeInherited() Gets whether the access type for a parameter of this template is inherited from a parent entity, that is this template does not override the access type attribute of a template of a parent entity.
boolean	isDataTypeInherited() Gets whether the data type for a parameter of this template is inherited from a parent entity, that is this template does not override the data type attribute of a template of a parent entity.
boolean	isDefaultValueInherited() Gets whether the string representation for the default value for a parameter of this template is inherited from a parent entity, that is this template does not override the string representation attribute for the default value of a template of a parent entity.
boolean	isDescriptionInherited() Gets whether the description for a parameter of this template is inherited from a parent entity, that is this template does not override the description attribute of a template of a parent entity.
java.lang.Boolean	isFailure() Gets whether the parameter of this template is a failure parameter and therefore all other output parameters are treated as optional if explicitly mapped to a data element.
boolean	isFailureInherited() Gets whether the failure flag for a parameter of this template is inherited from a parent entity, that is this template does not override the failure flag attribute of a template of a parent entity.
boolean	isIdentifierIDInherited() Gets whether the ID of the identifier for a parameter of this template is inherited from a parent entity, that is this template does not override the ID of the identifier attribute of a template of a parent entity.
boolean	isNameInherited() Gets whether the name for a parameter of this template is inherited from a parent entity, that is this template does not override the name attribute of a template of a parent entity.
java.lang.Boolean	isOptional() Gets whether the parameter of this template is optional and therefore may have a value of null at runtime.
boolean	isOptionalInherited() Gets whether the optional flag for a parameter of this template is inherited from a parent entity, that is this template does not override the optional flag attribute of a template of a parent entity.
boolean	isTemplateDescriptionInherited() Gets whether the description of this parameter template is inherited from a parent entity, that is this template does not override the description attribute of a template of a parent entity.
boolean	isUDTNameInherited() Gets whether the user-defined type name for a parameter of this template is inherited from a parent entity, that is this template does not override the user-defined type name attribute of a template of a parent entity.
java.lang.Boolean	isVirtual() Gets whether the parameter of this template is virtual and therefore is not provided to the implementation of the corresponding operation.
boolean	isVirtualInherited() Gets whether the virtual flag for a parameter of this template is inherited from a parent entity, that is this template does not override the virtual flag attribute of a template of a parent entity.
void	removeOwnAccessType() Removes the access type that overrides the access type provided by a corresponding parameter template from a parent entity.
void	removeOwnDataType() Removes the data type that overrides the data type provided by a corresponding parameter template from a parent entity.
void	removeOwnDefaultValue() Removes the string representation for the default value that overrides the string representation for the default value provided by a corresponding parameter template from a parent entity.
void	removeOwnDescription() Removes the description that overrides the description provided by a corresponding parameter template from a parent entity.
void	removeOwnFailure() Removes the failure flag that overrides the failure flag provided by a corresponding parameter template from a parent entity.
void	removeOwnIdentifierID() Removes the ID of the identifier that overrides the ID of the identifier provided by a corresponding parameter template from a parent entity.
void	removeOwnName() Removes the name that overrides the name provided by a corresponding parameter template from a parent entity.
void	removeOwnOptional() Removes the optional flag that overrides the optional flag provided by a corresponding parameter template from a parent entity.
void	removeOwnTemplateDescription() Removes the description of this parameter template that overrides the description provided by a corresponding parameter template from a parent entity.
void	removeOwnUDTName() Removes the user-defined type name that overrides the data type provided by a corresponding parameter template from a parent entity.
void	removeOwnVirtual() Removes the virtual flag that overrides the virtual flag provided by a corresponding parameter template from a parent entity.
void	setAccessType(ActivityConstants.AccessType accessType) Sets the access type for the parameter of this template.
void	setDataType(ProcessConstants.AdeptDataType dataType) Sets the data type for the parameter of this template.
void	setDefaultValue(java.lang.String defaultValue) Sets the string representation for the default value parameter of this template.
void	setDescription(java.lang.String description) Sets the description for the parameter of this template.
void	setFailure(boolean failure) Sets whether the parameter of this template is a failure parameter and therefore sets all other parameters to optional if explicitly mapped to a data element.
void	setIdentifierID(java.util.UUID identifierID) Sets the ID of the identifier for the parameter of this template.
void	setName(java.lang.String name) Sets the name for the parameter of this template.
void	setOptional(boolean optional) Sets whether the parameter of this template is optional and therefore may have a value of null at runtime.
void	setTemplateDescription(java.lang.String templateDescription) Sets a description for the process modeler and the administrator of the activity model.
void	setTemplateName(java.lang.String templateName) Sets the unique (with respect to the corresponding entity) name of this parameter template.
void	setUDTName(java.lang.String udtName) Sets the the user-defined type name for the parameter of this template.
void	setVirtual(boolean virtual) Sets whether the parameter of this template is virtual and therefore is not provided to the implementation of the corresponding operation.

Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

getPluginData, getPluginDatas, getSupportedPlugins

Method Detail

getTemplateName

java.lang.String getTemplateName()

Gets the unique (with respect to the corresponding entity) name of this parameter template. This is used to identify the template and provide a name for the user when creating new parameters.

Returns:

The unique (with respect to the corresponding entity) name of this parameter template.

getTemplateDescription

java.lang.String getTemplateDescription()

Gets a description for the process modeler and the administrator of the activity model. This description is not propagated to the corresponding parameter.

Returns:

A description for the process modeler and the administrator of the activity model. This description is not propagated to the corresponding parameter.

getAccessType

ActivityConstants.AccessType getAccessType()

Gets the access type for the parameter of this template.

The access type may be null in which case it is interpreted as do not care and the user needs to assign one when creating the corresponding parameter.

Returns:

The access type for a parameter of this template, that is a parameter created based on this template will have this access type.

getName

java.lang.String getName()

Gets the name for the parameter of this template. Note that this name is to be unique for the designated entity and the access type. There may be templates for several parameters having the same name but when adding parameters only one of this will be able to be used.

The name of the parameter may be localised which will be applied to the created parameter accordingly. The name may be null in which case it is interpreted as do not care and the user needs to assign one when creating the corresponding parameter.

Returns:

The name for a parameter of this template, that is a parameter created based on this template will have this name.

getDescription

java.lang.String getDescription()

Gets the description for the parameter of this template. This is some arbitrary text describing the usage of the parameter (not the usage of the parameter template).

The description of the parameter may be localised which will be applied to the created parameter accordingly. The description may be null in which case it is interpreted as do not care and the user may assign one when creating the corresponding parameter.

Returns:

The description for a parameter of this template, that is a parameter created based on this template will have this description.

getDataType

ProcessConstants.AdeptDataType getDataType()

Gets the data type for the parameter of this template.

The data type may be null in which case it is interpreted as do not care and the user may needs to assign one when creating the corresponding parameter.

Returns:

The data type for a parameter of this template, that is a parameter created based on this template will have this data type.

getUDTName

java.lang.String getUDTName()

Gets the name for the user-defined data type for the parameter of this template. This name will only used in case the data type is USERDEFINED for the created parameter. This may either be due to the data type set in the template or by the user.

The name of the user-defined data type may be null in which case it is interpreted as do not care and the user may assign one when creating the corresponding parameter.

Returns:

The name for the user-defined data type for a parameter of this template, that is a parameter created based on this template will have this user-defined data type name.

getIdentifierID

java.util.UUID getIdentifierID()

Gets the ID of the identifier for the parameter of this template.

The ID may be null in which case it is interpreted as do not care and the user needs to assign one when creating the corresponding parameter.

Returns:

The ID of the identifier for a parameter of this template, that is a parameter created based on this template will have this identifier.

isOptional

java.lang.Boolean isOptional()

Gets whether the parameter of this template is optional and therefore may have a value of null at runtime.

This flag may be null in which case it is interpreted as do not care and the user needs to set it when creating the corresponding parameter.

Returns:

Whether a parameter of this template is optional and therefore may have a value of null at runtime.

isVirtual

java.lang.Boolean isVirtual()

Gets whether the parameter of this template is virtual and therefore is not provided to the implementation of the corresponding operation.

This flag may be null in which case it is interpreted as do not care and the user needs to set it when creating the corresponding parameter.

Returns:

Whether a parameter of this template is virtual and therefore is not provided to the implementation of the corresponding operation.

isFailure

java.lang.Boolean isFailure()

Gets whether the parameter of this template is a failure parameter and therefore all other output parameters are treated as optional if explicitly mapped to a data element. However, the parameters itself remain mandatory (not optional), only the data edge will be optional.

This flag may be null in which case it is interpreted as do not care and the user needs to set it when creating the corresponding parameter.

Returns:

Whether a parameter of this template is a failure parameter and therefore its mapping to a data element sets all other parameters to optional.

getDefaultValue

java.lang.String getDefaultValue()

Gets the string representation for the default value for the parameter of this template. The string representation conforms to the string representation in configurations, that is, the same transformation is applied for non-string types, for instance user-defined data types. This transformation is the only way to allow for complex data types in simple configuration files which are usually based on simple strings.

The value string may be null in which case it is interpreted as do not care and the user may assign one when creating the corresponding parameter.

Returns:

The string representation for the default value of the parameter of this template. The representation conforms to the string representation used in configurations for complex data types.

setTemplateName

void setTemplateName(java.lang.String templateName)

Sets the unique (with respect to the corresponding entity) name of this parameter template.

Parameters:

templateName - The unique (with respect to the corresponding entity) name of this parameter template. This may neither be null nor the empty string.

setTemplateDescription

void setTemplateDescription(java.lang.String templateDescription)

Sets a description for the process modeler and the administrator of the activity model. This description is not propagated to the corresponding parameter. If this description is not set, it will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The description may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnTemplateDescription() to unset the template description for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

templateDescription - A description for the process modeler and the administrator of the activity model. This description is not propagated to the corresponding parameter. This must not be null.

setName

void setName(java.lang.String name)

Sets the name for the parameter of this template. The same name may be used for different parameter templates but only one of these may be used as a real parameter for the corresponding operation. If this name is not set, it will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The name may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnName() to unset the name for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Use the usual plugins for localising this name.

Parameters:

name - The name for a parameter of this template, that is a parameter created based on this template will have this name. This must not be null.

setDescription

void setDescription(java.lang.String description)

Sets the description for the parameter of this template. This is some arbitrary text describing the usage of the parameter (not the usage of the parameter template). If this description is not set, it will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The description may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnDescription() to unset the description for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Use the usual plugins for localising this description.

Parameters:

description - the description for a parameter of this template, that is a parameter created based on this template will have this description. This must not be null.

setDataType

void setDataType(ProcessConstants.AdeptDataType dataType)

Sets the data type for the parameter of this template. If the data type is not set, each will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The data type may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnDataType() to unset the data type for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

dataType - The data type for a parameter of this template, that is a parameter created based on this template will have this data type. This must not be null.

setUDTName

void setUDTName(java.lang.String udtName)

Sets the the user-defined type name for the parameter of this template. This will only apply if the data type is AdeptDataType.USERDEFINED. If the user-defined type name is not set, it will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The user-defined type name may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnUDTName() to unset the user-defined type name for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

udtName - The empty string or the name of the user-defined type for a parameter of this template, that is a parameter created based on this template will have this name in case it is of user-defined type. This must not be null.

setIdentifierID

void setIdentifierID(java.util.UUID identifierID)

Sets the ID of the identifier for the parameter of this template. If this ID is not set, it will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The ID may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnIdentifierID() to unset the identifier ID for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

identifierID - The ID of the identifier for a parameter of this template, that is a parameter created based on this template will have this identifier. This must not be null.

setAccessType

void setAccessType(ActivityConstants.AccessType accessType)

Sets the access type for the parameter of this template. If this access type is not set, it will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The access type may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnAccessType() to unset the access type for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

accessType - The access type for a parameter of this template, that is a parameter created based on this template will have this access type. This must not be null.

setOptional

void setOptional(boolean optional)

Sets whether the parameter of this template is optional and therefore may have a value of null at runtime. If this flag is not set, it will be interpreted as do not care and the user needs to set it when creating the corresponding parameter.
The optional flag may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnOptional() to unset the optional flag for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

optional - Whether a parameter of this template is optional and therefore may have a value of null at runtime.

setVirtual

void setVirtual(boolean virtual)

Sets whether the parameter of this template is virtual and therefore is not provided to the implementation of the corresponding operation. If this flag is not set, it will be interpreted as do not care and the user needs to set it when creating the corresponding parameter.
The virtual flag may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnVirtual() to unset the virtual flag for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

virtual - Whether a parameter of this template is virtual and therefore is not provided to the implementation of the corresponding operation.

setFailure

void setFailure(boolean failure)

Sets whether the parameter of this template is a failure parameter and therefore sets all other parameters to optional if explicitly mapped to a data element. If this flag is not set, it will be interpreted as do not care and the user needs to set it when creating the corresponding parameter.
The failure flag may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnFailure() to unset the failure flag for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

failure - Whether a parameter of this template is a failure parameter and therefore its mapping to a data element sets all other parameters to optional.

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)

Sets the string representation for the default value parameter of this template. The string representation has to conform to the string representation in configurations, that is, the same transformation needs to be applied for non-string types, for instance user-defined data types. This transformation is the only way to allow for complex data types in simple configuration files which are usually based on simple strings.
If this default value is not set, it will be interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
The default value may only be set if not set in the parent parameter template, that is overriding of null (the do not care value). Use removeOwnDefaultValue() to unset the default value for this entity. This will either inherit the value again if there is a parent parameter template or set it to null (and therefore do not care) if there is no parent parameter template.

Parameters:

defaultValue - The string representation for the default value of the parameter of this template. The representation has to conform to the string representation used in configurations for complex data types. This must not be null.

isTemplateDescriptionInherited

boolean isTemplateDescriptionInherited()

Gets whether the description of this parameter template is inherited from a parent entity, that is this template does not override the description attribute of a template of a parent entity.

Returns:

Whether the description of this parameter template is inherited from a parent entity or the description is provided by this template.

removeOwnTemplateDescription

void removeOwnTemplateDescription()

Removes the description of this parameter template that overrides the description provided by a corresponding parameter template from a parent entity. Afterwards the description is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the description of this parameter template is already inherited.

isNameInherited

boolean isNameInherited()

Gets whether the name for a parameter of this template is inherited from a parent entity, that is this template does not override the name attribute of a template of a parent entity.

Returns:

Whether the name for a parameter of this template is inherited from a parent entity or the name is provided by this template.

removeOwnName

void removeOwnName()

Removes the name that overrides the name provided by a corresponding parameter template from a parent entity. Afterwards the name is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the name is already inherited.

isDescriptionInherited

boolean isDescriptionInherited()

Gets whether the description for a parameter of this template is inherited from a parent entity, that is this template does not override the description attribute of a template of a parent entity.

Returns:

Whether the description for a parameter of this template is inherited from a parent entity or the description is provided by this template.

removeOwnDescription

void removeOwnDescription()

Removes the description that overrides the description provided by a corresponding parameter template from a parent entity. Afterwards the description is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the description is already inherited.

isDataTypeInherited

boolean isDataTypeInherited()

Gets whether the data type for a parameter of this template is inherited from a parent entity, that is this template does not override the data type attribute of a template of a parent entity.

Returns:

Whether the data type for a parameter of this template is inherited from a parent entity or the data type is provided by this template.

removeOwnDataType

void removeOwnDataType()

Removes the data type that overrides the data type provided by a corresponding parameter template from a parent entity. Afterwards the data type is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the data type is already inherited.

isUDTNameInherited

boolean isUDTNameInherited()

Gets whether the user-defined type name for a parameter of this template is inherited from a parent entity, that is this template does not override the user-defined type name attribute of a template of a parent entity.

Returns:

Whether the user-defined type name for a parameter of this template is inherited from a parent entity or the user-defined type name is provided by this template.

removeOwnUDTName

void removeOwnUDTName()

Removes the user-defined type name that overrides the data type provided by a corresponding parameter template from a parent entity. Afterwards the user-defined type name is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the user-defined type name is already inherited.

isIdentifierIDInherited

boolean isIdentifierIDInherited()

Gets whether the ID of the identifier for a parameter of this template is inherited from a parent entity, that is this template does not override the ID of the identifier attribute of a template of a parent entity.

Returns:

Whether the ID of the identifier for a parameter of this template is inherited from a parent entity or the ID of the identifier is provided by this template.

removeOwnIdentifierID

void removeOwnIdentifierID()

Removes the ID of the identifier that overrides the ID of the identifier provided by a corresponding parameter template from a parent entity. Afterwards the ID of the identifier is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the ID of the identifier is already inherited.

isAccessTypeInherited

boolean isAccessTypeInherited()

Gets whether the access type for a parameter of this template is inherited from a parent entity, that is this template does not override the access type attribute of a template of a parent entity.

Returns:

Whether the access type for a parameter of this template is inherited from a parent entity or the access type is provided by this template.

removeOwnAccessType

void removeOwnAccessType()

Removes the access type that overrides the access type provided by a corresponding parameter template from a parent entity. Afterwards the access type is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the access type is already inherited.

isOptionalInherited

boolean isOptionalInherited()

Gets whether the optional flag for a parameter of this template is inherited from a parent entity, that is this template does not override the optional flag attribute of a template of a parent entity.

Returns:

Whether the optional flag for a parameter of this template is inherited from a parent entity or the optional flag is provided by this template.

removeOwnOptional

void removeOwnOptional()

Removes the optional flag that overrides the optional flag provided by a corresponding parameter template from a parent entity. Afterwards the optional flag is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the optional flag is already inherited.

isVirtualInherited

boolean isVirtualInherited()

Gets whether the virtual flag for a parameter of this template is inherited from a parent entity, that is this template does not override the virtual flag attribute of a template of a parent entity.

Returns:

Whether the virtual flag for a parameter of this template is inherited from a parent entity or the virtual flag is provided by this template.

removeOwnVirtual

void removeOwnVirtual()

Removes the virtual flag that overrides the virtual flag provided by a corresponding parameter template from a parent entity. Afterwards the virtual flag is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the virtual flag is already inherited.

isFailureInherited

boolean isFailureInherited()

Gets whether the failure flag for a parameter of this template is inherited from a parent entity, that is this template does not override the failure flag attribute of a template of a parent entity.

Returns:

Whether the failure flag for a parameter of this template is inherited from a parent entity or the failure flag is provided by this template.

removeOwnFailure

void removeOwnFailure()

Removes the failure flag that overrides the failure flag provided by a corresponding parameter template from a parent entity. Afterwards the failure flag is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if the failure flag is already inherited.

isDefaultValueInherited

boolean isDefaultValueInherited()

Gets whether the string representation for the default value for a parameter of this template is inherited from a parent entity, that is this template does not override the string representation attribute for the default value of a template of a parent entity.

Returns:

Whether the string representation for the default value for a parameter of this template is inherited from a parent entity or the string representation for the default value is provided by this template.

removeOwnDefaultValue

void removeOwnDefaultValue()

Removes the string representation for the default value that overrides the string representation for the default value provided by a corresponding parameter template from a parent entity. Afterwards the string representation for the default value is inherited again or if this parameter template does not have a parent, the value will be set to null (the do not care value).
Calling this method will have no effects if string representation for the default value is already inherited.