Class COOSYSTEM@1.1:TimeInterval

An object of this class is used to store a time interval.

Class Hierarchy

Object > AdministrationObject > TimeInterval

Properties

Type	Property	Name
LanguageStringList[]	mlname	Multilingual Name
integer	timeinterval	Time Interval
TimeIntervalUnit	timeintervalunit	Unit
boolean	timenextworkday	Use Next Working Day
RoundingType	timerounding	Rounding
TimeIntervalUnit	timeroundunit	Round to Unit

Actions

Return Type	Signature
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
boolean	IsTemplateReleaseable( out retval boolean isreleaseable, out boolean requirereleasedversion)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)

Properties

Multilingual Name (COOSYSTEM@1.1:mlname)

Defines the multilingual name of the object. It stores one name for each supported language.

Explanation:
This field defines the multilingual name of the object.

unique LanguageStringList[] COOSYSTEM@1.1:mlname

Time Interval (COOSYSTEM@1.1:timeinterval)

This field defines the length of the time interval.

integer COOSYSTEM@1.1:timeinterval not null

Unit (COOSYSTEM@1.1:timeintervalunit)

In this field the units "Second", "Minute", "Hour", "Day", "Week", "Month" or "Year" are available. Combined with the Time Interval field, the time interval is defined.

TimeIntervalUnit COOSYSTEM@1.1:timeintervalunit not null

Use Next Working Day (COOSYSTEM@1.1:timenextworkday)

By default non-working days and holidays are not considered for the calculation of a time from a time interval. To use the next working day instead of the calculated non-working day, this field can be checked.

boolean COOSYSTEM@1.1:timenextworkday

Rounding (COOSYSTEM@1.1:timerounding)

To round the calculated time, in this field the type of rounding ("Normal", "Always Round Off" and "Always Round Up") can be defined. Combined with the Round to Unit property, the calculation of the time is defined.

RoundingType COOSYSTEM@1.1:timerounding

Round to Unit (COOSYSTEM@1.1:timeroundunit)

To round the calculated time, in this field the unit ("Second", "Minute", "Hour", "Day", "Week", "Month" and "Year") can be defined. Combined with the Type of Rounding property, the calculation of the time is defined.

TimeIntervalUnit COOSYSTEM@1.1:timeroundunit

Actions

COOTC@1.1001:GetDraftTemplate

Gets the draft version of the template. The action can be called both on the draft version and on the release version of a template.

object COOTC@1.1001:GetDraftTemplate(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

COOTC@1.1001:IsDraftTemplate

Checks if the template is a draft which can be released.

If the release mechanism is to be used for an object class, then this action can be implemented for example with: isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();

boolean COOTC@1.1001:IsDraftTemplate(
out retval boolean isdrafttemplate)

Name	Description
isdrafttemplate	the result

COOTC@1.1001:IsTemplateReleaseable

Checks if a template is releaseable, and if a released template is required in a particular context.

In the room environment, it is usually the case that a template, which can in principle be released, only needs to be released in certain cases. Templates in an app configuration or a template collection must always be released, while a template of the same object class in an app room does not require release.

boolean COOTC@1.1001:IsTemplateReleaseable(
out retval boolean isreleaseable,
out boolean requirereleasedversion)

Name	Description
isreleaseable	the result
requirereleasedversion	this parameter defines if release version of the template is required

COOTC@1.1001:ReleaseTemplate

Action to release a template. A released template can be instantiated.

object COOTC@1.1001:ReleaseTemplate(
  out retval object releasedtemplate,
  optional boolean keepoldrelease,
  optional dictionary additionalsettings)

Name	Description
releasedtemplate	the released template
keepoldrelease	in case of newly created released template the old release is not deleted
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to release sub templates