public interface AbstractParameterTemplate extends UserAttributeContainer, PluginDataContainer
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!
| 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.
|
getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuegetPluginData, getPluginDatas, getSupportedPluginsjava.lang.String getTemplateName()
java.lang.String getTemplateDescription()
ActivityConstants.AccessType getAccessType()
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.
java.lang.String getName()
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.
java.lang.String getDescription()
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.
ProcessConstants.AdeptDataType getDataType()
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.
java.lang.String getUDTName()
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.
java.util.UUID getIdentifierID()
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.
java.lang.Boolean isOptional()
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.
java.lang.Boolean isVirtual()
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.
java.lang.Boolean isFailure()
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.
java.lang.String getDefaultValue()
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.
void setTemplateName(java.lang.String templateName)
templateName - The unique (with respect to the corresponding entity)
name of this parameter template. This may neither be null nor the
empty string.void setTemplateDescription(java.lang.String templateDescription)
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.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.void setName(java.lang.String name)
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.
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.void setDescription(java.lang.String description)
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.
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.void setDataType(ProcessConstants.AdeptDataType dataType)
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.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.void setUDTName(java.lang.String udtName)
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. 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.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.void setIdentifierID(java.util.UUID identifierID)
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.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.void setAccessType(ActivityConstants.AccessType accessType)
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.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.void setOptional(boolean optional)
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.optional - Whether a parameter of this template is optional and
therefore may have a value of null at runtime.void setVirtual(boolean virtual)
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.virtual - Whether a parameter of this template is virtual and
therefore is not provided to the implementation of the
corresponding operation.void setFailure(boolean failure)
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.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.void setDefaultValue(java.lang.String defaultValue)
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.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.boolean isTemplateDescriptionInherited()
void removeOwnTemplateDescription()
boolean isNameInherited()
void removeOwnName()
boolean isDescriptionInherited()
void removeOwnDescription()
boolean isDataTypeInherited()
void removeOwnDataType()
boolean isUDTNameInherited()
void removeOwnUDTName()
boolean isIdentifierIDInherited()
void removeOwnIdentifierID()
boolean isAccessTypeInherited()
void removeOwnAccessType()
boolean isOptionalInherited()
void removeOwnOptional()
boolean isVirtualInherited()
void removeOwnVirtual()
boolean isFailureInherited()
void removeOwnFailure()
boolean isDefaultValueInherited()
void removeOwnDefaultValue()