Class COOSYSTEM@1.1:BasicObject

This abstract class is the base class for objects which have neither the base class CompoundObject nor the base class ContentObject.

Class Hierarchy

Object > BasicObject

Direct Subclasses

AnnouncementTask, AppRelease, Artist, BasicActiveReport, BulkOperationBasicObject, CADPreview, Channel, ChargingContainer, Check, CompareConflict, ConfigurationItem, ConsistencyRule, ContentServerConnection, ContextDeadlinePool, DatabaseExportControl, DataImport, DataImportContainer, DataImportControl, DataImportLog, DataImportRuleLog, DiagramObject, DisplayView, FailedMailDispatch, GroupDeadlinePool, HereMapsConnection, Holiday, InsightApp360Configuration, ITAsset, ITService, KeyStore, Layer, LicenseHistory, MBEntityDefinition, MBInSpireConfig, MBInSpireService, MembershipExclusion, MetaDataStampCategory, MindbreezeAttributeConfiguration, Notification, NotificationTemplate, OAuthClient, ObjectWithAgreement, ObjectWithUserForm, ODataService, OrganizationOrder, OrganizationTermination, ParticipantInstance, PaymentElement, PaymentModalities, PortalSearch, PrescriptionTemplate, ProblemRecord, ProcessOutput, PurchaseOrder, Queue, ReleasePackage, RelRep, RelRepDef, ReportConversion, ReportTable, RequestForChange, Review, RFCConnection, RoomProgressInfo, Rule, RuleAction, SearchForm, SearchTerm, SelectionDefinition, SelectionResult, SerialEMail, SplittingDefinition, State, StaticObjectList, StockConnection, StructuralChange, Subscription, SubscriptionTransaction, SuspendedDeadlines, Task, TemplateCategory, TemplateCategoryGroup, TextModuleCollection, ThesaurusImport, TransferProtocol, TransmissionLog, VAlarm, VEvent, VideoStream, VirtualDatabaseExportControl, VirusInfo, VTodo, WebTextModule

Additional Information

Commonly usable

Actions

Return Type	Signature
boolean	CanChangeProcessState( ProcessInstance procinst, ref retval boolean statechangeable)
boolean	CanReleaseTemplate( out retval boolean canrelease)
void	DoCancelFileObject( object parent, object view, optional boolean issublevel)
boolean	EnableRegistrationUC( AttributeDefinition exprattrdef, optional IncomingComponentCategory checkcat, out retval boolean enable)
void	EvaluateGenericNameBuild( optional boolean force)
IncomingComponentCategory	GetIncomingCategory( optional integer dynkey, optional boolean checkroom, out retval IncomingComponentCategory incat)
MBInSpireService	GetMBInSpireService( out retval MBInSpireService svc, optional object context)
object	GetReleasedTemplate( optional boolean checkreleased, out retval object releasedtemplate)
boolean	IsDraftTemplateTestable( out retval boolean istestable)
boolean	IsTemplateReleaseable( out retval boolean isreleaseable, out boolean requirereleasedversion)
void	ObjectReleaseVersion( datetime versdate)
void	SendBackgroundSecure( any[] to, optional any[] cc, optional any[] bcc, any subject, string[] body, optional object[] attachments, optional boolean usepubliclinks, optional ContentFormat downloadformat, out string[] errorlog, optional string replytoaddress, optional string headertitle, optional Language fallbacklanguage)

Actions

COOWF@1.1:CanChangeProcessState

Perform additional checks on the process object if the process state can be changed

boolean COOWF@1.1:CanChangeProcessState(
ProcessInstance procinst,
ref retval boolean statechangeable)

Name	Description
procinst	the process instance
statechangeable	the result

COOTC@1.1001:CanReleaseTemplate

Check if the current user is allowed to release a template or to withdraw the release.

boolean COOTC@1.1001:CanReleaseTemplate(
out retval boolean canrelease)

Name	Description
canrelease	the result;

FSCFOLIO@1.1001:DoCancelFileObject

Action used to cancel a file object or a file itself. The FCSCFOLIO@1.1001:bostate for the current object will be set to cancelled. If the current object is a business relevant object the document state objdocstate will also be changed to cancelled.
The object will be moved to the cancelled objects of the file or the room it belongs to.
It is also possible that the current ACL is changed.

The security context for objects assigned to a room can be influenced via the customization point CPGetRoomSecurity with the usecase parameter set to CtxMoveToCanceled.
If nothing can be evaluated for CtxMoveToCanceled, the customization point with the usecase parameter CtxMoveToWastebasket is evaluated.

void FSCFOLIO@1.1001:DoCancelFileObject(
  object parent,
  object view,
  optional boolean issublevel)

Name	Description
parent	parent object
view	current view
issublevel	is canceling document on sub level

FSCFOLIO@1.1001:EnableRegistrationUC

Action to check if the registration usecase is enabled.
By use of this action the menus for registering an re-registering objects can be enabled or disabled.
This action is also used to display or hide the work items to register objects by use of the activity ActDefRegisterIncomingDocument.

To display the registration menu the following conditions have to match:

the object has not been registered
CanRegister has to return true
the user needs change access to the object

To display the re-registration menu the following conditions have to match:

the object has been registered
CanRegister has to return false
the user needs change access to the object
the incoming category has to define a use case the change the registration
the object has to be registered to a file which is not canceled

boolean FSCFOLIO@1.1001:EnableRegistrationUC(
  AttributeDefinition exprattrdef,
  optional IncomingComponentCategory checkcat,
  out retval boolean enable)

Name	Description
exprattrdef	the attribute definition to decide which menu should be enabled or disabled (possible values are `icshowreregistermenu` and `icshowworkflowstep` for registering objects and `icshowreregistermenu` and `icshowreregisterwfstep` for re-registering objects)
checkcat	the supplied incoming category to perform the additional checks to enable/disable the menus (if no incoming category is supplied the incoming category is calculated by use of `GetIncomingCategory`)
enable	the result if the menu should be displayed

FSCCONFIG@1.1001:EvaluateGenericNameBuild

Calculates and sets the new name of the object

void FSCCONFIG@1.1001:EvaluateGenericNameBuild(
optional boolean force)

Name	Description
force	when `null` or `false`, the name is only generated if any of the defining properties of the namebuild are modified in this transaction

FSCFOLIO@1.1001:GetIncomingCategory

Get the possible incoming category for the current object.
At first the incoming category would be taken from property categoryregcategory of the assigned category of the object.
In case of processing the dynkey SearchLocalObjects is used as fallback to retrieve the matching incoming category.
The incoming category has to be usable for the current object to be returned. This check is done by calling action CheckIncomingCategoryAllowedClasses.
If no incoming category was found, the incoming category for generic registration could be used when allowed by CheckIncomingCategoryAllowedClasses.

IncomingComponentCategory FSCFOLIO@1.1001:GetIncomingCategory(
  optional integer dynkey,
  optional boolean checkroom,
  out retval IncomingComponentCategory incat)

Name	Description
dynkey	the key of the clicked menu entry generated by the dynamic menu action `GetMenuRegisterIncoming`
checkroom	if set to true `FSCTEAMROOM@1.1001:CalcDefaultRoomIncomingCategory` is used to identify the incoming category if `categoryregcategory` does not supply a valid incoming category.
incat	the result.

FSCMINDBREEZE@1.1001:GetMBInSpireService

Determine Mindbreeze Inspire Service

MBInSpireService FSCMINDBREEZE@1.1001:GetMBInSpireService(
out retval MBInSpireService svc,
optional object context)

Name	Description
svc	InSpire service
context	Context for service selection

COOTC@1.1001:GetReleasedTemplate

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

object COOTC@1.1001:GetReleasedTemplate(
optional boolean checkreleased,
out retval object releasedtemplate)

Name	Description
checkreleased	Checks the validity of the released template. The object is valid if it is usable and if it is the released template of a design template, or if it is the design template itself in case it is an object that does not need to be released.
releasedtemplate	the released template

COOTC@1.1001:IsDraftTemplateTestable

Checks if the draft template can be instantiated. Which is currently only relevant for user forms until the test room feature is available.

boolean COOTC@1.1001:IsDraftTemplateTestable(
out retval boolean istestable)

Name	Description
istestable	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

COOSYSTEM@1.1:ObjectReleaseVersion

Releases the specified version of the object. This version is automatically visible to all users who are not allowed to change the object.

void COOSYSTEM@1.1:ObjectReleaseVersion(
datetime versdate)

Name	Description
versdate	The date and time of the version of the object.

FSCFOLIO@1.1001:SendBackgroundSecure

Sends an e-mail via SMTP to the given users. The body can be defined as plain text only. The mail will be sent as HTML. Sender is defined by the SMTP-Configuration.

void FSCFOLIO@1.1001:SendBackgroundSecure(
  any[] to,
  optional any[] cc,
  optional any[] bcc,
  any subject,
  string[] body,
  optional object[] attachments,
  optional boolean usepubliclinks,
  optional ContentFormat downloadformat,
  out string[] errorlog,
  optional string replytoaddress,
  optional string headertitle,
  optional Language fallbacklanguage)

Name	Description
to	List of objects (users, contacts) or a list of strings to which an e-mail should be sent.
cc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in CC
bcc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in BCC.
subject	A subject is essential for an e-mail to be able to be sent. A subject can be either a plain string or a string object. If a string object is passed as subject, the used language is based on the user communication language. If there is no subject passed, the name or address from the first attachment will be used instead.
body	The text for the e-mail. Can contain: STRING, STRINGLIST.
attachments	A list of attachment objects for which MX urls or public links are inserted into the e-mail.
usepubliclinks	Generate public links instead of MX urls.
downloadformat	Use this download format in case of public links.
errorlog	Error log containing send errors.
replytoaddress	Use this replyto e-mail address.
headertitle	the text will be used as header title of the email.
fallbacklanguage	The fallback language is used when the email recipients are specified only by an email address, or when no communication language can be determined for an email recipient object.