Object Class Announcement (FSCANNOUNCEMENT@1.1001:Announcement)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:CompoundObject > FSCANNOUNCEMENT@1.1001:Announcement

Class used to define special Announcements like Promotions

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: true
Action for Moving Objects: COODESK@1.1:DragIntoMove
Abstract: false
ACL Object: COOSYSTEM@1.1:DefaultGlobalACL
Default ACL for New Objects: COOSYSTEM@1.1:DefaultGlobalACL
Symbol: COODESK@1.1:SymbolAnnouncement
Commonly usable: true
Base Class: COOSYSTEM@1.1:CompoundObject
Action for Linking Objects: COODESK@1.1:DragIntoLink
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Display Mode: DISP_LINES
Default Main Menu: COODESK@1.1:MenuRootFolder

Properties

ReferenceName
FSCANNOUNCEMENT@1.1001:ancdoneexprExpression to Be Done When All Steps Have Been Completed
FSCANNOUNCEMENT@1.1001:ancimportantAlways Show in Welcome Screen
FSCANNOUNCEMENT@1.1001:ancmultipleShow Announcement for All Concerned Objects
FSCANNOUNCEMENT@1.1001:ancobjectsConcerned Objects
FSCANNOUNCEMENT@1.1001:ancpackageEdition or App
FSCANNOUNCEMENT@1.1001:ancpostvalidcontDescription for completed Announcement
FSCANNOUNCEMENT@1.1001:ancpostvalidstrDescription for completed Announcement
FSCANNOUNCEMENT@1.1001:ancprevalidcontDescription for Announcement in Progress
FSCANNOUNCEMENT@1.1001:ancprevalidstrDescription for Announcement in Progress
FSCANNOUNCEMENT@1.1001:ancsymboldoneSymbol for Completed Announcement
FSCANNOUNCEMENT@1.1001:ancsymbolopenSymbol for Announcement in Progress
FSCANNOUNCEMENT@1.1001:anctasksElements of Announcement
FSCANNOUNCEMENT@1.1001:anctitleTitle
FSCANNOUNCEMENT@1.1001:ancvalidforTime Span to Complete (in Days)
FSCANNOUNCEMENT@1.1001:ancvalidforuserexprAlso Show Announcement for Users If
FSCANNOUNCEMENT@1.1001:ancvalidforusersShow Announcement for Following Users/Groups
FSCANNOUNCEMENT@1.1001:ancvalidfromValid From
FSCANNOUNCEMENT@1.1001:ancvalidtoValid to

Actions

ReferenceName
COOSYSTEM@1.1:AttrGetDisp
COOSYSTEM@1.1:ObjectPrepareCommit
FSCANNOUNCEMENT@1.1001:GetLangStringFromLangContent

Properties

FSCANNOUNCEMENT@1.1001:ancdoneexpr (Expression to Be Done When All Steps Have Been Completed)

Additional Information

Initialization Value: true;
Type: COOSYSTEM@1.1:STRINGLIST
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 254
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancimportant (Always Show in Welcome Screen)

This flag is used within ShowWelcomeScreenPreWrapper to force the Welcome Screen if it would otherwise be hidden because the user deactivated it.

Additional Information

Initialization Value: false
Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancmultiple (Show Announcement for All Concerned Objects)

This flag is used to display the announcement multiple times per user.

Additional Information

Initialization Value: false
Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancobjects (Concerned Objects)

This expression is only evaluated in combination with the flag FSCANNOUNDEMENT@1.1001:ancmultiple. The announcement will be displayed for each object returned by the expression.

Additional Information

Type: COOSYSTEM@1.1:STRINGLIST
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 254
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancpackage (Edition or App)

Package to be granted to the user

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOATTREDIT@1.1:AppPackage
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancpostvalidcont (Description for completed Announcement)

This text will be displayed when all announcement tasks have been done.

Additional Information

Type: COOSYSTEM@1.1:LanguageContentList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancpostvalidstr (Description for completed Announcement)

This text is displayed when all announcement tasks have been done. This property is obsolete now. Please use property ancpostvalidcont instead.

Additional Information

Type: COOSYSTEM@1.1:LanguageStringList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancprevalidcont (Description for Announcement in Progress)

This text will be displayed as long as there are open announcement tasks to do.

Additional Information

Type: COOSYSTEM@1.1:LanguageContentList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancprevalidstr (Description for Announcement in Progress)

This text will be displayed as long as there are open announcement tasks to do. This property is obsolete now. Please use property ancprevalidcont instead.

Additional Information

Type: COOSYSTEM@1.1:LanguageStringList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancsymboldone (Symbol for Completed Announcement)

This Symbol or Image Object will be shown when all Announcement Tasks have been done.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: FSCANNOUNCEMENT@1.1001:AttrSymbolSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOSYSTEM@1.1:Object
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: FSCANNOUNCEMENT@1.1001:AttrReferenceCopy
Must Be Defined: false
Visible: true


[top]

FSCANNOUNCEMENT@1.1001:ancsymbolopen (Symbol for Announcement in Progress)

This Symbol or Image Object will be shown as long as there are open Announcement Tasks to do.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: FSCANNOUNCEMENT@1.1001:AttrSymbolSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOSYSTEM@1.1:Object
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: FSCANNOUNCEMENT@1.1001:AttrReferenceCopy
Must Be Defined: false
Visible: true


[top]

FSCANNOUNCEMENT@1.1001:anctasks (Elements of Announcement)

List of Announcement Tasks which have to be completed in order to complete the whole Announcement

Additional Information

Access Types for Reading Property: COOSYSTEM@1.1:AccTypeReadComp
Changeable in Installed Component: true
Describes Child Relationship: true
Multiple Values (Overrides Type): true
Type: COOSYSTEM@1.1:OBJECTLIST
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Possible Object Class: FSCANNOUNCEMENT@1.1001:AnnouncementTask
Search for Allowed Classes Only: true
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeComp
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:AttrChildrenCopy
Must Be Defined: false
Visible: true
Action Called Before Property of Version Is Saved: COOSYSTEM@1.1:AttrChildrenFixManualVersion


[top]

FSCANNOUNCEMENT@1.1001:anctitle (Title)

Title

Additional Information

Type: COOSYSTEM@1.1:LanguageStringList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancvalidfor (Time Span to Complete (in Days))

All Announcement Tasks have to be finished before ancvalidfrom + ancvalidfor

Additional Information

Sign: true
Type: COOSYSTEM@1.1:INTEGER
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 10
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancvalidforuserexpr (Also Show Announcement for Users If)

This Expression will be executed to check if the announcement can be started for the current user.

Additional Information

Initialization Value: true;
Type: COOSYSTEM@1.1:STRINGLIST
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 254
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancvalidforusers (Show Announcement for Following Users/Groups)

The Announcement will only be calculated for the defined users. Groups listed in this property will be resolved recursively to a list of users

Additional Information

Changeable in Installed Component: true
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECTLIST
Possible Object Class: COOSYSTEM@1.1:AdministrationObject
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

FSCANNOUNCEMENT@1.1001:ancvalidfrom (Valid From)

The Announcement will be started if the current date is within ancvalidfrom and ancvalidto.

Additional Information

Disable Conversion: true
Type: COOSYSTEM@1.1:DATETIME
Changeable: true
Visible: true
Must Be Defined: false
Use Date Only: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCANNOUNCEMENT@1.1001:ancvalidto (Valid to)

The Announcement will be started if the current date is within ancvalidfrom and ancvalidto. ancvalidto has to be in the future of ancvalidfrom

Additional Information

Disable Conversion: true
Type: COOSYSTEM@1.1:DATETIME
Changeable: true
Visible: true
Must Be Defined: false
Use Date Only: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

Actions

COOSYSTEM@1.1:AttrGetDisp

Gets a display string, that visually represents the value of the property. Such actions can be specified in the property COOSYSTEM@1.1:attractgetdisp of a property definition. These actions can be called by the kernel, if a component requests the string representation of a property or by any other component, that displays a representation of properties.

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetDispPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectPrepareCommit

When an object is changed in a transaction, this action is called by the kernel before the commit is actually done. This action is intended to be overwritten to do some additional work or to override the default behaviour before the transaction starts committing.
ParameterTypeIn/OutOptionalDescription
internalchangeCOOSYSTEM@1.1:BOOLEANinfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCANNOUNCEMENT@1.1001:GetLangStringFromLangContent

ParameterTypeIn/OutOptionalDescription
langcontlistCOOSYSTEM@1.1:LanguageContentListinfalse
langstringCOOSYSTEM@1.1:STRINGoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]