2022 June Release

Actions of COOATTREDIT@1.1 Permanent link for this heading

Return Type

Signature

void

AllowedClassesGetPostWrapper(
  optional object attrdef,
  CheckAllowedMode mode,
  ref object[] allowedclasses,
  ref object[] notallowedclasses)

void

AttrAppConfiguredAppsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrAppIsConfigured(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrAppsAssignmentSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrDescriptionGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrGrActivatedAppPkgAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrGrAppsChangedAtSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrGrAppUsageCacheGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrGrIsTrialSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrGroupAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

object[]

AttrObjectsUIFilter(
  ref retval object[] objects,
  AttributeDefinition attrdef)

any

AttrRepresentationListCtor(
  AttributeDefinition attrdef,
  out retval any value)

void

AttrSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrUserAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrUsrEnvCachedAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrUsrEnvUserProfileGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrUsrEnvUserProfileSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

CancelQuickSearch(
  integer pendingkey)

boolean

CanLicenseAsTrial(
  object app,
  out retval boolean trialok,
  optional string instance)

boolean

CheckAppLicense(
  optional boolean objdirect,
  optional string instance,
  optional boolean disableerrorapps,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

boolean

CheckFinalForm(
  out retval boolean finalform)

boolean

CheckLicense(
  optional string instance,
  optional boolean disableerrorapps,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

void

ConfigureNewOrganization()

void

DebitVolumeLicense(
  ComponentObject feature,
  integer amount)

void

DeterminePageArchiveProperties(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

void

DeterminePageRelationsProperties(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

void

EditObjectAttributes(
  optional integer unused1,
  optional integer unused2,
  optional object objclass,
  optional object focusattr,
  optional boolean domodal,
  optional string unused6,
  optional object[] attrs,
  optional object formsobj,
  optional object checkaction,
  optional boolean locked,
  optional any unused11,
  optional any unused12,
  optional integer unused13,
  optional string itempath)

void

EditOfflineAttributes()

void

EditSelectedObjectsAttributes()

void

EditSelectedObjectsCommonAttributes()

void

EditUserSettings()

void

EditUserSubstitution()

User[]

GetAdditionalAppUsers(
  object app,
  ref retval User[] users)

UserAppList[]

GetAllProductsUsers(
  optional UserAppList[] productstocheck,
  optional datetime refdate,
  out retval UserAppList[] licensedusers)

void

GetAppInstance(
  optional object app,
  out optional string instance)

App[]

GetAppPkgConfiguredApps(
  out retval App[] apps)

UserAppAssignmentList[]

GetAppsAssignment(
  out retval UserAppAssignmentList[] assignedapps)

AppsAssignment

GetAppsAssignmentObject(
  boolean createnonexisting,
  out retval AppsAssignment appsassignmentobject)

object[]

GetAppUsers(
  object app,
  optional string instance,
  out retval object[] users,
  out integer freelics,
  out integer totallics,
  optional datetime refdate,
  optional UserAppList[] licensedpackages,
  optional UserAppList[] checkapps)

AppPackage[]

GetAvailableEditions(
  boolean fulleditions,
  boolean readeditions,
  boolean defaultedition,
  boolean legacyeditions,
  boolean contextspecificlicenses,
  out retval AppPackage[] editions)

object

GetBasePackage(
  out retval object package)

UserAppList[]

GetCachedUserPackages(
  User user,
  out retval UserAppList[] licensedapps)

AppPackage[]

GetContextSpecificEdition(
  out retval AppPackage[] contextspecificeditions)

App[]

GetDefaultApps(
  out retval App[] defaultapps)

AppPackage

GetDefaultPackage(
  out retval AppPackage defaultpackage,
  boolean contextspecific)

void

GetEditionLogoContext(
  out object logocontainer,
  out object bgimagecontainer)

object[]

GetExpiringApps(
  out retval object[] apps,
  optional integer expireindays,
  optional datetime expirebefore)

AppPackage

GetFullEdition(
  out retval AppPackage edition)

AppPackage[]

GetGroupLicensedPackagesByType(
  out AppPackage[] fullaccess,
  out AppPackage[] readaccess,
  out AppPackage[] contextaccess,
  out retval AppPackage[] packages,
  optional boolean nofallback)

UserAppList[]

GetGroupPackages(
  object group,
  optional object context,
  out retval UserAppList[] licensedapps,
  optional boolean usecache)

object[]

GetLicenseContextGroups(
  optional object context,
  optional boolean fullapps,
  out retval object[] groups)

Group

GetLicenseTeam(
  AppPackage edition,
  out retval Group licenseteam,
  optional boolean createnonexisting)

void

GetLicensingApps(
  optional boolean objdirect,
  optional string instance,
  out object[] licensedapps,
  out object[] expiredapps,
  out object[] notlicensedapps,
  optional boolean useonlylicensingapps)

void

GetObjectQuickSearchAppearance(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  out optional QuickSearchAppearance appearance)

void

GetObjectQuickSearchMLText(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  out optional string[] multilinetext)

void

GetObjectQuickSearchSuffix(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  out optional string suffix)

PackageAppList[]

GetPackageApps(
  out retval PackageAppList[] apps,
  out ActivatedPackageApps[] activatedconfiguredgapps,
  out App[] configuredapps)

AppPackage

GetProductUserAssignment(
  User targetuser,
  out retval AppPackage package,
  out App[] apps)

AppPackage[]

GetReadEdition(
  out retval AppPackage[] editions)

object[]

GetRequestedApps(
  out retval object[] apps,
  optional object object,
  optional object view,
  optional object[] selobjects)

object

GetRootPackage(
  out retval object package)

boolean

GetState(
  out retval boolean enabled,
  out boolean adjustable,
  out boolean licensed,
  out boolean expired,
  out boolean visible,
  out datetime trialdate,
  out boolean requirementmissing,
  optional string instance)

string

GetTimeDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

string

GetTimeIntervalDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

UserAppList[]

GetUniqueGroupPackageList(
  out retval UserAppList[] packages,
  out UserAppList[] apps,
  optional datetime refdate,
  optional boolean includeconfigpkgapps,
  optional boolean onlyactiveconfigpkgapps,
  optional boolean checkassignmentmode,
  optional boolean requirecontextassignment)

object

GetUserProfile(
  out retval object userprofile,
  optional object container,
  optional object view,
  optional AttributeObjectDef attrdef)

void

GetViewForm(
  ref object action,
  string[] actionrefs,
  optional object formclass,
  object objclass,
  out object form,
  out object checkaction,
  optional boolean recursive,
  out object triggeraction)

VolumeLicenseInfo

GetVolumeLicenseInfo(
  boolean createnonexisting,
  out retval VolumeLicenseInfo vollicinfo)

void

GroupAppsChanged(
  object group)

boolean

HasLicensed(
  App app,
  optional boolean trial,
  optional string instance,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

boolean

HasValidEdition(
  out retval boolean result,
  out AppPackage edition,
  optional object context,
  optional boolean isedit,
  optional boolean isread,
  optional boolean isdefault)

boolean

IsFeatureFlagEnabled(
  FeatureFlag requestedfeature,
  out retval boolean enabled)

boolean

IsGroupServiceUser(
  Group group,
  out retval boolean isprivileged)

boolean

IsLicenseTeam(
  optional Group targetgroup,
  out retval boolean islicenseteam)

boolean

IsPackageUsableFor(
  out retval boolean memberassignment,
  out boolean contextassignment)

boolean

IsPossibleDefaultApp(
  out retval boolean ispossible)

void

IsPrivilegedLicensingUser(
  out boolean privileged)

boolean

IsUpdateLicenseTeamMembersAllowed(
  out retval boolean isallowed)

void

LicenseTo(
  object user,
  datetime from,
  datetime to,
  optional string key,
  optional integer quantity,
  optional object data,
  optional boolean trial,
  optional string instance,
  optional boolean asdefaultapp)

void

ModifyPage(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

void

OpenAllObjectAttributes()

void

OpenAllSelectedObjectsAttributes()

void

OpenObjectAttributes()

void

OpenSelectedObjectsAttributes()

void

QuickSearch(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  optional integer objectlimit,
  out object[] foundobjects,
  ref optional integer pendingkey,
  out optional string[] customobjnames)

void

ReadObjectAttributes(
  optional integer unused1,
  optional integer unused2,
  optional object objclass,
  optional object focusattr,
  optional boolean domodal,
  optional string unused6,
  optional object[] attrs,
  optional object formsobj,
  optional any unused9,
  optional any unused10,
  optional any unused11,
  optional any unused12,
  optional integer unused13,
  optional string itempath)

void

ReadSelectedObjectsAttributes()

void

SelectObjects(
  optional integer unused1,
  optional integer unused2,
  string caption,
  string prompt,
  ControlStyle[] ctrlstyles,
  ref object[] objects,
  optional integer unused7,
  optional object[] selobjects)

void

SelectValues(
  optional integer unused1,
  optional integer unused2,
  string caption,
  string prompt,
  ControlStyle[] ctrlstyles,
  ref any values,
  optional integer unused7,
  optional integer[] selindexlist)

void

SetAppLicenseCheckError(
  integer errno,
  boolean expired,
  object[] apps,
  dictionary params)

void

SetPageItems(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

SetUserRolePostWrapper(
  object group,
  object position,
  optional object substuser)

boolean

ShouldUpdateProductAssignment(
  out retval boolean update,
  out boolean updatevolumelicenses)

void

ShowError(
  optional integer unused1,
  optional integer hresult,
  ref optional boolean cancelstate)

any

Sort(
  ref retval any valuelist,
  optional boolean ascending,
  optional object[] attrpath,
  optional boolean nullismax)

void

UpdateProductUserAssignment(
  User targetuser,
  ComponentObject[] products,
  boolean replace,
  boolean updateautoassignment,
  boolean silent,
  optional boolean checkassignmentmode,
  optional boolean requirecontextassignment)

void

UpdateVolumeLicenses()

boolean

UseRestrictedAccessForm(
  out retval boolean userestricedform)

void

UserProfileFilter(
  ref object[] objects,
  object attrdef,
  optional object object,
  optional object view,
  optional object[] selobjects,
  optional CheckAllowedMode mode)

void

UserProfileFilterClasses(
  ref object[] objects,
  object attrdef,
  CheckAllowedMode mode,
  optional object object,
  optional object view,
  optional object[] selobjects,
  ref optional object[] allowedobjects)

void

ValidateAccount(
  optional integer unused1,
  string caption,
  optional string prompt,
  optional string promptremark,
  ref optional string remark,
  optional boolean remarkneeded)


COOATTREDIT@1.1:AllowedClassesGetPostWrapper Permanent link for this heading

Compute allowed classes as well as not allowed classes for property post wrapper.

void COOATTREDIT@1.1:AllowedClassesGetPostWrapper(
  optional object attrdef,
  CheckAllowedMode mode,
  ref object[] allowedclasses,
  ref object[] notallowedclasses)

Name

Description

attrdef

mode

allowedclasses

notallowedclasses

Additional Information


COOATTREDIT@1.1:AttrAppConfiguredAppsGet Permanent link for this heading

Calculate the list of configured apps in the app package

void COOATTREDIT@1.1:AttrAppConfiguredAppsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOATTREDIT@1.1:AttrAppIsConfigured Permanent link for this heading

Calculate, if the app is a configured app

void COOATTREDIT@1.1:AttrAppIsConfigured(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOATTREDIT@1.1:AttrAppsAssignmentSet Permanent link for this heading

void COOATTREDIT@1.1:AttrAppsAssignmentSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrDescriptionGet Permanent link for this heading

Override description content with description string

void COOATTREDIT@1.1:AttrDescriptionGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOATTREDIT@1.1:AttrGet Permanent link for this heading

DisplayItem::AttrGet ("Get property") gets the value of the property DisplayItem::dispitemitems. Since version 2.1 the list of items to be displayed are stored in an aggregate. This method is used to get the value for the property DisplayItem::dispitemitems from the object list property used in the earlier versions. This is done if such a property is edited or read the first time in version 2.1.

void COOATTREDIT@1.1:AttrGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOATTREDIT@1.1:AttrGrActivatedAppPkgAppsSet Permanent link for this heading

Set action called when the configured app included in an app package is activated

void COOATTREDIT@1.1:AttrGrActivatedAppPkgAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrGrAppsChangedAtSet Permanent link for this heading

void COOATTREDIT@1.1:AttrGrAppsChangedAtSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrGrAppUsageCacheGet Permanent link for this heading

void COOATTREDIT@1.1:AttrGrAppUsageCacheGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOATTREDIT@1.1:AttrGrIsTrialSet Permanent link for this heading

void COOATTREDIT@1.1:AttrGrIsTrialSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrGroupAppsSet Permanent link for this heading

void COOATTREDIT@1.1:AttrGroupAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrObjectsUIFilter Permanent link for this heading

UI-Filter Action to hide objects with no access permissions

object[] COOATTREDIT@1.1:AttrObjectsUIFilter(
  ref retval object[] objects,
  AttributeDefinition attrdef)

Name

Description

objects

attrdef

Additional Information


COOATTREDIT@1.1:AttrRepresentationListCtor Permanent link for this heading

Create representation of property

any COOATTREDIT@1.1:AttrRepresentationListCtor(
  AttributeDefinition attrdef,
  out retval any value)

Name

Description

attrdef

value

Additional Information


COOATTREDIT@1.1:AttrSet Permanent link for this heading

DisplayItem::AttrSet ("Set property") sets the value of the property DisplayItem::dispitemitems. Since version 2.1 the list of items to be displayed are stored in an aggregate. This method is used to set the value for the property DisplayItem::dispitemitems from the object list property used in the earlier versions. This is done if such a property is edited or read the first time in version 2.1.

void COOATTREDIT@1.1:AttrSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrUserAppsSet Permanent link for this heading

void COOATTREDIT@1.1:AttrUserAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrUsrEnvCachedAppsSet Permanent link for this heading

void COOATTREDIT@1.1:AttrUsrEnvCachedAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:AttrUsrEnvUserProfileGet Permanent link for this heading

Get user profile

void COOATTREDIT@1.1:AttrUsrEnvUserProfileGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOATTREDIT@1.1:AttrUsrEnvUserProfileSet Permanent link for this heading

Set user profile

void COOATTREDIT@1.1:AttrUsrEnvUserProfileSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:CancelQuickSearch Permanent link for this heading

Cancels quick search

void COOATTREDIT@1.1:CancelQuickSearch(
  integer pendingkey)

Name

Description

pendingkey

Additional Information


COOATTREDIT@1.1:CanLicenseAsTrial Permanent link for this heading

Verify if a specified participant can license an item as trial

boolean COOATTREDIT@1.1:CanLicenseAsTrial(
  object app,
  out retval boolean trialok,
  optional string instance)

Name

Description

app

trialok

instance

Additional Information


COOATTREDIT@1.1:CheckAppLicense Permanent link for this heading

Checks the license of an app. If there is one or more apps defined in the property COOATTREDIT@1.1:classapps of the object class of the object, check if any of these apps is licensed currently.
Thrown errors include

boolean COOATTREDIT@1.1:CheckAppLicense(
  optional boolean objdirect,
  optional string instance,
  optional boolean disableerrorapps,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

Name

Description

objdirect

instance

Instance to be checked.

disableerrorapps

Just raise an error, do not set error application.

context

the current context for the license evaluation. E.g an object of the teamroom to evaluate the correct organization

silentmode

if set no errors will be raised

haslicense

additional to possible errors the result of the license check will be returned in this parameter

Additional Information


COOATTREDIT@1.1:CheckFinalForm Permanent link for this heading

Verify final form state of object

boolean COOATTREDIT@1.1:CheckFinalForm(
  out retval boolean finalform)

Name

Description

finalform

Additional Information


COOATTREDIT@1.1:CheckLicense Permanent link for this heading

App::CheckLicenseCheck if the App is licensed for the current user.
Thrown errors include

boolean COOATTREDIT@1.1:CheckLicense(
  optional string instance,
  optional boolean disableerrorapps,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

Name

Description

instance

Instance to be checked.

disableerrorapps

Just raise an error, do not set error application.

context

the context for the license check

silentmode

if set no errors will be raised

haslicense

additional to possible errors the result of the license check will be returned in this parameter

Additional Information


COOATTREDIT@1.1:ConfigureNewOrganization Permanent link for this heading

Hook action called to configure a new organization

void COOATTREDIT@1.1:ConfigureNewOrganization()

Additional Information


COOATTREDIT@1.1:DebitVolumeLicense Permanent link for this heading

Reduces the available amount of a VolumeLicense of a group. The appropriate VolumeLicense is selected based on the defined feature.

void COOATTREDIT@1.1:DebitVolumeLicense(
  ComponentObject feature,
  integer amount)

Name

Description

feature

the feature contained in vlfeatures of a VolumeLicense

amount

the amount by which the available licences are reduced

Additional Information


COOATTREDIT@1.1:DeterminePageArchiveProperties Permanent link for this heading

Determine properties of "Archive" form page

void COOATTREDIT@1.1:DeterminePageArchiveProperties(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

Name

Description

form

page

uiverb

action

formpageitems

objclass

formpagelabel

formpageicon

localscope

Additional Information


COOATTREDIT@1.1:DeterminePageRelationsProperties Permanent link for this heading

Determine properties of relations page

void COOATTREDIT@1.1:DeterminePageRelationsProperties(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

Name

Description

form

page

uiverb

action

formpageitems

objclass

formpagelabel

formpageicon

localscope

Additional Information


COOATTREDIT@1.1:EditObjectAttributes Permanent link for this heading

Object::EditObjectAttributes ("Edit properties of object") opens the Property Editor and displays the properties of the object for editing. If the user has not the right to edit the object properties the Property Editor is opened in read-only mode. If the object is locked, the user is asked whether he wants to open the Property Editor in read only mode. It has the hints MH_CHANGESOBJ and MH_NEEDSLOCALGUI assigned.

void COOATTREDIT@1.1:EditObjectAttributes(
  optional integer unused1,
  optional integer unused2,
  optional object objclass,
  optional object focusattr,
  optional boolean domodal,
  optional string unused6,
  optional object[] attrs,
  optional object formsobj,
  optional object checkaction,
  optional boolean locked,
  optional any unused11,
  optional any unused12,
  optional integer unused13,
  optional string itempath)

Name

Description

unused1

Optional. Not used in this method.

unused2

Optional. Not used in this method.

objclass

Optional. The object class which is the last to be displayed as a property page. The base classes of the specified class are not displayed.

focusattr

Optional. The property on which the focus is set. If no property is specified, the first page is shown.

domodal

Optional. If it is true, the dialog is shown modal and the property editor uses the transaction that is passed. If the value is false, the property editor uses a new transaction. The default value is false.

unused6

attrs

Optional. The properties which are going to be displayed by the property editor. If the list is empty all properties of the object class are displayed.

formsobj

checkaction

locked

Optional. If the value is true, the object is locked and the property editor does not lock and unlock it.

unused11

unused12

unused13

itempath

Optional. The path used for indirect linking of properties.

Additional Information


COOATTREDIT@1.1:EditOfflineAttributes Permanent link for this heading

Offline edit properties of object

void COOATTREDIT@1.1:EditOfflineAttributes()

Additional Information


COOATTREDIT@1.1:EditSelectedObjectsAttributes Permanent link for this heading

Object::EditSelectedObjectsAttributes ("Edit properties of selected objects") opens the Property Editor and displays the properties for each selected object for editing. This method is specified to be called for the selected objects or the object currently open in the desk. The called method is Object::EditObjectAttributes.

void COOATTREDIT@1.1:EditSelectedObjectsAttributes()

Additional Information


COOATTREDIT@1.1:EditSelectedObjectsCommonAttributes Permanent link for this heading

Object::EditSelectedObjectsCommonAttributes ("Edit common properties of selected objects") opens one property editor to edit the common properties of the selected objects. If you close the property editor you are asked to confirm the changes for the properties. Use this method to set a property of several objects one value. This method is specified to be called for the selected objects only. It has the hint MH_NEEDSLOCALGUI assigned.

void COOATTREDIT@1.1:EditSelectedObjectsCommonAttributes()

Additional Information


COOATTREDIT@1.1:EditUserSettings Permanent link for this heading

Object::EditUserSettings ("Edit User Settings") edits the settings of the user including the language used in the user environment. It has the hint MH_NEEDSLOCALGUI assigned.

void COOATTREDIT@1.1:EditUserSettings()

Additional Information


COOATTREDIT@1.1:EditUserSubstitution Permanent link for this heading

Object::EditUserSubstitution ("Edit properties of user substitution object") edits the properties of the user substitution object. It has the hint MH_NEEDSLOCALGUI assigned.

void COOATTREDIT@1.1:EditUserSubstitution()

Additional Information


COOATTREDIT@1.1:GetAdditionalAppUsers Permanent link for this heading

Calculate additional users for an app. Note.: There is no check if suffficent licenses are available and no unique checks are performed

User[] COOATTREDIT@1.1:GetAdditionalAppUsers(
  object app,
  ref retval User[] users)

Name

Description

app

the required app

users

the result

Additional Information


COOATTREDIT@1.1:GetAllProductsUsers Permanent link for this heading

Calculate all assigned users for each product

UserAppList[] COOATTREDIT@1.1:GetAllProductsUsers(
  optional UserAppList[] productstocheck,
  optional datetime refdate,
  out retval UserAppList[] licensedusers)

Name

Description

productstocheck

if no products are supplied just the licensed products are checked

refdate

the parameter is used to retrieve the licenses if no products are supplied

licensedusers

the licensed users

Additional Information


COOATTREDIT@1.1:GetAppInstance Permanent link for this heading

You can implement the action Object::GetAppInstance for your own object class. This action can provide an app instance that should be checked, if the instance is not passed to the CheckLicense or CheckAppLicense action. If the app or the app instance is not licensed, this instance will be passed to the shop, too. The action will only be called if no app instance was passed to CheckLicense/CheckAppLicense. In this way it is possible to provide an app instance even if the license check is done by generic use cases.

void COOATTREDIT@1.1:GetAppInstance(
  optional object app,
  out optional string instance)

Name

Description

app

The App to be checked.

instance

The instance which should be used for the license check.

Additional Information


COOATTREDIT@1.1:GetAppPkgConfiguredApps Permanent link for this heading

Calculate the configured apps which are licensed to the organization included in an app package

App[] COOATTREDIT@1.1:GetAppPkgConfiguredApps(
  out retval App[] apps)

Name

Description

apps

the configured apps

Additional Information


COOATTREDIT@1.1:GetAppsAssignment Permanent link for this heading

Retrieve the assigned apps for an group

UserAppAssignmentList[] COOATTREDIT@1.1:GetAppsAssignment(
  out retval UserAppAssignmentList[] assignedapps)

Name

Description

assignedapps

Additional Information


COOATTREDIT@1.1:GetAppsAssignmentObject Permanent link for this heading

Retrieve the apps assigment object for the current organiztion

AppsAssignment COOATTREDIT@1.1:GetAppsAssignmentObject(
  boolean createnonexisting,
  out retval AppsAssignment appsassignmentobject)

Name

Description

createnonexisting

appsassignmentobject

Additional Information


COOATTREDIT@1.1:GetAppUsers Permanent link for this heading

Group::GetAppUsersCalculates all assigned users for a given app

object[] COOATTREDIT@1.1:GetAppUsers(
  object app,
  optional string instance,
  out retval object[] users,
  out integer freelics,
  out integer totallics,
  optional datetime refdate,
  optional UserAppList[] licensedpackages,
  optional UserAppList[] checkapps)

Name

Description

app

The app to be checked

instance

(optional) The instance of the app to be checked

users

The assigned users

freelics

The number of currently free licenses

totallics

The number of licenses for this product

refdate

licensedpackages

checkapps

Additional Information


COOATTREDIT@1.1:GetAvailableEditions Permanent link for this heading

Retrieve all available editions

AppPackage[] COOATTREDIT@1.1:GetAvailableEditions(
  boolean fulleditions,
  boolean readeditions,
  boolean defaultedition,
  boolean legacyeditions,
  boolean contextspecificlicenses,
  out retval AppPackage[] editions)

Name

Description

fulleditions

the available full editions

readeditions

the available read editions

defaultedition

the default edition configured at domain level

legacyeditions

the legacy editions

contextspecificlicenses

the available editions for external members

editions

all available editions

Additional Information


COOATTREDIT@1.1:GetBasePackage Permanent link for this heading

object COOATTREDIT@1.1:GetBasePackage(
  out retval object package)

Name

Description

package

Additional Information


COOATTREDIT@1.1:GetCachedUserPackages Permanent link for this heading

Get the packages of the selected user in context of the organization. Note.: The context specific license is evaluated as if the user would act in the context of the group

UserAppList[] COOATTREDIT@1.1:GetCachedUserPackages(
  User user,
  out retval UserAppList[] licensedapps)

Name

Description

user

the required user

licensedapps

the licensed packages in the context of the group

Additional Information


COOATTREDIT@1.1:GetContextSpecificEdition Permanent link for this heading

Retrieve the available context specific editions

AppPackage[] COOATTREDIT@1.1:GetContextSpecificEdition(
  out retval AppPackage[] contextspecificeditions)

Name

Description

contextspecificeditions

Additional Information


COOATTREDIT@1.1:GetDefaultApps Permanent link for this heading

Get the default apps

App[] COOATTREDIT@1.1:GetDefaultApps(
  out retval App[] defaultapps)

Name

Description

defaultapps

Additional Information


COOATTREDIT@1.1:GetDefaultPackage Permanent link for this heading

Get default package of a user or group

AppPackage COOATTREDIT@1.1:GetDefaultPackage(
  out retval AppPackage defaultpackage,
  boolean contextspecific)

Name

Description

defaultpackage

the package

contextspecific

the default package for context specific license assignment is required

Additional Information


COOATTREDIT@1.1:GetEditionLogoContext Permanent link for this heading

Returns the logo object container of the edition if the user has assigned only one edition. As fallback the default logo is returned.

void COOATTREDIT@1.1:GetEditionLogoContext(
  out object logocontainer,
  out object bgimagecontainer)

Name

Description

logocontainer

the container with the logo

bgimagecontainer

Additional Information


COOATTREDIT@1.1:GetExpiringApps Permanent link for this heading

object[] COOATTREDIT@1.1:GetExpiringApps(
  out retval object[] apps,
  optional integer expireindays,
  optional datetime expirebefore)

Name

Description

apps

expireindays

expirebefore

Additional Information


COOATTREDIT@1.1:GetFullEdition Permanent link for this heading

Retrieve the available full editions

AppPackage COOATTREDIT@1.1:GetFullEdition(
  out retval AppPackage edition)

Name

Description

edition

the full edition

Additional Information


COOATTREDIT@1.1:GetGroupLicensedPackagesByType Permanent link for this heading

Retrieve the group packages separated by the package type

AppPackage[] COOATTREDIT@1.1:GetGroupLicensedPackagesByType(
  out AppPackage[] fullaccess,
  out AppPackage[] readaccess,
  out AppPackage[] contextaccess,
  out retval AppPackage[] packages,
  optional boolean nofallback)

Name

Description

fullaccess

full access packages

readaccess

read access packages

contextaccess

packages for context specific members

packages

all packages

nofallback

the fall back for no licensed packages is skipped

Additional Information


COOATTREDIT@1.1:GetGroupPackages Permanent link for this heading

UserAppList[] COOATTREDIT@1.1:GetGroupPackages(
  object group,
  optional object context,
  out retval UserAppList[] licensedapps,
  optional boolean usecache)

Name

Description

group

context

licensedapps

usecache

Additional Information


COOATTREDIT@1.1:GetLicenseContextGroups Permanent link for this heading

Retrieve the groups for the supplied user which are relevant for license evaluation.

object[] COOATTREDIT@1.1:GetLicenseContextGroups(
  optional object context,
  optional boolean fullapps,
  out retval object[] groups)

Name

Description

context

the context object which is used to choose the requested organization

fullapps

if set to true all memberships are considered independent of the supplied context

groups

the result

Additional Information


COOATTREDIT@1.1:GetLicenseTeam Permanent link for this heading

Gets the License team for a specific edition

Group COOATTREDIT@1.1:GetLicenseTeam(
  AppPackage edition,
  out retval Group licenseteam,
  optional boolean createnonexisting)

Name

Description

edition

the target edition

licenseteam

the license team

createnonexisting

if no license team exists the license team will be created

Additional Information


COOATTREDIT@1.1:GetLicensingApps Permanent link for this heading

Get the licensing apps for an object

void COOATTREDIT@1.1:GetLicensingApps(
  optional boolean objdirect,
  optional string instance,
  out object[] licensedapps,
  out object[] expiredapps,
  out object[] notlicensedapps,
  optional boolean useonlylicensingapps)

Name

Description

objdirect

the object self

instance

the identification for an app instance

licensedapps

the licensing apps

expiredapps

the expired apps

notlicensedapps

the not licensed apps

useonlylicensingapps

only the licensing apps will be used

Additional Information


COOATTREDIT@1.1:GetObjectQuickSearchAppearance Permanent link for this heading

Get additional description for quick search

void COOATTREDIT@1.1:GetObjectQuickSearchAppearance(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  out optional QuickSearchAppearance appearance)

Name

Description

patternattrdef

pattern

targetattrdef

targetmode

appearance

Additional Information


COOATTREDIT@1.1:GetObjectQuickSearchMLText Permanent link for this heading

void COOATTREDIT@1.1:GetObjectQuickSearchMLText(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  out optional string[] multilinetext)

Name

Description

patternattrdef

pattern

targetattrdef

targetmode

multilinetext

Additional Information


COOATTREDIT@1.1:GetObjectQuickSearchSuffix Permanent link for this heading

Get additional description for quick search

void COOATTREDIT@1.1:GetObjectQuickSearchSuffix(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  out optional string suffix)

Name

Description

patternattrdef

pattern

targetattrdef

targetmode

suffix

Additional Information


COOATTREDIT@1.1:GetPackageApps Permanent link for this heading

Get the apps included in the packages

PackageAppList[] COOATTREDIT@1.1:GetPackageApps(
  out retval PackageAppList[] apps,
  out ActivatedPackageApps[] activatedconfiguredgapps,
  out App[] configuredapps)

Name

Description

apps

the included apps

activatedconfiguredgapps

the activated configured apps

configuredapps

the included configured apps

Additional Information


COOATTREDIT@1.1:GetProductUserAssignment Permanent link for this heading

Retrieve the current product assignment for a user Note.: Only licensed products are returned

AppPackage COOATTREDIT@1.1:GetProductUserAssignment(
  User targetuser,
  out retval AppPackage package,
  out App[] apps)

Name

Description

targetuser

the selected user

package

the package which is assigned

apps

the apps which are assigned

Additional Information


COOATTREDIT@1.1:GetReadEdition Permanent link for this heading

Retrieve the available read editions

AppPackage[] COOATTREDIT@1.1:GetReadEdition(
  out retval AppPackage[] editions)

Name

Description

editions

retrieve the available read edition

Additional Information


COOATTREDIT@1.1:GetRequestedApps Permanent link for this heading

object[] COOATTREDIT@1.1:GetRequestedApps(
  out retval object[] apps,
  optional object object,
  optional object view,
  optional object[] selobjects)

Name

Description

apps

object

view

selobjects

Additional Information


COOATTREDIT@1.1:GetRootPackage Permanent link for this heading

Get root package

object COOATTREDIT@1.1:GetRootPackage(
  out retval object package)

Name

Description

package

Additional Information


COOATTREDIT@1.1:GetState Permanent link for this heading

App::GetState Returns the current state of the app.

boolean COOATTREDIT@1.1:GetState(
  out retval boolean enabled,
  out boolean adjustable,
  out boolean licensed,
  out boolean expired,
  out boolean visible,
  out datetime trialdate,
  out boolean requirementmissing,
  optional string instance)

Name

Description

enabled

The app is currently enabled.

adjustable

The user can enable/disable the app.

licensed

The app is currently licensed by the user.

expired

The license of the app is currently expired.

visible

App is visible in app list.

trialdate

App is licensed as trial with this date.

requirementmissing

This app is licensed itself but a required package is missing.

instance

Instance to be checked.

Additional Information


COOATTREDIT@1.1:GetTimeDisp Permanent link for this heading

string COOATTREDIT@1.1:GetTimeDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

Name

Description

attrdef

string

value

language

attrdeflist

flags

index

Additional Information


COOATTREDIT@1.1:GetTimeIntervalDisp Permanent link for this heading

Get time interval display string

string COOATTREDIT@1.1:GetTimeIntervalDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

Name

Description

attrdef

string

value

language

attrdeflist

flags

index

Additional Information


COOATTREDIT@1.1:GetUniqueGroupPackageList Permanent link for this heading

Get consolidated apps and package list for the group which are currently licensed

UserAppList[] COOATTREDIT@1.1:GetUniqueGroupPackageList(
  out retval UserAppList[] packages,
  out UserAppList[] apps,
  optional datetime refdate,
  optional boolean includeconfigpkgapps,
  optional boolean onlyactiveconfigpkgapps,
  optional boolean checkassignmentmode,
  optional boolean requirecontextassignment)

Name

Description

packages

the consolidated packages

apps

the consolidated apps

refdate

a timestamp to check if the package is valid

includeconfigpkgapps

configured apps included in app packages are included in parameter apps (default is true)

onlyactiveconfigpkgapps

configured apps of app packages are only included if the group activated the configured app (default is true)

checkassignmentmode

the license assignment mode should be checked

requirecontextassignment

the user requires a context specific license assignment

Additional Information


COOATTREDIT@1.1:GetUserProfile Permanent link for this heading

object COOATTREDIT@1.1:GetUserProfile(
  out retval object userprofile,
  optional object container,
  optional object view,
  optional AttributeObjectDef attrdef)

Name

Description

userprofile

container

view

attrdef

Additional Information


COOATTREDIT@1.1:GetViewForm Permanent link for this heading

This action is used to calculate the editor view defined in classviews. All classview entries are sorted according to the viewpriority. Then the scoping rules are applied. After that the viewaction is evaluated according to the entries in the actionrefs respectively the action Then the viewscope is checked. And last but not least the accesscheck and the viewcondition is evaluated.

void COOATTREDIT@1.1:GetViewForm(
  ref object action,
  string[] actionrefs,
  optional object formclass,
  object objclass,
  out object form,
  out object checkaction,
  optional boolean recursive,
  out object triggeraction)

Name

Description

action

the action for which the form should be calculated.

actionrefs

Optional. Set of actions are defined as reference. If defined this actions are used instead of parameter action.

formclass

Optional. Formclass to define additional classviews.

objclass

The value list of this property is sorted.

form

the return value.

checkaction

recursive

Optional. Calculate the form recursive.

triggeraction

Additional Information


COOATTREDIT@1.1:GetVolumeLicenseInfo Permanent link for this heading

Retrieve the volume license object for the current organiztion

VolumeLicenseInfo COOATTREDIT@1.1:GetVolumeLicenseInfo(
  boolean createnonexisting,
  out retval VolumeLicenseInfo vollicinfo)

Name

Description

createnonexisting

create if not existing

vollicinfo

the volume license information object

Additional Information


COOATTREDIT@1.1:GroupAppsChanged Permanent link for this heading

void COOATTREDIT@1.1:GroupAppsChanged(
  object group)

Name

Description

group

Additional Information


COOATTREDIT@1.1:HasLicensed Permanent link for this heading

User::HasLicensedCheck if an app is licensed for the given user.

boolean COOATTREDIT@1.1:HasLicensed(
  App app,
  optional boolean trial,
  optional string instance,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

Name

Description

app

App to be checked.

trial

Trials can be considered as valid licensing.

instance

Instance to be checked.

context

silentmode

if set no errors will be raised

haslicense

additional to possible errors the result of the license check will be returned in this parameter

Additional Information


COOATTREDIT@1.1:HasValidEdition Permanent link for this heading

This action is used to check the licensed edition of an user

boolean COOATTREDIT@1.1:HasValidEdition(
  out retval boolean result,
  out AppPackage edition,
  optional object context,
  optional boolean isedit,
  optional boolean isread,
  optional boolean isdefault)

Name

Description

result

the return valued indicates if the user has an edition licensed matching the conditions defined with the other parameters. The parameters isedit, isread and isregistered are connected with an OR-Condition if they are defined.

edition

the currently licensed edition of this user

context

the context is used the determine the license e.g. the current teamroom can be supplied

isedit

the licensed edition has to be an edition which provides change permissions

isread

the licensed edition has to be an edition which provides read permissions

isdefault

the licensed edition has to be the default edition. In the Fabasoft Cloud the default edition is FSCFOLIOCLOUDPACKAGES@1.1001:AppPackageCloudRegisteredUser Examples:

coouser.HasValidEdition(&result, &edition);

The current user requires an edition with change access: coouser.HasValidEdition(&result, &edition, , true); coouser.HasValidEdition(&result, &edition, myteamroom, true);

The current user requires an edition with only read access: coouser.HasValidEdition(&result, &edition, , , true); coouser.HasValidEdition(&result, &edition, , false, true);

coouser.HasValidEdition(&result, &edition, myteamroom, , true); coouser.HasValidEdition(&result, &edition, myteamroom, false, true);

The current user requires an edition with change or read access but not the default edition: coouser.HasValidEdition(&result, &edition, myteamroom, true, true); coouser.HasValidEdition(&result, &edition, myteamroom, true, true);

Additional Information


COOATTREDIT@1.1:IsFeatureFlagEnabled Permanent link for this heading

Tests if the given Feature Flag is assigned on the

boolean COOATTREDIT@1.1:IsFeatureFlagEnabled(
  FeatureFlag requestedfeature,
  out retval boolean enabled)

Name

Description

requestedfeature

enabled

Additional Information


COOATTREDIT@1.1:IsGroupServiceUser Permanent link for this heading

Check if the current user is a service user of the group and will receive all licenses of the group

boolean COOATTREDIT@1.1:IsGroupServiceUser(
  Group group,
  out retval boolean isprivileged)

Name

Description

group

the target group

isprivileged

the result

Additional Information


COOATTREDIT@1.1:IsLicenseTeam Permanent link for this heading

Checks if the object is a licensing team

boolean COOATTREDIT@1.1:IsLicenseTeam(
  optional Group targetgroup,
  out retval boolean islicenseteam)

Name

Description

targetgroup

the target organization

islicenseteam

the result

Additional Information


COOATTREDIT@1.1:IsPackageUsableFor Permanent link for this heading

Check if the edition can be use for members or for context specific license assignment

boolean COOATTREDIT@1.1:IsPackageUsableFor(
  out retval boolean memberassignment,
  out boolean contextassignment)

Name

Description

memberassignment

the package is usable for members of the group

contextassignment

the package is usable for

Additional Information


COOATTREDIT@1.1:IsPossibleDefaultApp Permanent link for this heading

Decide if the current app is a possible default app

boolean COOATTREDIT@1.1:IsPossibleDefaultApp(
  out retval boolean ispossible)

Name

Description

ispossible

Additional Information


COOATTREDIT@1.1:IsPrivilegedLicensingUser Permanent link for this heading

Verify if user is privileged user for the app license management

void COOATTREDIT@1.1:IsPrivilegedLicensingUser(
  out boolean privileged)

Name

Description

privileged

Additional Information


COOATTREDIT@1.1:IsUpdateLicenseTeamMembersAllowed Permanent link for this heading

Checks if the membership of the license teams can be updated

boolean COOATTREDIT@1.1:IsUpdateLicenseTeamMembersAllowed(
  out retval boolean isallowed)

Name

Description

isallowed

Additional Information


COOATTREDIT@1.1:LicenseTo Permanent link for this heading

void COOATTREDIT@1.1:LicenseTo(
  object user,
  datetime from,
  datetime to,
  optional string key,
  optional integer quantity,
  optional object data,
  optional boolean trial,
  optional string instance,
  optional boolean asdefaultapp)

Name

Description

user

from

to

key

quantity

data

trial

instance

asdefaultapp

Additional Information


COOATTREDIT@1.1:ModifyPage Permanent link for this heading

Modify display items of page

void COOATTREDIT@1.1:ModifyPage(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

Name

Description

form

page

uiverb

action

formpageitems

objclass

formpagelabel

formpageicon

localscope

Additional Information


COOATTREDIT@1.1:OpenAllObjectAttributes Permanent link for this heading

Open all properties of object

void COOATTREDIT@1.1:OpenAllObjectAttributes()

Additional Information


COOATTREDIT@1.1:OpenAllSelectedObjectsAttributes Permanent link for this heading

View all properties of selected objects

void COOATTREDIT@1.1:OpenAllSelectedObjectsAttributes()

Additional Information


COOATTREDIT@1.1:OpenObjectAttributes Permanent link for this heading

Object::OpenObjectAttributes Opens a read/edit attribute dialog depending on the property usrenvopenreadonly.

void COOATTREDIT@1.1:OpenObjectAttributes()

Additional Information


COOATTREDIT@1.1:OpenSelectedObjectsAttributes Permanent link for this heading

Object::OpenSelectedObjectsAttributes Opens a read/edit attribute dialog for the selected objects.

void COOATTREDIT@1.1:OpenSelectedObjectsAttributes()

Additional Information


COOATTREDIT@1.1:QuickSearch Permanent link for this heading

void COOATTREDIT@1.1:QuickSearch(
  optional object patternattrdef,
  optional string pattern,
  optional object targetattrdef,
  optional CheckAllowedMode targetmode,
  optional integer objectlimit,
  out object[] foundobjects,
  ref optional integer pendingkey,
  out optional string[] customobjnames)

Name

Description

patternattrdef

pattern

targetattrdef

targetmode

objectlimit

foundobjects

pendingkey

customobjnames

Additional Information


COOATTREDIT@1.1:ReadObjectAttributes Permanent link for this heading

Object::ReadObjectAttributes ("Read properties of object") opens the Property Editor in read-only mode and displays the properties of the object. It has the hint MH_NEEDSLOCALGUI assigned.

void COOATTREDIT@1.1:ReadObjectAttributes(
  optional integer unused1,
  optional integer unused2,
  optional object objclass,
  optional object focusattr,
  optional boolean domodal,
  optional string unused6,
  optional object[] attrs,
  optional object formsobj,
  optional any unused9,
  optional any unused10,
  optional any unused11,
  optional any unused12,
  optional integer unused13,
  optional string itempath)

Name

Description

unused1

Not used in this method.

unused2

Not used in this method.

objclass

Optional. The object class of the object.

focusattr

Optional. The property on which the focus is set. If no property is specified, the first page is shown.

domodal

Optional. If the value is true, the dialog is shown modal. The default value is false. The parameter hwndparent should be defined.

unused6

attrs

Optional. The properties which are going to be displayed by the property editor. If the list is empty all properties of the object class are displayed.

formsobj

Optional. The form object used to display the properties.

unused9

unused10

unused11

unused12

unused13

itempath

The path used for indirect linking of properties.

Additional Information


COOATTREDIT@1.1:ReadSelectedObjectsAttributes Permanent link for this heading

Object::ReadSelectedObjectsAttributes ("Read properties of selected objects") opens the Property Editor in read-only mode and displays the properties for each selected object. It is implemented with the generic action COODESKCallSelectedObjects of the software component Desk. This method is specified to be called for the selected objects ot the object currently open in the desk. The called method is Object::ReadObjectAttributes.

void COOATTREDIT@1.1:ReadSelectedObjectsAttributes()

Additional Information


COOATTREDIT@1.1:SelectObjects Permanent link for this heading

Object::SelectObjects ("Select object(s) from object list") is used to select an object or several objects from an object list. Use this method if you want the user to select objects from a list because it can also be used with the Web Client. If you use e.g. a message box instead it is not displayed on a Web Client.

void COOATTREDIT@1.1:SelectObjects(
  optional integer unused1,
  optional integer unused2,
  string caption,
  string prompt,
  ControlStyle[] ctrlstyles,
  ref object[] objects,
  optional integer unused7,
  optional object[] selobjects)

Name

Description

unused1

unused2

caption

The caption of the dialog.

prompt

The string displayed before the object list control.

ctrlstyles

The list of control styles.

objects

The list of selected objects.

unused7

selobjects

Additional Information


COOATTREDIT@1.1:SelectValues Permanent link for this heading

Select value(s) from value list

void COOATTREDIT@1.1:SelectValues(
  optional integer unused1,
  optional integer unused2,
  string caption,
  string prompt,
  ControlStyle[] ctrlstyles,
  ref any values,
  optional integer unused7,
  optional integer[] selindexlist)

Name

Description

unused1

unused2

caption

prompt

ctrlstyles

values

unused7

selindexlist

Additional Information


COOATTREDIT@1.1:SetAppLicenseCheckError Permanent link for this heading

void COOATTREDIT@1.1:SetAppLicenseCheckError(
  integer errno,
  boolean expired,
  object[] apps,
  dictionary params)

Name

Description

errno

expired

apps

params

Additional Information


COOATTREDIT@1.1:SetPageItems Permanent link for this heading

void COOATTREDIT@1.1:SetPageItems(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOATTREDIT@1.1:SetUserRolePostWrapper Permanent link for this heading

User::SetUserRolePostWrapper ("Wrapper after "Set user role"") makes the status line topic after a user changed his current role.

void COOATTREDIT@1.1:SetUserRolePostWrapper(
  object group,
  object position,
  optional object substuser)

Name

Description

group

The group part of the users role.

position

The position part of the users role.

substuser

Additional Information


COOATTREDIT@1.1:ShouldUpdateProductAssignment Permanent link for this heading

Hook action to check if the products assignment should be updated. This action is used to handle the replication between cloud locations

boolean COOATTREDIT@1.1:ShouldUpdateProductAssignment(
  out retval boolean update,
  out boolean updatevolumelicenses)

Name

Description

update

the products assignment is updated.

updatevolumelicenses

determines if the volume licenses should be updated

Additional Information


COOATTREDIT@1.1:ShowError Permanent link for this heading

Object::ShowError ("Show error message") displays an error message. It depends on the settings in the user environment whether the error message is displayed in the status bar of the desk or in a separate message box. Use this method to display an error message.

void COOATTREDIT@1.1:ShowError(
  optional integer unused1,
  optional integer hresult,
  ref optional boolean cancelstate)

Name

Description

unused1

hresult

Optional. The error that occurred.

cancelstate

Additional Information


COOATTREDIT@1.1:Sort Permanent link for this heading

Object::Sort ("Sort List of Values") sorts the specified value list in the specified order.

any COOATTREDIT@1.1:Sort(
  ref retval any valuelist,
  optional boolean ascending,
  optional object[] attrpath,
  optional boolean nullismax)

Name

Description

valuelist

The list of values to be sorted. After the method call it contains the sorted list of values.

ascending

Optional. true means ascending sort order, false means descending sort order. If this parameter is omitted true is used.

attrpath

Optional. The value list of this property is sorted.

nullismax

Additional Information


COOATTREDIT@1.1:UpdateProductUserAssignment Permanent link for this heading

The product assignment is updated for the target user

void COOATTREDIT@1.1:UpdateProductUserAssignment(
  User targetuser,
  ComponentObject[] products,
  boolean replace,
  boolean updateautoassignment,
  boolean silent,
  optional boolean checkassignmentmode,
  optional boolean requirecontextassignment)

Name

Description

targetuser

the selected user

products

the products

replace

the supplied products override the currently assigned products. Otherwise the products are appended

updateautoassignment

silent

no errors are raised in case of insufficient licenses

checkassignmentmode

the license assignment mode should be checked

requirecontextassignment

the user requires a context specific license assignment

Additional Information


COOATTREDIT@1.1:UpdateVolumeLicenses Permanent link for this heading

Updates the VolumeLicensePeriodSpan of the current organization based on the subscriptions

void COOATTREDIT@1.1:UpdateVolumeLicenses()

Additional Information


COOATTREDIT@1.1:UseRestrictedAccessForm Permanent link for this heading

Action to check if a restricted form should be displayed instead of the normal form

boolean COOATTREDIT@1.1:UseRestrictedAccessForm(
  out retval boolean userestricedform)

Name

Description

userestricedform

Additional Information


COOATTREDIT@1.1:UserProfileFilter Permanent link for this heading

void COOATTREDIT@1.1:UserProfileFilter(
  ref object[] objects,
  object attrdef,
  optional object object,
  optional object view,
  optional object[] selobjects,
  optional CheckAllowedMode mode)

Name

Description

objects

attrdef

object

view

selobjects

mode

Additional Information


COOATTREDIT@1.1:UserProfileFilterClasses Permanent link for this heading

User profile filter for object classes

void COOATTREDIT@1.1:UserProfileFilterClasses(
  ref object[] objects,
  object attrdef,
  CheckAllowedMode mode,
  optional object object,
  optional object view,
  optional object[] selobjects,
  ref optional object[] allowedobjects)

Name

Description

objects

the objects which should be filtered

attrdef

the property in the user profile which contains the valid values

mode

the CheckAllowedMod

object

the container

view

the target attribute definition

selobjects

the selected objects

allowedobjects

the allowed objects

Additional Information


COOATTREDIT@1.1:ValidateAccount Permanent link for this heading

User::ValidateAccount ("Validate UserAccount") displays a dialog and asks the user to enter a user name and a password. Then it checks the specified password. If it is not correct, an appropriate error is set.

void COOATTREDIT@1.1:ValidateAccount(
  optional integer unused1,
  string caption,
  optional string prompt,
  optional string promptremark,
  ref optional string remark,
  optional boolean remarkneeded)

Name

Description

unused1

caption

The caption of the dialog.

prompt

The prompt.

promptremark

remark

remarkneeded

Additional Information