cz.ues.core.sysc.dto

Class WidgetCreate

java.lang.Object

cz.ues.core.sysc.dto.WidgetCreate

@DTO
public class WidgetCreate
extends java.lang.Object

DTO for command Widget#create(UESURI, WidgetCreate).

Since:

UES8-15

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	code Code of the new widget.
private UESURI	competentRoleUri URI of the competent role.
private java.lang.String	controllerUrlPath Path at which the widget's controller is deployed.
private java.lang.String	description Description of the new widget.
private java.lang.Boolean	editorAvailable Describes whether the widget will be in the list of available widgets in editor.
private java.lang.Integer	height Default height of the widget in content.
private UESURI	iconUri URI of the widget's icon.
private UESURI	metaArtifactUri URI of the meta artifact.
private java.lang.String	name Name of the new widget.
private java.lang.Integer	placeholderHeight Height of the widget placeholder in editor.
private PlaceholderImage	placeholderImage Placeholder image of the widget in editor.
private java.lang.Integer	placeholderWidth Width of the widget placeholder in editor.
private UESSecurityLevel	securityLevel Security level.
private java.lang.Boolean	trusted Describes whether the widget will by inserted into the HTML directly or in the iframe.
private java.lang.Integer	width Default width of the widget in content.

Constructor Summary

Constructors

Constructor and Description
WidgetCreate(UESURI metaArtifactUri) Minimal constructor for the widget creation.
WidgetCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code) Enough constructor for the widget creation.
WidgetCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, UESURI iconUri, java.lang.String controllerUrlPath, java.lang.Boolean trusted, java.lang.Boolean editorAvailable, PlaceholderImage placeholderImage, java.lang.Integer width, java.lang.Integer height, java.lang.Integer placeholderWidth, java.lang.Integer placeholderHeight) Maximal constructor for the widget creation.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

private name

Name of the new widget. If nil is set, default name from meta artifact is used if set, otherwise the create command fails.

Since:

UES8-15

code

private code

Code of the new widget. If nil is set, the code is generated automatically using the system sequence. The code must be unique in the given territory, otherwise the create command fails.

Since:

UES8-15

description

private description

Description of the new widget. If nil is set, default description from meta artifact is used if set, otherwise no description is set on the new widget.

Since:

UES8-15

securityLevel

private securityLevel

Security level. If nil is set, security level is taken from the meta artifact default security level. If the meta artifact template security level is higher than the user’s security clearance, the create command fails.

Since:

UES8-15

iconUri

private iconUri

URI of the widget's icon. If nil is set, the role uses icon from meta artifact. An example of icon URI: 'ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{ART_077}'.

Since:

UES8-15

competentRoleUri

private competentRoleUri

URI of the competent role. If nil is set, the executive role from authorization is used. If no role is authorized to create the widget into specified location, the create command fails. If the selected role doesn’t have connected the role interface with the selected meta artifact, the create command fails. If the selected role doesn’t belong to the same organizational unit as a widget or if it doesn’t belong to one of superior organizational units, the create command fails.

Since:

UES8-15

metaArtifactUri

private metaArtifactUri

URI of the meta artifact. Only a meta artifact with the template class of Widget (not its descendants) can be used. If the rights does not permit to create a new widget from the meta artifact in the specified location, the create command fails.

Since:

UES8-15

controllerUrlPath

private controllerUrlPath

Path at which the widget's controller is deployed. The value can be a relative or absolute URL (absolute URL has to be in format https://<something>.plus4u.net/). If an absolute URL is set, it is used as entered, without adding any postfix (e.g. /render which is added for relative URL). If it is not set, the widget cannot be used in the sheet content.

Since:

UES8-15

trusted

private trusted

Describes whether the widget will by inserted into the HTML directly or in the iframe. The default value is false.

Since:

UES8-15

editorAvailable

private editorAvailable

Describes whether the widget will be in the list of available widgets in editor. The default value is true.

Since:

UES8-15

placeholderImage

private placeholderImage

Placeholder image of the widget in editor. The default value is /images/other/editor_component_general.gif.

Since:

UES8-15

width

private width

Default width of the widget in content. It must be set together with height. If the attributes width and height or placeholder_width and placeholder_height are not set, the widget cannot be used in the sheet content.

Since:

UES8-15

height

private height

Default height of the widget in content. It must be set together with width. If the attributes width and height or placeholder_width and placeholder_height are not set, the widget cannot be used in the sheet content.

Since:

UES8-15

placeholderWidth

private placeholderWidth

Width of the widget placeholder in editor. It is defined for widgets for which it is not possible to set width and height. It must be set together with placeholder_height. If the attributes width and height or placeholder_width and placeholder_height are not set, the widget cannot be used in the sheet content.

Since:

UES8-15

placeholderHeight

private placeholderHeight

Height of the widget placeholder in editor. It is defined for widgets for which it is not possible to set width and height. It must be set together with placeholder_width. If the attributes width and height or placeholder_width and placeholder_height are not set, the widget cannot be used in the sheet content.

Since:

UES8-15

Constructor Detail

WidgetCreate

public WidgetCreate(UESURI metaArtifactUri)

Minimal constructor for the widget creation. Warning: Use this constructor carefully because it is need perfect defined attributes of the specified widget. The command fails when some mandatory attribute (name) is not defined on the specified widget template.

Since:

UES8-15

WidgetCreate

public WidgetCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code)

Enough constructor for the widget creation. This constructor extends minimal constructor and covers eventually missing mandatory attributes of the specified template.

Since:

UES8-15

WidgetCreate

public WidgetCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
UESURI iconUri,
java.lang.String controllerUrlPath,
java.lang.Boolean trusted,
java.lang.Boolean editorAvailable,
PlaceholderImage placeholderImage,
java.lang.Integer width,
java.lang.Integer height,
java.lang.Integer placeholderWidth,
java.lang.Integer placeholderHeight)

Maximal constructor for the widget creation. This constructor allows to set all possible widget attributes.

Recommendation: Read description of all attributes for widget creation very carefully before using this constructor.

Parameters:

metaArtifactUri -

name -

code -

description -

competentRoleUri -

securityLevel -

iconUri -

controllerUrlPath -

Since:

UES8-15