LSPS Documentation
An abstract record type used to represent a goal or a plan.
Name of the goal or plan.
Current state of execution of the goal or plan.
Parent goal of the GoalPlan in the current module instance.
Set of metadata (key-value pairs) of the goal or plan.
A goal of any kind.
Set of children (goals or plans).
If true, at least one of the goal's sub-plans (taken recursively, i.e., not only direct sub-plans) is running. If false, none of the goal's sub-plans are running.
Set of the direct sub-plans that are running. It is always an empty set for a goal decomposed into goals.
A single achieve goal.
Precondition of the achieve goal.
Deactivate condition of the achieve goal.
A single maintain goal.
Maintain condition of the maintain goal.
Represents a single plan.
Precondition of the plan.
A model
Unique identifier of the model.
Name of the model.
Version of the model.
Time when the model was uploaded.
A model instance.
Unique identifier of the model instance.
If true, the model instance is running. If false, the model instance has finished.
Start date of the model instance.
Finish date of the model instance. It is null if the model instance is not finished yet.
A process instance.
Identifier of the process instance.
Name of the underlying process.
The owning model instance.
If true, the process instance is running. If false, the process instance has finished.
Set of metadata (key-value pairs) of the process instance.
Duration expressed in various time units. Its value is given as the sum of all values of the units. Each field value can be positive or negative.
Number of years of the duration.
Number of months of the duration.
Number of weeks of the duration.
Number of days of the duration.
Number of hours of the duration.
Number of minutes of the duration.
Number of seconds of the duration.
Number of milliseconds of the duration.
A goal that is to be repeated and a set of settings of slots related to the goal repetition. This type is used in the RepeatGoals task type.
Achieve goal to be repeated.
Map of references to slots and the values to be used for their setting. This allows you to set variable values on goal repeat.
Violation of a single data constraint on a record or property. Note that a validation results in a list of constraint violations.
ID of the violated constraint. It is assigned during validation to all created ConstraintViolation objects that have a null id.
GUID of the violated constraint. It is assigned automatically after the constraint execution during validation to all created ConstraintViolation objects that have a null guid.
Message returned by the constraint expression defined in the corresponding ConstraintType.
Record with the value that did not pass the validation.
Property of the record which did not pass the validation.
Application data.
Tag that is used to classify data constraints and filter them on runtime.
Full name of the validation tag, for example, "mymodule::mytag".
Action performed by an Execution task.
It is used also as the supertype for activity-reflection types for task types or processes.
Such an Action subtype is created when the "Create activity reflection type" option of a process or task type is selected.
Record for the entry of the user-activity tracking.
Unique ID of the user tracking.
Login name of the tracked user.
Time of the first activity of the track entry.
Time of the last activity of the track entry.
File with binary content.
Binary content.
Filename of the file.
MIME type of the data.
Actual size of the binary data in bytes.
Descriptor of binary data. The record is used internally by LSPS server to store data. Any modification or deletion of BinaryHandle records might render the system unusable.
Unique identifier of the binary data.
Description of the data.
Represents a time in a day, such as 10:15:30.
A time can optionally define a time zone offset.
Time is represented to millisecond precision.
The hour.
The minute.
The second.
The millisecond.
An optional time-zone offset.
A time-zone offset from Greenwich/UTC, such as +02:00.
The time-zone offset hours, from -18 to +18.
The time-zone offset minutes, from -59 to +59, sign matches hours and seconds.
The time-zone offset seconds, from -59 to +59, sign matches hours and minutes.
Creates proxies for the record holders. If the record already has proxy in this proxy set it returns the existing proxy. If a new proxy is created it is added to this proxy set. There must be always continuous chain of proxies from level 0 to level n, therefore missing proxies on parent proxy sets are created automatically. On access a property of the proxy, a new proxy is created automaticaly. The new proxy created for a propery is again lazy spreading proxy.
Parameters:
Creates a proxy for the record holder. If the record already has a proxy in this proxy set, it returns the existing proxy. If a new proxy is created, it is added to this proxy set. There always must be a continuous chain of proxies from level 0 to level n;; therefore any proxies missing on parent proxy sets are created automatically. When a proxy property is accessed, a new proxy is created automatically. The new proxy created for a property is a lazy-spreading proxy as well.
Parameters:
Merges all proxies for the proxy set to their proxied records.
Parameters:
Returns:
Creates a proxy on each record holder in the collection. If a record already has its proxy in the proxy set, it uses the existing proxy. If a new proxy is created, it is added to the proxy set. There always must be a continuous chain of proxies from level 0 to level n; therefore proxies missing on the parent proxy sets are created automatically. Proxies are created for all listed property values. The created proxies are added to the proxy set.
Parameters:
Returns:
Creates a proxy on each record holder in the collection. If a record already has its proxy in the proxy set, it uses the existing proxy. If a new proxy is created, it is added to the proxy set. There always must be a continuous chain of proxies from level 0 to level n; therefore any proxies missing on parent proxy sets are created automatically. Proxies are created for all listed property values. The created proxies are added to the proxy set.
Parameters:
Returns:
Creates a new proxy of the record type. The new proxy is added to the proxy set.
Parameters:
Returns:
Creates a proxy for the record holder. If the record already has a proxy in this proxy set, it returns the existing proxy. If a new proxy is created, it is added to this proxy set. There always must be a continuous chain of proxies from level 0 to level n; therefore any proxies missing on parent proxy sets are created automatically. Proxies are created for all listed property values. The created proxies are added to the proxy set.
Parameters:
Creates a proxy for the record holder. If the record already has proxy in this proxy set, it returns the existing proxy. If a new proxy is created, it is added to this proxy set. There always must be a continuous chain of proxies from level 0 to level n; therefore any proxies missing on parent proxy sets are created automatically. Proxies are created for all listed property values. The created proxies are added to the proxy set.
Parameters:
Creates proxies of the listed property values of the record. The created proxies are added to the proxy set.
If there are no listed properties the action is executed for all properties of the record type.
Parameters:
Ssl configuration for http calls and webservices. Th e field sslContextProvider provides an instance of com.whitestein.lsps.wsclient.SslContextProvider . Other fields are ignored.
An instance of com.whitestein.lsps.wsclient.SslContextProvider.
Type of key store.
Name of the key store data file. It must be accesible as a resource in the custom LSPS Application.
Key-store password.
Key password.
Start status of model instance
Model instance is starting
Model instance is starting and expects explicit finish
Model instance starting succeeded
Starting of model instance failed