integrated collaboration object model (icom) for interoperable...
TRANSCRIPT
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 1 of 244
Integrated Collaboration Object Model (ICOM) for Interoperable Collaboration Services Version 1.0
Committee Specification 01
31 January 2013
Specification URIs This version:
http://docs.oasis-open.org/icom/icom-ics/v1.0/cs01/icom-ics-v1.0-cs01.doc (Authoritative) http://docs.oasis-open.org/icom/icom-ics/v1.0/cs01/icom-ics-v1.0-cs01.html http://docs.oasis-open.org/icom/icom-ics/v1.0/cs01/icom-ics-v1.0-cs01.pdf
Previous version:
http://www.oasis-open.org/committees/download.php/46823/icom-ics-v1.0-csprd04.zip
Latest version: http://docs.oasis-open.org/icom/icom-ics/v1.0/icom-ics-v1.0.doc (Authoritative) http://docs.oasis-open.org/icom/icom-ics/v1.0/icom-ics-v1.0.html http://docs.oasis-open.org/icom/icom-ics/v1.0/icom-ics-v1.0.pdf
Technical Committee: OASIS Integrated Collaboration Object Model for Interoperable Collaboration Services (ICOM) TC
Chairs: Eric S. Chan ([email protected]), Oracle Kenneth P. Baclawski ([email protected]), Northeastern University
Editors: Eric S. Chan ([email protected]), Oracle Patrick Durusau ([email protected]), Individual
Additional artifacts: This prose specification is one component of a Work Product which also includes:
XML schemas: http://docs.oasis-open.org/icom/icom-ics/v1.0/cs01/schemas/
Declared XML namespaces: http://docs.oasis-open.org/ns/icom/core/201008 http://docs.oasis-open.org/ns/icom/accesscontrol/201008 http://docs.oasis-open.org/ns/icom/metadata/201008 http://docs.oasis-open.org/ns/icom/content/201008 http://docs.oasis-open.org/ns/icom/document/201008 http://docs.oasis-open.org/ns/icom/message/201008 http://docs.oasis-open.org/ns/icom/presence/201008 http://docs.oasis-open.org/ns/icom/contact/201008 http://docs.oasis-open.org/ns/icom/calendar/201008 http://docs.oasis-open.org/ns/icom/task/201008 http://docs.oasis-open.org/ns/icom/forum/201008 http://docs.oasis-open.org/ns/icom/conference/201008
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 2 of 244
Abstract: The Integrated Collaboration Object Model (ICOM) for Interoperable Collaboration Services defines a framework for integrating a broad range of domain models for collaboration activities in an integrated and interoperable collaboration environment.
The framework is not intended to prescribe how applications or services conforming to its model implement, store, or transport the data for objects. It is intended as a basis for integrating a broad range of collaboration objects to enable seamless transitions across collaboration activities. This enables applications to maintain a complete thread of conversations across multiple collaboration activities.
The model integrates a broad range of collaboration activities, by encompassing and improving on a range of models which are part of existing standards and technologies. The model is modular to allow extensibility. The core concepts, metadata concepts, and their relations are included in the Core, while the specific concepts and relations for each area of collaboration activities are defined in separate extension modules.
Status: This document was last revised or approved by the OASIS Integrated Collaboration Object Model for Interoperable Collaboration Services (ICOM) TC on the above date. The level of approval is also listed above.
Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using “Send A Comment” button on the Technical Committee’s web page at http://www.oasis-open.org/committees/icom/.
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http://www.oasis-open.org/committees/icom/ipr.php).
Citation format:
When referencing this specification the following citation format should be used:
[ICOM-ics-v1.0]
Integrated Collaboration Object Model (ICOM) for Interoperable Collaboration Services Version 1.0. 31 January 2013. OASIS Committee Specification 01.
http://docs.oasis-open.org/icom/icom-ics/v1.0/cs01/icom-ics-v1.0-cs01.html.
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 3 of 244
Notices
Copyright © OASIS Open 2013. All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.
The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 4 of 244
Table of Contents
1 Introduction ......................................................................................................................................... 11
1.1 Terminology ...................................................................................................................................... 12
1.2 Normative References ...................................................................................................................... 12
1.3 Non-Normative References .............................................................................................................. 12
2 Modeling Language ............................................................................................................................ 14
2.1 Introduction ....................................................................................................................................... 14
2.2 Class Definition Grammar ................................................................................................................. 14
2.3 Property Definition Grammar ............................................................................................................ 16
2.4 Namespaces ..................................................................................................................................... 19
3 Core Model ......................................................................................................................................... 20
3.1 Main Branch ...................................................................................................................................... 20
3.1.1 Entity and Top-Level Subclasses .............................................................................................. 20
3.1.2 Identifiable ................................................................................................................................. 20
3.1.3 Parental ..................................................................................................................................... 21
3.1.4 Extent ........................................................................................................................................ 22
3.1.5 Entity .......................................................................................................................................... 23
3.1.6 Overview of Scope, Subject, and Artifact Branches.................................................................. 27
3.2 Scope Branch ................................................................................................................................... 28
3.2.1 Scope and Top-Level Subclasses ............................................................................................. 28
3.2.2 Scope ........................................................................................................................................ 29
3.2.3 Community ................................................................................................................................ 31
3.2.4 Space ........................................................................................................................................ 33
3.3 Subject Branch ................................................................................................................................. 35
3.3.1 Subject and Top-Level Subclasses ........................................................................................... 35
3.3.2 Subject ....................................................................................................................................... 35
3.3.3 Group ......................................................................................................................................... 37
3.3.4 Actor .......................................................................................................................................... 39
3.3.5 Person ....................................................................................................................................... 41
3.3.6 Resource ................................................................................................................................... 45
3.3.7 ResourceType ........................................................................................................................... 47
3.3.8 ResourceTypeEnum .................................................................................................................. 48
3.3.9 ResourceBookingRule ............................................................................................................... 49
3.3.10 ResourceBookingRuleEnum ................................................................................................... 50
3.4 Artifact Branch .................................................................................................................................. 51
3.4.1 Artifact and Top-Level Subclasses ............................................................................................ 51
3.4.2 Item ............................................................................................................................................ 51
3.4.3 SpaceItem ................................................................................................................................. 53
3.4.4 Container ................................................................................................................................... 53
3.4.5 FolderContainer ......................................................................................................................... 54
3.4.6 Artifact ....................................................................................................................................... 55
3.4.7 Folder ........................................................................................................................................ 58
3.4.8 HeterogeneousFolder ................................................................................................................ 59
3.5 Access Control Model ....................................................................................................................... 61
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 5 of 244
3.5.1 Accessor .................................................................................................................................... 61
3.5.2 Owner ........................................................................................................................................ 61
3.5.3 RoleDefinition ............................................................................................................................ 62
3.5.4 Role ........................................................................................................................................... 63
3.5.5 Privilege ..................................................................................................................................... 65
3.5.6 PrivilegeEnum ........................................................................................................................... 66
3.5.7 AccessControlList ...................................................................................................................... 67
3.5.8 AccessControlEntry ................................................................................................................... 68
3.5.9 AccessType ............................................................................................................................... 69
3.5.10 AccessTypeEnum ................................................................................................................... 70
3.6 Metadata Model ................................................................................................................................ 71
3.6.1 ClassDefinition........................................................................................................................... 71
3.6.2 StereoType ................................................................................................................................ 74
3.6.3 StereoTypeEnum ...................................................................................................................... 75
3.6.4 PropertyDefinition ...................................................................................................................... 76
3.6.5 Property ..................................................................................................................................... 79
3.6.6 PropertyChoiceType .................................................................................................................. 81
3.6.7 PropertyType ............................................................................................................................. 82
3.6.8 PropertyTypeEnum ................................................................................................................... 83
3.6.9 Updatability ................................................................................................................................ 84
3.6.10 UpdatabilityEnum .................................................................................................................... 85
3.6.11 Cardinality................................................................................................................................ 86
3.6.12 CardinalityEnum ...................................................................................................................... 86
3.6.13 Marker and Subclasses ........................................................................................................... 87
3.6.14 Marker ..................................................................................................................................... 88
3.6.15 Category .................................................................................................................................. 89
3.6.16 CategoryApplication ................................................................................................................ 91
3.6.17 Tag .......................................................................................................................................... 92
3.6.18 TagApplication ......................................................................................................................... 94
3.6.19 RelationshipBondable ............................................................................................................. 95
3.6.20 RelationshipDefinition .............................................................................................................. 96
3.6.21 Relationship ............................................................................................................................. 98
3.7 Common Concepts ......................................................................................................................... 100
3.7.1 Addressable............................................................................................................................. 100
3.7.2 EntityAddress .......................................................................................................................... 101
3.7.3 Participant ................................................................................................................................ 102
3.7.4 Priority ..................................................................................................................................... 104
3.7.5 PriorityEnum ............................................................................................................................ 105
3.7.6 DateTimeResolution ................................................................................................................ 105
3.7.7 DateTimeResolutionEnum ...................................................................................................... 106
3.7.8 TimeZone ................................................................................................................................ 107
3.7.9 Location ................................................................................................................................... 108
3.7.10 GeoCoordinates .................................................................................................................... 110
4 Extension Modules ........................................................................................................................... 112
4.1 Overview of Extension Modules ..................................................................................................... 112
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 6 of 244
4.2 Content Module .............................................................................................................................. 114
4.2.1 MimeConvertible ..................................................................................................................... 114
4.2.2 Content .................................................................................................................................... 114
4.2.3 MultiContent ............................................................................................................................ 116
4.2.4 SimpleContent ......................................................................................................................... 117
4.2.5 OnlineContent.......................................................................................................................... 119
4.2.6 ContentDispositionType .......................................................................................................... 120
4.2.7 ContentDispositionTypeEnum ................................................................................................. 121
4.2.8 AttachedItem ........................................................................................................................... 122
4.3 Document Module ........................................................................................................................... 123
4.3.1 Versionable.............................................................................................................................. 123
4.3.2 VersionControlMetadata .......................................................................................................... 125
4.3.3 VersionSeries .......................................................................................................................... 127
4.3.4 Version .................................................................................................................................... 129
4.3.5 VersionType ............................................................................................................................ 131
4.3.6 VersionTypeEnum ................................................................................................................... 132
4.3.7 Document ................................................................................................................................ 133
4.3.8 WikiPage ................................................................................................................................. 134
4.4 Message Module ............................................................................................................................ 136
4.4.1 Message .................................................................................................................................. 136
4.4.2 UnifiedMessage ....................................................................................................................... 137
4.4.3 UnifiedMessageParticipant ...................................................................................................... 142
4.4.4 UnifiedMessageFlag ................................................................................................................ 143
4.4.5 UnifiedMessageFlagEnum ...................................................................................................... 144
4.4.6 UnifiedMessageDeliveryStatusNotificationRequest ................................................................ 145
4.4.7 UnifiedMessageDeliveryStatusNotificationRequestEnum ...................................................... 145
4.4.8 UnifiedMessageChannel ......................................................................................................... 146
4.4.9 UnifiedMessageChannelEnum ................................................................................................ 147
4.4.10 UnifiedMessageEditMode ..................................................................................................... 148
4.4.11 UnifiedMessageEditModeEnum ............................................................................................ 148
4.4.12 InstantMessage ..................................................................................................................... 150
4.4.13 InstantMessageType ............................................................................................................. 153
4.4.14 InstantMessageTypeEnum .................................................................................................... 154
4.4.15 InstantMessageChatStatus ................................................................................................... 155
4.4.16 InstantMessageChatStatusEnum .......................................................................................... 155
4.4.17 InstantMessageFeed ............................................................................................................. 156
4.4.18 InstantMessageConnection ................................................................................................... 158
4.5 Presence Module ............................................................................................................................ 161
4.5.1 Presence ................................................................................................................................. 161
4.5.2 PresenceEditMode .................................................................................................................. 163
4.5.3 PresenceEditModeEnum ......................................................................................................... 164
4.5.4 ContactMethod ........................................................................................................................ 165
4.5.5 ContactReachabilityStatus ...................................................................................................... 167
4.5.6 ContactReachabilityStatusEnum ............................................................................................. 167
4.5.7 Activity ..................................................................................................................................... 170
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 7 of 244
4.5.8 ActivityType ............................................................................................................................. 171
4.5.9 ActivityTypeEnum .................................................................................................................... 172
4.6 Address Book Module ..................................................................................................................... 173
4.6.1 AddressBook ........................................................................................................................... 173
4.6.2 PersonContact ......................................................................................................................... 174
4.7 Calendar Module ............................................................................................................................ 179
4.7.1 Calendar .................................................................................................................................. 179
4.7.2 OccurrenceSeries .................................................................................................................... 181
4.7.3 Occurrence .............................................................................................................................. 186
4.7.4 OccurrenceStatus .................................................................................................................... 192
4.7.5 OccurrenceStatusEnum .......................................................................................................... 192
4.7.6 OccurrenceType ...................................................................................................................... 193
4.7.7 OccurrenceTypeEnum ............................................................................................................ 194
4.7.8 OccurrenceParticipant ............................................................................................................. 195
4.7.9 OccurrenceParticipantStatus ................................................................................................... 196
4.7.10 OccurrenceParticipantStatusEnum ....................................................................................... 196
4.7.11 OccurrenceParticipantTransparency ..................................................................................... 197
4.7.12 OccurrenceParticipantTransparencyEnum ........................................................................... 198
4.7.13 OccurrenceEditMode ............................................................................................................. 199
4.7.14 OccurrenceEditModeEnum ................................................................................................... 200
4.8 Free Busy Module ........................................................................................................................... 200
4.8.1 FreeBusy ................................................................................................................................. 200
4.8.2 FreeBusyInterval ..................................................................................................................... 202
4.8.3 FreeBusyType ......................................................................................................................... 204
4.8.4 FreeBusyTypeEnum ................................................................................................................ 205
4.9 Task List Module ............................................................................................................................. 206
4.9.1 TaskList ................................................................................................................................... 206
4.9.2 Task ......................................................................................................................................... 207
4.9.3 TaskStatus ............................................................................................................................... 212
4.9.4 TaskStatusEnum ..................................................................................................................... 212
4.9.5 TaskParticipantStatus ............................................................................................................. 213
4.9.6 TaskParticipantStatusEnum .................................................................................................... 214
4.9.7 TaskEditMode.......................................................................................................................... 215
4.9.8 TaskEditModeEnum ................................................................................................................ 215
4.10 Forum Module ............................................................................................................................... 216
4.10.1 Discussion ............................................................................................................................. 216
4.10.2 DiscussionContainer ............................................................................................................. 217
4.10.3 DiscussionMessage .............................................................................................................. 218
4.10.4 TopicContainer ...................................................................................................................... 219
4.10.5 Forum .................................................................................................................................... 221
4.10.6 Topic ...................................................................................................................................... 223
4.10.7 Announcement ...................................................................................................................... 224
4.10.8 AnnouncementStatus ............................................................................................................ 226
4.10.9 AnnouncementStatusEnum ................................................................................................... 226
4.11 Conference Module ...................................................................................................................... 227
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 8 of 244
4.11.1 Conference ............................................................................................................................ 227
4.11.2 ConferenceType .................................................................................................................... 230
4.11.3 ConferenceTypeEnum .......................................................................................................... 231
4.11.4 ConferenceStatus .................................................................................................................. 232
4.11.5 ConferenceStatusEnum ........................................................................................................ 233
4.11.6 ConferenceSession ............................................................................................................... 233
4.11.7 ConferenceSessionEndingReason ....................................................................................... 236
4.11.8 ConferenceSessionEndingReasonEnum .............................................................................. 236
4.11.9 ConferenceSetting ................................................................................................................. 237
4.11.10 ConferenceParticipantRole ................................................................................................. 238
5 Conformance .................................................................................................................................... 241
5.1 Software Architecture or Framework Dependence......................................................................... 241
5.2 Platform Provider Conformance ..................................................................................................... 241
5.2.1 Platform Provider Conformance – No Extension Modules ...................................................... 241
5.2.2 Platform Provider Conformance – One or More Extension Modules ...................................... 241
5.3 Service Provider Conformance ....................................................................................................... 241
5.3.1 ICOM Service Provider – No Extension Modules ................................................................... 241
5.3.2 ICOM Service Provider – One or More Extension Modules .................................................... 241
5.4 ICOM Producer Conformance ........................................................................................................ 242
5.4.1 ICOM Producer Conformance – No Extension Modules ........................................................ 242
5.4.2 ICOM Producer Conformance – One or More Extension Modules ......................................... 242
5.5 ICOM Consumer Conformance ...................................................................................................... 242
5.5.1 ICOM Consumer Conformance – No Extension Modules ...................................................... 242
5.5.2 ICOM Consumer Conformance – Extension Modules ............................................................ 242
Appendix A. Acknowledgements ......................................................................................................... 243
Appendix B. Revision History .............................................................................................................. 244
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 9 of 244
Table of Figures
Figure 1: Entity and Top-Level Abstract Classes. ....................................................................................... 20
Figure 2: Entity Class Diagram. .................................................................................................................. 27
Figure 3: Scope, Subject, and Artifact Branches. ....................................................................................... 28
Figure 4: Scope Branch. ............................................................................................................................. 28
Figure 5: Scope Class Diagram. ................................................................................................................. 31
Figure 6: Community Class Diagram. ......................................................................................................... 33
Figure 7: Space Class Diagram. ................................................................................................................. 34
Figure 8: Subject Branch. ............................................................................................................................ 35
Figure 9: Subject Class Diagram. ............................................................................................................... 37
Figure 10: Group and Actor Class Diagram. ............................................................................................... 39
Figure 11: Person Class Diagram. .............................................................................................................. 45
Figure 12: Resource Class Diagram. .......................................................................................................... 47
Figure 13: Artifact Branch. .......................................................................................................................... 51
Figure 14: Artifact Class Diagram. .............................................................................................................. 58
Figure 15: Heterogeneous Folder Class Diagram. ..................................................................................... 60
Figure 16: Role Definition and Role Class Diagram. .................................................................................. 65
Figure 17: Access Control List Class Diagram. .......................................................................................... 71
Figure 18: Class Definition and Property Definition Class Diagram. .......................................................... 74
Figure 19: Property Definition and Property Class Diagram. ...................................................................... 81
Figure 20: Marker Branch. .......................................................................................................................... 87
Figure 21: Marker Class Diagram. .............................................................................................................. 89
Figure 22: Category and Category Application Class Diagram. ................................................................. 91
Figure 23: Tag and Tag Application Class Diagram. .................................................................................. 94
Figure 24: Relationship Class Diagram. ................................................................................................... 100
Figure 25: Containers of Collaboration Activities. ..................................................................................... 112
Figure 26: Composite Content Class Diagram. ........................................................................................ 116
Figure 27: Document, Version Series, and Version Class Diagram. ........................................................ 134
Figure 28: Wiki Page Class Diagram. ....................................................................................................... 136
Figure 29: Unified Message Class Diagram. ............................................................................................ 150
Figure 30: Instant Message Class Diagram. ............................................................................................. 153
Figure 31: Instant Message Feed and Connection Class Diagram. ......................................................... 158
Figure 32: Presence Class Diagram. ........................................................................................................ 163
Figure 33: Presence Contact Method and Instant Message Connection Class Diagram. ....................... 169
Figure 34: Address Book Class Diagram. ................................................................................................. 174
Figure 35: Person Contact Class Diagram. .............................................................................................. 179
Figure 36: Calendar Class Diagram. ......................................................................................................... 181
Figure 37: Occurrence Series Class Diagram. ......................................................................................... 186
Figure 38: Occurrence Class Diagram. ..................................................................................................... 191
Figure 39: Free Busy Class Diagram. ....................................................................................................... 204
Figure 40: Task List Class Diagram. ......................................................................................................... 207
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 10 of 244
Figure 41: Task Class Diagram. ............................................................................................................... 211
Figure 42: Forum Class Diagram. ............................................................................................................. 221
Figure 43: Conference Class Diagram. ..................................................................................................... 230
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 11 of 244
1 Introduction 1
The Integrated Collaboration Object Model (ICOM) for Interoperable Collaboration Services specification 2 defines a framework for integrating a broad range of domain model for collaboration activities in an 3 interoperable collaboration environment. The standard promotes an integrated user experience with 4 seamless transitions across collaboration activities. It enables applications to support continuity of 5 conversations across diverse collaboration activities. For example, applications can aggregate 6 conversation threads in email with other conversations on the same topic in instant message, over the 7 phone or via real-time conferencing, by discussion threads in community forum, weblog or micro blog, 8 and activity stream of participants from all channels. 9
The specification defines a core model and a set of extension modules. The core model (Section 3) 10 defines the classes (Section 3.1 Main Branch) that bring together the model of directory (Section 3.2 11 Scope Branch), identity management (Section 3.3 Subject Branch), and content management (Section 12 3.4 Artifact Branch) in a framework with a common access control model (Section 3.5) and metadata 13 model (Section 3.6). The extension modules in Section 4 extend the artifact and folder model of Artifact 14 Branch (Section 3.4) to define the specialized model for different collaboration activities. The range of 15 collaboration model includes content sharing and co-creation, asynchronous communication, instant 16 communication, presence awareness, moderated group discussion, time management, coordination, real-17 time interaction, etc. 18
The Subject and Artifact branches support separation of concerns for user administration and content 19 management. Subject branch includes the model of actors, groups of actors, and role assignment of 20 actors. Actors, groups, and roles typically appear as the subject in the (subject, privilege, object) triples of 21 an access control model. The Artifact branch includes the model of content and metadata produced by 22 actors. The Scope branch includes the model of communities and spaces that contain subjects and 23 artifacts. Communities and spaces join the subjects and artifacts in a role-based access control model 24 where a role is assigned to an actor in a specific scope. Thus Scope, Subject, and Artifact form a 25 framework for applications to integrate and interoperate with directory, identity management, content 26 management, and collaboration services. 27
The model specified in ICOM is part of existing standards and technologies, several of which are 28 referenced in Section 1.3 Non-Normative References. The model is modular and extensible, with 29 common concepts, metadata concepts, and their relations provided in the Core, while the specific 30 concepts and relations for each area of collaboration activities defined in separate extension modules. 31 ICOM core model encompasses LDAP Directory Information Models [RFC4512]. The extension modules 32 integrate models from Content Management Interoperability Services [CMIS], Java Content Repository 33 API [JCR 2.0], Web Distributed Authoring and Versioning (WebDAV) [RFC4918], Internet Message 34 Access Protocol (IMAP) [RFC2119], Simple Mail Transfer Protocol (SMTP) [RFC5321], Extensible 35 Messaging and Presence Protocol (XMPP) [RFC3920], XMPP Instant Messaging and Presence 36 [RFC3921], vCard MIME Directory Profile [RFC2426], Internet Calendaring and Scheduling Core Object 37 Specification (iCalendar) [RFC5545], and Calendaring Extensions to WebDAV (CalDAV) [RFC4791]. 38
ICOM is open for extensions with additional domain models to enable seamless integration with business 39 processes and social networks: for example in process integration domain which includes Business 40 Process Model and Notation [BPMN], Web Services Business Process Execution Language [WS-BPEL], 41 WS-BPEL Extension for People [BPEL4People], and Web Services for Human Task [WS-HumanTask]; in 42 social networking domain, which includes Friend of a Friend [FOAF], Semantically-Interlinked Online 43 Communities [SIOC], Open Social [OpenSocial], and Facebook Platform Open Graph [OpenGraph]. The 44 OASIS ICOM TC Wiki [ICOM Wiki] provides Non-Normative supplemental information, including 45 overview, primer, extensions, use cases, and mappings to various standard and proprietary data models. 46
The integrated model can be the foundation for defining the application programming interfaces (API) for 47 application developers to develop integrated collaboration applications to interoperate with collaboration 48 services. A service provider interface (SPI) can be specified to support interchangeable and interoperable 49 services that conform to the ICOM application framework. ICOM does not prescribe how applications or 50 services conforming to its model implement, store, or transport the data for objects. 51
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 12 of 244
52
1.1 Terminology 53
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD 54 NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be 55 interpreted as described in [RFC2119]. 56
1.2 Normative References 57
[CMIS] OASIS Standard, Content Management Interoperability Services (CMIS) Version 58 1.0, May 2010. (http://docs.oasis-open.org/cmis/CMIS/v1.0/os/cmis-spec-59 v1.0.doc) 60
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 61 14, RFC 2119, March 1997. (http://www.ietf.org/rfc/rfc2119.txt) 62
[RFC3986] Berners-Lee, T., Fielding, R., and Masinter, L., "Uniform Resource Identifier 63 (URI): Generic Syntax", STD 66, RFC 3986, January 2005. 64 (http://www.ietf.org/rfc/rfc3986.txt) 65
[RFC3987] Duerst, M. and Suignard, M., "Internationalized Resource Identifiers (IRIs)", RFC 66 3987, January 2005. (http://www.ietf.org/rfc/rfc3987.txt) 67
[XML SCHEMA] Biron, P.V. and Malhotra. A., "XML Schema Part 2: Datatypes Second Edition", 68 W3C Recommendation, 28 October 2004. (http://www.w3.org/TR/xmlschema-2/) 69
1.3 Non-Normative References 70
[BPEL4People] OASIS Committee Specification, WS-BPEL Extension for People (BPEL4People) 71 Specification Version 1.1, August 2010. http://docs.oasis-72 open.org/bpel4people/bpel4people-1.1.html 73
[BPMN] OMG, “Business Process Model and Notation (BPMN) Version 2.0”, January 74 2011. (http://www.omg.org/spec/BPMN/2.0/PDF) 75
[FOAF] Brickley, D. and Miller, L., “FOAF Vocabulary Specification”, August 2009. 76 (http://xmlns.com/foaf/spec/) 77
[ICOM Wiki] OASIS ICOM TC Wiki, (http://wiki.oasis-open.org/icom) 78
[JCR 2.0] Java Specification Request (JSR) 283, Content Repository for Java™ 79 Technology API 2.0 Specification, August 2009. 80 (http://jcp.org/en/jsr/detail?id=283) 81
[OpenGraph] Facebook Platform Open Graph Core Concepts, 82 (http://developers.facebook.com/docs/coreconcepts/) 83
[OpenSocial] OpenSocial and Gadgets Specification Group, “Social Data Specification”, 84 November 2010. (http://opensocial-85 resources.googlecode.com/svn/spec/2.0/Social-Data.xml) 86
[RFC2060] Crispin, M., "Internet Message Access Protocol – Version 4rev1", RFC 2060, 87 December 1996. (http://tools.ietf.org/html/rfc2060) 88
[RFC2426] Dawson, F. and Howes, T., "vCard MIME Directory Profile", RFC 2426, 89 September 1998. (http://tools.ietf.org/html/rfc2426) 90
[RFC3920] Saint-Andre, P., "Extensible Messaging and Presence Protocol (XMPP): Core", 91 RFC 3920, October 2004. (http://tools.ietf.org/html/rfc3920) 92
[RFC3921] Saint-Andre, P., " Extensible Messaging and Presence Protocol (XMPP): Instant 93 Messaging and Presence", RFC 3921, October 2004. 94 (http://tools.ietf.org/html/rfc3921) 95
[RFC4512] Zeilenga, K., "Lightweight Directory Access Protocol (LDAP): Directory 96 Information Models", RFC 4512, June 2006. (http://tools.ietf.org/html/rfc4512) 97
[RFC4791] Daboo, C. and Desruisseaux, B., "Calendaring Extensions to WebDAV 98 (CalDAV)", RFC 4791, March 2007. (http://tools.ietf.org/html/rfc4791) 99
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 13 of 244
[RFC4918] Dusseault, L., "HTTP Extensions for Web Distributed Authoring and Versioning 100 (WebDAV)", RFC 4918, June 2007. (http://tools.ietf.org/html/rfc4918) 101
[RFC5321] Klensin, J., "Simple Mail Transfer Protocol, Draft Standard” RFC 5321, October 102 2008. (http://tools.ietf.org/html/rfc5321) 103
[RFC5545] Desruisseaux, B., "Internet Calendaring and Scheduling Core Object 104 Specification (iCalendar)", RFC 5545, September 2009. 105 (http://tools.ietf.org/html/rfc5545) 106
[SIOC] W3C Member Submission, “SIOC Core Ontology Specification”, June 2007. 107 (http://www.w3.org/Submission/2007/SUBM-sioc-spec-20070612/) 108
[WS-BPEL] OASIS Standard, Web Services Business Process Execution Language Version 109 2.0, April 2007. http://docs.oasis-open.org/wsbpel/2.0/wsbpel-v2.0.html 110
[WS-HumanTask] OASIS Committee Specification, Web Services – Human Task (WS-HumanTask) 111 Specification Version 1.1, CS-01, August 2010. http://docs.oasis-112 open.org/bpel4people/ws-humantask-1.1-spec-cs-01.html 113
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 14 of 244
2 Modeling Language 114
2.1 Introduction 115
ICOM specifies a set of objects in a collaboration environment, in terms of class definitions and property 116 definitions of the classes. Objects comprise the information structures in a common application 117 framework. An ICOM information structure MAY be composed of information from multiple repositories or 118 collaboration services. 119
Note: To offer closer interoperability with OASIS Content Management Interoperability Services, ICOM 120 specification follows the class and property definitions grammar of CMIS specification [CMIS], which is a 121 normative reference for ICOM specification. ICOM specification adapts the CMIS class and property 122 definitions grammar to introduce mixed-in types, enumeration types, and other base types which are not 123 part of the domain model of CMIS Version 1 specification. 124
Note: One objective of ICOM standard is to offer seamless interoperability among identity management, 125 content management, and collaboration services. Scope and Subject classes, defined respectively in 126 Section 3.2 Scope Branch and Section 3.3 Subject Branch, can represent objects in Identity Management 127 domain (such as LDAP). Artifact classes defined in Section 3.4 Artifact Branch can represent the 128 extensions of CMIS Folder and Document base types. The extension modules in Section 4 define 129 specialized subclasses of artifact and folder in Artifact Branch to support collaboration activities. 130
Note: ICOM extends the CMIS base types in several ways. ICOM Relationship class defined in Section 131 3.6.21 can represent n-nary relationships whereas CMIS Relationship base type represents binary 132 relationships. ICOM version control model defined in Section 4.3.1 adopts the CMIS version control 133 model and extends it with the concept of representative copy. 134
ICOM application framework includes a core model and a set of extension modules. All objects in the 135 framework must be instances of at least one class. 136
Each class is defined in the class definition grammar, which specifies a namespace attribute, a 137
localName attribute, a description attribute, an extendsFrom attribute representing a set of zero or 138
more super classes, a stereotype attribute indicating whether a class is primary or mixin, an 139
isAbstract attribute indicating whether a primary class is abstract, an isEnumeration attribute 140
indicating whether instances of a primary class are enumerated, and a propertyDefinition attribute 141
defining a set of zero or more properties of objects of the class. The properties are defined in the property 142 definition grammar. 143
Note: The class and property definitions grammar corresponds to the UML meta-model, which is an OMG 144 Meta Object Facility (MOF) M2-model. Each of the classes and properties thus defined are faithfully 145 depicted by UML 2.0 diagrams in this specification. 146
A fully expanded class name, namespace/localName, MUST be unique within a domain. 147
Note: A namespace IRI reference qualifies a local name by associating the local name with the IRI 148 reference to derive an expanded name. 149
150
2.2 Class Definition Grammar 151
A class-definition MUST contain the following attributes: 152
namespace String 153
The namespace attribute specifies an IRI. 154
155
localName String 156
The localName attribute specifies a local name portion of an expanded name or qualified name. 157
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 15 of 244
158
description String (optional) 159
The description attribute describes the nature and intended use of a class. 160
161
extendsFrom IRI (multi-valued) 162
The extendsFrom attribute specifies a set of zero or more super classes. 163
164
stereotype Enum 165
The stereotype attribute specifies whether a class is a primary or mixin class. 166
The values of stereotype attribute are: 167
Primary: A primary class is part of a single inheritance class hierarchy; 168
Mixin: A mixin class is part of multiple inheritance class hierarchy. 169
A particular class is either a primary class or a mixin class, i.e. it cannot be both. 170
Inheritance is constrained by: 171
o a primary class MUST extend from one and only one primary class; 172
o a primary or mixin class MAY extend from zero or more mixin classes; 173
o a mixin class MUST NOT extend from a primary class. 174
An object MUST be an instance of one and only one primary class. 175
Note: When there is more than one super class in a class definition, at most one of the super 176 classes is a primary class and the rest of the super classes are mixin classes. For example, 177
Scope extends from Entity, RelationshipBondable, and Extent. Scope is a primary 178
class. Among its super classes, only Entity is a primary class while RelationshipBondable 179
and Extent are mixin classes. 180
181
isAbstract Boolean 182
The isAbstract attribute specifies whether a primary class is an abstract class. It is applicable 183
only when the value of stereotype attribute is Primary. 184
The values of isAbstract attribute are: 185
TRUE if the primary class is an abstract class; 186
FALSE if the primary class is not an abstract class. 187
The default value is FALSE. 188
Note: An abstract class typically does not provide a complete declaration and cannot be 189 instantiated. An abstract class is intended to be extended by other primary classes. 190
An abstract primary class MUST NOT extend from any non-abstract primary class. 191
192
isEnumeration Boolean 193
The isEnumeration attribute specifies whether instances of a primary class are enumerated in 194
a class definition. It is applicable only when the value of stereotype attribute is Primary. 195
The values of isEnumeration attribute are: 196
TRUE if the instances of a primary class are enumerated in a class definition; 197
FALSE if the instances of a primary class are not enumerated in a class definition. 198
The default value is FALSE. 199
Note: A primary class which is an enumeration of instances is also known as an enum class. 200
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 16 of 244
201
instances 202
The instances attribute enumerates instances of an enum class. It is applicable only when the 203
value of stereotype attribute is Primary and the value of isEnumeration attribute is TRUE. 204
205
propertyDefinition property-definition (multi-valued) 206
The propertyDefinition attribute defines a set of zero or more property definitions for a 207
class. 208
Property definitions of a class are a union of inherited property definitions from super classes and 209 property definitions explicitly defined on a class. 210
The order of property definitions within a class is not significant. 211
Property definitions MUST be uniquely named to avoid conflicts from multiple inheritances. 212
Note: It is possible for the same property definition to be inherited through different paths in a 213 super class hierarchy. Duplicate property definitions are eliminated from the set of property 214 definitions of a class. 215
216
2.3 Property Definition Grammar 217
A property-definition MUST contain the following attributes: 218
namespace String 219
The namespace attribute specifies an IRI. 220
221
localName String 222
The localName attribute specifies the local name portion of an expanded name or qualified 223
name. 224
225
description String (optional) 226
The description attribute specifies a description of a property 227
228
propertyType Enum 229
The propertyType attribute specifies a property-type for property values. 230
The value of propertyType attribute is one of the property-type names. The property-type 231
names include names for the following data type defined by XML Schema Part 2 [XML 232 SCHEMA]: 233
string (xsd:string) 234
boolean (xsd:boolean) 235
decimal (xsd:decimal) 236
integer (xsd:integer) 237
datetime (xsd:dateTime) 238
duration (xsd:duration) 239
iri (xsd:anyURI) 240
In addition, the following data type names are also specified by ICOM: 241
id (an opaque string representing an object id of an identifiable object) 242
html (a document or fragment of Hypertext Markup Language) 243
244
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 17 of 244
cardinality Enum 245
The cardinality attribute specifies a cardinality of property values. 246
The values of cardinality attribute are: 247
Single: Property can have zero or one value (if property is not required), or exactly one 248
value (if property is required) 249
Multi: Property can have zero or more values (if property is not required), or one or more 250
values (if property is required). 251
252
updatability Enum 253
The updatability attribute specifies under what circumstances the value of this property MAY 254
be updated. 255
The values of updatability attribute are: 256
ReadOnly: The value of this property MUST NOT be set directly by application. It is a 257
property that is either maintained or computed by a service provider. 258
WriteOnly: The value of this property can be set by application. It is a property whose 259
value MAY be propagated into another ReadOnly property by a service provider. 260
ReadWrite: The property value can be modified. 261
OnCreate: The property value MUST only be update-able during the creation (a create 262
operation) of an object. 263
264
inherited Boolean 265
The inherited attribute specifies whether a property definition is inherited from a super class. 266
The values of inherited attribute are: 267
TRUE if a property definition is inherited from a super class; 268
FALSE if a property definition is explicitly defined for a class. 269
270
required Boolean 271
The required attribute is only applicable to read-write and on-create properties, i.e. properties 272
whose value is provided by application. 273
The values of required attribute are: 274
TRUE if the value of a property MUST never be set to the “not set” state when an object of 275
this type is created or updated. If a value is not provided during a create or update 276 operation, a service provider MUST provide a value for the property. If a value is not 277 provided, then a default value defined for the property MUST be set. If no default value is 278 defined, a service provider MUST throw an exception. 279
FALSE if the value of a property MAY be set to the “not set” state when an object of this 280
type is created or updated. 281
This attribute is not applicable when the value updatability attribute is ReadOnly. In that 282
case, required attribute SHOULD be set to FALSE. 283
Note: The value of a read-only property (such as icom_core:objectId, 284
icom_core:createdBy) is set by a service provider. Hence, the value of the required 285
attribute SHOULD be FALSE because it is read only for applications. 286
287
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 18 of 244
choices property-choice-type (multi-valued) 288
The choices attribute specifies a set of single values allowed for this property. 289
Each value of choices attribute is an instance of property-choice-type that specifies a display 290
name and a value to be stored in a property when selected. 291
If the value of cardinatity attribute is Single and the value of openChoice attribute 292
is FALSE, then a property value MUST be at most one of the values listed in choices 293
attribute. 294
If the value of cardinatity attribute is Single and the value of openChoice attribute 295
is TRUE, then a property value MAY be one of the values listed in choices attribute. 296
If the value of cardinatity attribute is Multi and the value of openChoice attribute 297
is FALSE, then a property value MUST be zero, one, or more than one of the values 298
listed in choices attribute. 299
If the value of cardinatity attribute is Multi and the value of openChoice attribute 300
is TRUE, then a property value MAY be zero, one, or more than one of the values listed in 301
choices attribute. 302
If choices attribute is “not set”, then a property value MAY be an instance of the property-type 303
specified by the propertyType attribute of a property definition. 304
305
openChoice Boolean 306
The openChoice attribute specifies whether the value of a property must be listed in choices 307
attribute. It is applicable only when choices attribute is set. 308
The values of openChoice attribute are: 309
TRUE if a value of a property MAY be other than those listed in choices attribute; 310
FALSE if a value of a property MUST be among those listed in choices attribute. 311
312
defaultValue property-type 313
The defaultValue attribute specifies a value that a service provider MUST set for a property if 314
a value is not provided by application when an object is created. 315
If no default value is specified and application creates an object of this class without setting a 316 value for a property of this property definition, a service provider MUST attempt to store a “not 317 set” state for the property value. If this occurs for a property that is defined to be required, then a 318 service provider MUST throw an exception. 319
The value of the defaultValue attribute is an instance of the property-type specified by the 320
propertyType attribute of a property definition. 321
322
minValue Integer | Decimal 323
The minimum value allowed for a property. It is applicable only when the propertyType 324
attribute of a property definition specifies the property types Integer or Decimal. 325
326
maxValue Integer | Decimal 327
The maximum value allowed for a property. It is applicable only when the propertyType 328
attribute of a property definition specifies the property types Integer or Decimal. 329
330
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 19 of 244
A property-choice-type MUST contain the following attributes: 331
displayName String 332
The displayName attribute specifies a string for presentation by application. 333
334
value property-type 335
The value attribute specifies a value compatible with the property-type specified by the 336
propertyType attribute of a property definition. 337
338
2.4 Namespaces 339
Qualified names are subject to namespace interpretation depending on the namespace prefixes. 340
A class definition includes the two attributes: namespace and localName. The namespace specifies 341
one of the namespace prefixes in Table 1. The localName specifies an unprefixed name of a class. 342
Syntactically, the namespace qualifies the local name. 343
344
Table 1 Namespace prefixes and IRI references. 345
icom_core = http://docs.oasis-open.org/ns/icom/core/201008
icom_ac = http://docs.oasis-open.org/ns/icom/accesscontrol/201008
icom_meta = http://docs.oasis-open.org/ns/icom/metadata/201008
icom_content = http://docs.oasis-open.org/ns/icom/content/201008
icom_doc = http://docs.oasis-open.org/ns/icom/document/201008
icom_msg = http://docs.oasis-open.org/ns/icom/message/201008
icom_card = http://docs.oasis-open.org/ns/icom/contact/201008
icom_presence = http://docs.oasis-open.org/ns/icom/presence/201008
icom_cal = http://docs.oasis-open.org/ns/icom/calendar/201008
icom_task = http://docs.oasis-open.org/ns/icom/task/201008
icom_forum = http://docs.oasis-open.org/ns/icom/forum/201008
icom_conf = http://docs.oasis-open.org/ns/icom/conference/201008
346 Note: The namespace prefix icom_core represents the IRI reference http://docs.oasis-347 open.org/ns/icom/core/201008 for ICOM core namespace. Both the unprefixed name Entity and prefixed 348 name icom_core:Entity are qualified names that SHALL be interpreted by the expanded name 349 http://docs.oasis-open.org/ns/icom/core/201008#Entity. 350
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 20 of 244
3 Core Model 351
3.1 Main Branch 352
3.1.1 Entity and Top-Level Subclasses 353
354
Figure 1: Entity and Top-Level Abstract Classes. 355
Figure 1 depicts Entity and top-level abstract classes forming the main branch of the ICOM class 356 hierarchy. It depicts the Scope, Subject, and Artifact classes that represent the roots of the three major 357 sub-branches of ICOM class hierarchy. 358
3.1.2 Identifiable 359
3.1.2.1 Description 360
An identifiable object has objectId and changeToken properties. The assignment of an objectId is 361 implementation-dependent. The objectId is read only (immutable) once it is assigned. 362
3.1.2.2 Class Definition 363
The Identifiable class is a mixin class which defines the characteristics of entities and non-entities 364
that enables unique identification. 365
The Identifiable class has attribute values: 366
367
localNamespace 368
Value: icom_core 369
370
localName 371
Value: Identifiable 372
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 21 of 244
373
extendsFrom 374
Value: 375
376
stereotype 377
Value: mixin 378
379
description 380
Value: Identifiable is a mixin class which defines the characteristics of all entities and some non-381 entities that enables unique identification. 382
383
propertyDefinitions 384
The values for this attribute are defined in Section 3.1.2.3. 385
3.1.2.3 Property Definitions 386
The Identifiable class MUST have the property definitions: 387
388
icom_core:objectId 389
Description: A persistent identifier of an object. 390
Required: False 391
Inherited: False 392
Property Type: String 393
Cardinality: Single 394
Updatability: Read Only 395
396
icom_core:changeToken 397
Description: An opaque token used for optimistic locking & concurrency 398 checking. 399
Required: False 400
Inherited: False 401
Property Type: String 402
Cardinality: Single 403
Updatability: Read Only 404
405
The Identifiable class MAY include additional property definitions which are implementation-defined. 406
407
3.1.3 Parental 408
3.1.3.1 Description 409
A parental object may be a parent of other objects. 410
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 22 of 244
3.1.3.2 Class Definition 411
The Parental class is a mixin class which defines the characteristics of entities that may be parents of 412 other entities or identifiable objects. 413
The Parental class has attribute values: 414
415
localNamespace 416
Value: icom_core 417
418
localName 419
Value: Parental 420
421
extendsFrom 422
Value: icom_core:Identifiable 423
424
stereotype 425
Value: mixin 426
427
description 428
Value: Parental is a mixin class which defines the characteristics of the entities that can be 429 parents of other entities or identifiable objects. 430
431
propertyDefinitions 432
The values for this attribute are defined in Section 3.1.3.3. 433
3.1.3.3 Property Definitions 434
The Parental class inherits property definitions from super classes. 435
The Parental class MUST have the property definition: 436
437
icom_core:parent 438
Description: Parent of an object. 439
Required: False 440
Inherited: False 441
Property Type: icom_core:Parental 442
Cardinality: Single 443
Updatability: Read Only 444
445
The Parental class MAY include additional property definitions which are implementation-defined. 446
447
3.1.4 Extent 448
3.1.4.1 Description 449
An extent object is a parental object which may contain other entities. 450
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 23 of 244
3.1.4.2 Class Definition 451
The Extent class is a mixin class which defines characteristics of entities that may contain other entities. 452
The Extent class has attribute values: 453
454
localNamespace 455
Value: icom_core 456
457
localName 458
Value: Extent 459
460
extendsFrom 461
Value: icom_core:Parental 462
463
stereotype 464
Value: mixin 465
466
description 467
Value: Extent is a mixin class which defines the characteristics of entities that may contain other 468 entities. 469
470
propertyDefinitions 471
The values for this attribute are defined in Section 3.1.4.3. 472
3.1.4.3 Property Definitions 473
The Extent class inherits property definitions from super classes. 474
The Extent class MUST have the property definition: 475
476
icom_core:parent 477
Description: Parent of an extent. 478
Required: False 479
Inherited: True 480
Property Type: icom_core:Extent 481
Cardinality: Single 482
Updatability: Read Only 483
484
The Extent class MAY include additional property definitions which are implementation-defined. 485
486
3.1.5 Entity 487
3.1.5.1 Description 488
An entity is an identifiable object that can be persisted and that has an access control list. 489
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 24 of 244
Each entity is assigned an internationalized resource identifier (IRI) composed from its objectId. The form 490
of the IRI is implementation-dependent. 491
3.1.5.2 Class Definition 492
The Entity class has attribute values: 493
494
localNamespace 495
Value: icom_core 496
497
localName 498
Value: Entity 499
500
extendsFrom 501
Value: icom_core:Identifiable 502
503
stereotype 504
Value: primary 505
506
isAbstract 507
Value: TRUE 508
509
description 510
Value: An entity is an object with an immutable id and individual access control. 511
512
propertyDefinitions 513
The values for this attribute are defined in Section 3.1.5.3. 514
3.1.5.3 Property Definitions 515
The Entity class inherits property definitions from super classes. 516
The Entity class MUST have the property definitions: 517
518
icom_core:name 519
Description: Name of an entity. 520
Required: False 521
Inherited: False 522
Property Type: String 523
Cardinality: Single 524
Updatability: Read Write 525
526
icom_core:createdBy 527
Description: An actor who created an entity. 528
Required: False 529
Inherited: False 530
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 25 of 244
Property Type: icom_core:Actor 531
Cardinality: Single 532
Updatability: Read Only 533
534
icom_core:creationDate 535
Description: Date and time when an entity is created. It is immutable. 536
Required: False 537
Inherited: False 538
Property Type: DateTime 539
Cardinality: Single 540
Updatability: Read Only 541
542
icom_core:lastModifiedBy 543
Description: An actor who last modified an entity. 544
Required: False 545
Inherited: False 546
Property Type: icom_core:Actor 547
Cardinality: Single 548
Updatability: Read Only 549
550
icom_core:lastModificationDate 551
Description: Date and time of last modification. 552
Required: False 553
Inherited: False 554
Property Type: DateTime 555
Cardinality: Single 556
Updatability: Read Only 557
558
icom_core:parent 559
Description: A parental entity which contains an entity. 560
Required: False 561
Inherited: False 562
Property Type: icom_core:Parental 563
Cardinality: Single 564
Updatability: Read Only 565
566
icom_ac:owner 567
Description: A subject who owns an entity. 568
Required: True 569
Inherited: False 570
Property Type: icom_ac:Owner 571
Cardinality: Single 572
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 26 of 244
Updatability: Read Write 573
574
icom_ac:accessControlList 575
Description: Access control list on an entity. 576
Required: False 577
Inherited: False 578
Property Type: icom_ac:AccessControlList 579
Cardinality: Single 580
Updatability: Read Write 581
582
icom_meta:attachedMarker 583
Description: Zero or more markers applied on an entity. 584
Required: False 585
Inherited: False 586
Property Type: icom_meta:Marker 587
Cardinality: Multi 588
Updatability: Read Only 589
590
icom_meta:categoryApplication 591
Description: Zero or more category applications on an entity. 592
Required: False 593
Inherited: False 594
Property Type: icom_meta:CategoryApplication 595
Cardinality: Multi 596
Updatability: Read Only 597
598
icom_meta:tagApplication 599
Description: Zero or more tag applications on an entity. 600
Required: False 601
Inherited: False 602
Property Type: icom_meta:TagApplication 603
Cardinality: Multi 604
Updatability: Read Only 605
606
The Entity class MAY include additional property definitions which are implementation-defined. 607
608
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 27 of 244
609
Figure 2: Entity Class Diagram. 610
611
3.1.6 Overview of Scope, Subject, and Artifact Branches 612
The UML diagram in Figure 3 depicts the core classes in the Scope, Subject, and Artifact branches of 613 ICOM class hierarchy. Scope branch includes the model of communities and spaces which are containers 614 of subjects and artifacts. Subject branch includes the model of actors, groups, and roles. Artifact branch 615 includes the model of content and metadata produced by actors. 616
Note: The Subject and Artifact branches support the separation of concerns of user administration and 617 content management. Typically subjects and artifacts are joined in the (subject, privilege, artifact) triples 618 of access control model. Some of the (subject, privilege, artifact) triples are derived from the scopes of the 619 role assignments and the artifacts contained by the scopes. The communities and spaces contain 620 subjects and artifacts; however, membership of subjects in a space is administered separately from 621 management of artifacts in the space. 622
Scope, Subject, and Artifact are defined in Section 3.2, 3.3, and 3.4, respectively. 623
624
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 28 of 244
625
Figure 3: Scope, Subject, and Artifact Branches. 626
627
3.2 Scope Branch 628
3.2.1 Scope and Top-Level Subclasses 629
630
Figure 4: Scope Branch. 631
Figure 4 depicts the top-level classes of Scope Branch, which includes Scope, Community, and Space. 632
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 29 of 244
3.2.2 Scope 633
3.2.2.1 Description 634
A scope is an extent of an administrative policy. 635
3.2.2.2 Class Definition 636
The Scope class has attribute values: 637
638
localNamespace 639
Value: icom_core 640
641
localName 642
Value: Scope 643
644
extendsFrom 645
Value: icom_core:Entity, icom_core:Extent, icom_meta:RelationshipBondable 646
647
stereotype 648
Value: primary 649
650
isAbstract 651
Value: TRUE 652
653
description 654
Value: A scope is an extent of an administrative realm. 655
656
propertyDefinitions 657
The values for this attribute are defined in Section 3.2.2.3. 658
3.2.2.3 Property Definitions 659
The Scope class inherits property definitions from super classes. 660
The Scope class MUST have the property definitions: 661
662
icom_core:description 663
Description: A description of a scope. 664
Required: False 665
Inherited: False 666
Property Type: String 667
Cardinality: Single 668
Updatability: Read Write 669
670
icom_core:parent 671
Description: A community which contains a scope. 672
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 30 of 244
Required: False 673
Inherited: True 674
Property Type: icom_core:Community 675
Cardinality: Single 676
Updatability: Read Only 677
678
icom_core:group 679
Description: Zero or more groups defined in a scope. 680
Required: False 681
Inherited: False 682
Property Type: icom_core:Group 683
Cardinality: Multi 684
Updatability: Read Only 685
686
icom_core:memberGroup 687
Description: Member groups of a scope, i.e. groups whose assigned 688 scopes include this scope. 689
Required: False 690
Inherited: False 691
Property Type: icom_core:Group 692
Cardinality: Multi 693
Updatability: Read Only 694
695
icom_ac:roleDefinition 696
Description: Zero or more role definitions defined in a scope. 697
Required: False 698
Inherited: False 699
Property Type: icom_ac:RoleDefinition 700
Cardinality: Multi 701
Updatability: Read Only 702
703
icom_ac:role 704
Description: Zero or more roles defined in a scope. 705
Required: False 706
Inherited: False 707
Property Type: icom_ac:Role 708
Cardinality: Multi 709
Updatability: Read Only 710
711
icom_meta:relationship 712
Description: Zero or more relationships associated with a scope. 713
Required: False 714
Inherited: False 715
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 31 of 244
Property Type: icom_meta:Relationship 716
Cardinality: Multi 717
Updatability: Read Only 718
719
The Scope class MAY include additional property definitions which are implementation-defined. 720
721
722
Figure 5: Scope Class Diagram. 723
724
3.2.3 Community 725
3.2.3.1 Description 726
A community is a scope that has a set of actors as members who can participate in a set of spaces. 727
It is implementation-dependent whether or not a space in a community can include participating actors 728 who are not members of a parent community or ancestor communities. 729
3.2.3.2 Class Definition 730
The Community class has attribute values: 731
732
localNamespace 733
Value: icom_core 734
735
localName 736
Value: Community 737
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 32 of 244
738
extendsFrom 739
Value: icom_core:Scope 740
741
stereotype 742
Value: primary 743
744
description 745
Value: A community is a scope that has a set of actors as members who can participate in a set 746 of spaces. 747
748
propertyDefinitions 749
The values for this attribute are defined in Section 3.2.3.3. 750
3.2.3.3 Property Definitions 751
The Community class inherits property definitions from super classes. 752
The Community class MUST have the property definitions: 753
754
icom_core:community 755
Description: Sub-communities of a community. 756
Required: False 757
Inherited: False 758
Property Type: icom_core:Community 759
Cardinality: Multi 760
Updatability: Read Only 761
762
icom_core:space 763
Description: Spaces of a community. 764
Required: False 765
Inherited: False 766
Property Type: icom_core:Space 767
Cardinality: Multi 768
Updatability: Read Only 769
770
icom_core:actor 771
Description: Managed actors of a community, i.e. actors whose parent 772 community is this community. 773
Required: False 774
Inherited: False 775
Property Type: icom_core:Actor 776
Cardinality: Multi 777
Updatability: Read Only 778
779
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 33 of 244
icom_core:memberActor 780
Description: Member actors of a community, i.e. actors whose assigned 781 communities include this community. 782
Required: False 783
Inherited: False 784
Property Type: icom_core:Actor 785
Cardinality: Multi 786
Updatability: Read Only 787
788
The Community class MAY include additional property definitions which are implementation-defined. 789
790
791
Figure 6: Community Class Diagram. 792
793
3.2.4 Space 794
3.2.4.1 Description 795
A space is a scope that defines a durable context and place for actors to work or collaborate. 796
3.2.4.2 Class Definition 797
The Space class has attribute values: 798
799
localNamespace 800
Value: icom_core 801
802
localName 803
Value: Space 804
805
extendsFrom 806
Value: icom_core:Scope, icom_core:FolderContainer 807
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 34 of 244
808
stereotype 809
Value: primary 810
811
description 812
Value: A space is a scope that defines a durable context and place for actors to work or 813 collaborate. 814
815
propertyDefinitions 816
The values for this attribute are defined in Section 3.2.4.3. 817
3.2.4.3 Property Definitions 818
The Space class inherits property definitions from super classes. 819
The Space class MUST have the property definition: 820
821
icom_core:element 822
Description: Elements of a space. 823
Required: False 824
Inherited: True 825
Property Type: icom_core:SpaceItem 826
Cardinality: Multi 827
Updatability: Read Only 828
829
The Space class MAY include additional property definitions which are implementation-defined. 830
831
832
Figure 7: Space Class Diagram. 833
834
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 35 of 244
3.3 Subject Branch 835
3.3.1 Subject and Top-Level Subclasses 836
837
Figure 8: Subject Branch. 838
Figure 8 depicts the top-level classes of Subject Branch, which includes Subject, Role, Group, and Actor. 839
3.3.2 Subject 840
3.3.2.1 Description 841
A subject is an entity that can have rights to perform actions. 842
3.3.2.2 Class Definition 843
The Subject class has attribute values: 844
845
localNamespace 846
Value: icom_core 847
848
localName 849
Value: Subject 850
851
extendsFrom 852
Value: icom_core:Entity, icom_meta:RelationshipBondable 853
854
stereotype 855
Value: primary 856
857
isAbstract 858
Value: TRUE 859
860
description 861
Value: A subject is an entity that can have rights to perform actions. 862
863
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 36 of 244
propertyDefinitions 864
The values for this attribute are defined in Section 3.3.2.3. 865
3.3.2.3 Property Definitions 866
The Subject class inherits property definitions from super classes. 867
The Subject class MUST have the property definitions: 868
869
icom_core:description 870
Description: A description of a subject. 871
Required: False 872
Inherited: False 873
Property Type: String 874
Cardinality: Single 875
Updatability: Read Write 876
877
icom_core:parent 878
Description: A scope which contains a subject. 879
Required: False 880
Inherited: True 881
Property Type: icom_core:Scope 882
Cardinality: Single 883
Updatability: Read Only 884
885
icom_meta:relationship 886
Description: Zero or more relationships associated with a subject. 887
Required: False 888
Inherited: False 889
Property Type: icom_meta:Relationship 890
Cardinality: Multi 891
Updatability: Read Only 892
893
icom_meta:property 894
Description: Zero or more extended properties of a subject. 895
Required: False 896
Inherited: False 897
Property Type: icom_meta:Property 898
Cardinality: Multi 899
Updatability: Read Write 900
901
The Subject class MAY include additional property definitions which are implementation-defined. 902
903
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 37 of 244
904
Figure 9: Subject Class Diagram. 905
906
3.3.3 Group 907
3.3.3.1 Description 908
A group is a subject representing a set of actors and sub-groups. 909
A group can be part of one or more super-groups. 910
It can be an owner of one or more entities. 911
3.3.3.2 Class Definition 912
The Group class has attribute values: 913
914
localNamespace 915
Value: icom_core 916
917
localName 918
Value: Group 919
920
extendsFrom 921
Value: icom_core:Subject, icom_core:Addressable, icom_ac:Accessor 922
Optional Value: icom_ac:Owner 923
924
stereotype 925
Value: primary 926
927
description 928
Value: A group is a subject representing a set of actors and sub-groups. A group can be part of 929 one or more super-groups. It can be an owner of one or more entities. 930
931
propertyDefinitions 932
The values for this attribute are defined in Section 3.3.3.3. 933
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 38 of 244
3.3.3.3 Property Definitions 934
The Group class inherits property definitions from super classes. 935
The Group class MUST have the property definitions: 936
937
icom_core:assignedGroup 938
Description: A group’s super-groups. 939
Required: False 940
Inherited: False 941
Property Type: icom_core:Group 942
Cardinality: Multi 943
Updatability: Read Write 944
945
icom_core:assignedScope 946
Description: A group’s scopes. 947
Required: False 948
Inherited: False 949
Property Type: icom_core:Scope 950
Cardinality: Multi 951
Updatability: Read Write 952
953
icom_core:memberGroup 954
Description: Sub-groups of a group. 955
Required: False 956
Inherited: False 957
Property Type: icom_core:Group 958
Cardinality: Multi 959
Updatability: Read Only 960
961
icom_core:memberActor 962
Description: Actors in a group. 963
Required: False 964
Inherited: False 965
Property Type: icom_core:Actor 966
Cardinality: Multi 967
Updatability: Read Only 968
969
icom_ac:assignedRole 970
Description: A group’s roles. 971
Required: False 972
Inherited: False 973
Property Type: icom_ac:Role 974
Cardinality: Multi 975
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 39 of 244
Updatability: Read Write 976
977
The Group class MAY include additional property definitions which are implementation-defined. 978
979
980
Figure 10: Group and Actor Class Diagram. 981
982
3.3.4 Actor 983
3.3.4.1 Description 984
An actor is a subject that can perform actions on objects. 985
It can be an owner of entities. 986
3.3.4.2 Class Definition 987
The Actor class has attribute values: 988
989
localNamespace 990
Value: icom_core 991
992
localName 993
Value: Actor 994
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 40 of 244
995
extendsFrom 996
Value: icom_core:Subject, icom_core:Addressable, icom_ac:Owner 997
998
stereotype 999
Value: primary 1000
1001
isAbstract 1002
Value: TRUE 1003
1004
description 1005
Value: An actor is a subject that can perform actions on objects. 1006
1007
propertyDefinitions 1008
The values for this attribute are defined in Section 3.3.4.3. 1009
3.3.4.3 Property Definitions 1010
The Actor class inherits property definitions from super classes. 1011
The Actor class MUST have the property definitions: 1012
1013
icom_core:parent 1014
Description: A community which contains an actor. 1015
Required: False 1016
Inherited: True 1017
Property Type: icom_core:Community 1018
Cardinality: Single 1019
Updatability: Read Only 1020
1021
icom_core:assignedGroup 1022
Description: An actor’s groups. 1023
Required: False 1024
Inherited: False 1025
Property Type: icom_core:Group 1026
Cardinality: Multi 1027
Updatability: Read Write 1028
1029
icom_core:assignedCommunity 1030
Description: An actor’s communities. 1031
Required: False 1032
Inherited: False 1033
Property Type: icom_core:Community 1034
Cardinality: Multi 1035
Updatability: Read Write 1036
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 41 of 244
1037
icom_ac:assignedRole 1038
Description: An actor’s roles. 1039
Required: False 1040
Inherited: False 1041
Property Type: icom_ac:Role 1042
Cardinality: Multi 1043
Updatability: Read Write 1044
1045
The Actor class MAY include additional property definitions which are implementation-defined. 1046
1047
3.3.5 Person 1048
3.3.5.1 Description 1049
A person is an individual human who may be an actor. 1050
A person has a personal space. 1051
3.3.5.2 Class Definition 1052
The Person class has attribute values: 1053
1054
localNamespace 1055
Value: icom_core 1056
1057
localName 1058
Value: Person 1059
1060
extendsFrom 1061
Value: icom_core:Actor 1062
1063
stereotype 1064
Value: primary 1065
1066
description 1067
Value: A person is an individual human who may be an actor. 1068
1069
propertyDefinitions 1070
The values for this attribute are defined in Section 3.3.5.3. 1071
3.3.5.3 Property Definitions 1072
The Person class inherits property definitions from super classes. 1073
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 42 of 244
The Person class MUST have the property definitions: 1074
1075
icom_core:givenName 1076
Description: Given name of a person. 1077
Required: False 1078
Inherited: False 1079
Property Type: String 1080
Cardinality: Single 1081
Updatability: Read Write 1082
1083
icom_core:middleName 1084
Description: Middle name of a person. Can include multiple names 1085 concatenated. 1086
Required: False 1087
Inherited: False 1088
Property Type: String 1089
Cardinality: Single 1090
Updatability: Read Write 1091
1092
icom_core:familyName 1093
Description: Family name of a person. 1094
Required: False 1095
Inherited: False 1096
Property Type: String 1097
Cardinality: Single 1098
Updatability: Read Write 1099
1100
icom_core:prefix 1101
Description: Prefix of a person’s name. 1102
Required: False 1103
Inherited: False 1104
Property Type: String 1105
Cardinality: Single 1106
Updatability: Read Write 1107
1108
icom_core:suffix 1109
Description: Suffix of a person’s name. 1110
Required: False 1111
Inherited: False 1112
Property Type: String 1113
Cardinality: Single 1114
Updatability: Read Write 1115
1116
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 43 of 244
icom_core:nickname 1117
Description: Nickname of a person. 1118
Required: False 1119
Inherited: False 1120
Property Type: String 1121
Cardinality: Multi 1122
Updatability: Read Write 1123
1124
icom_core:jobTitle 1125
Description: Job title of a person. 1126
Required: False 1127
Inherited: False 1128
Property Type: String 1129
Cardinality: Single 1130
Updatability: Read Write 1131
1132
icom_core:department 1133
Description: A person’s affiliated department. 1134
Required: False 1135
Inherited: False 1136
Property Type: String 1137
Cardinality: Single 1138
Updatability: Read Write 1139
1140
icom_core:officeLocation 1141
Description: Location of a person’s department. 1142
Required: False 1143
Inherited: False 1144
Property Type: String 1145
Cardinality: Single 1146
Updatability: Read Write 1147
1148
icom_core:company 1149
Description: A person’s affiliated company. 1150
Required: False 1151
Inherited: False 1152
Property Type: String 1153
Cardinality: Single 1154
Updatability: Read Write 1155
1156
icom_core:profession 1157
Description: A person’s profession. 1158
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 44 of 244
Required: False 1159
Inherited: False 1160
Property Type: String 1161
Cardinality: Single 1162
Updatability: Read Write 1163
1164
icom_core:personalSpace 1165
Description: Personal space of a person. 1166
Required: False 1167
Inherited: False 1168
Property Type: icom_core:Space 1169
Cardinality: Single 1170
Updatability: Read Only 1171
1172
icom_presence:presence 1173
Description: Presence of a person. 1174
Required: False 1175
Inherited: False 1176
Property Type: icom_presence:Presence 1177
Cardinality: Single 1178
Updatability: Read Only 1179
1180
icom_msg:instantMessageFeed 1181
Description: Instant message feed for a person. 1182
Required: False 1183
Inherited: False 1184
Property Type: icom_msg:InstantMessageFeed 1185
Cardinality: Single 1186
Updatability: Read Only 1187
1188
The Person class MAY include additional property definitions which are implementation-defined. 1189
1190
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 45 of 244
1191
Figure 11: Person Class Diagram. 1192
1193
3.3.6 Resource 1194
3.3.6.1 Description 1195
A resource is an actor representing a bookable resource, such as a conference room, equipment, or on-1196 line conference. 1197
A resource is associated with a resource space that contains a resource scheduling calendar and on-line 1198 conference. 1199
3.3.6.2 Class Definition 1200
The Resource class has attribute values: 1201
1202
localNamespace 1203
Value: icom_core 1204
1205
localName 1206
Value: Resource 1207
1208
extendsFrom 1209
Value: icom_core:Actor 1210
1211
stereotype 1212
Value: primary 1213
1214
description 1215
Value: A resource actor is an actor representing a bookable resource, such as a conference 1216 room, equipment, or on-line conference. 1217
1218
propertyDefinitions 1219
The values for this attribute are defined in Section 3.3.6.3. 1220
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 46 of 244
3.3.6.3 Property Definitions 1221
The Resource class inherits property definitions from super classes. 1222
The Resource class MUST have the property definitions: 1223
1224
icom_core:resourceSpace 1225
Description: Administrative space of a resource actor. 1226
Required: False 1227
Inherited: False 1228
Property Type: icom_core:Space 1229
Cardinality: Single 1230
Updatability: Read Only 1231
1232
icom_core:location 1233
Description: Location of a resource. 1234
Required: False 1235
Inherited: False 1236
Property Type: icom_core:Location 1237
Cardinality: Single 1238
Updatability: Read Write 1239
1240
icom_core:capacity 1241
Description: Capacity of a resource. 1242
Required: False 1243
Inherited: False 1244
Property Type: Integer 1245
Cardinality: Single 1246
Updatability: Read Write 1247
1248
icom_core:resourceType 1249
Description: Type of a resource. 1250
Required: False 1251
Inherited: False 1252
Property Type: icom_core:ResourceType 1253
Cardinality: Single 1254
Updatability: Read Write 1255
1256
icom_core:bookingRule 1257
Description: Resource booking rule. 1258
Required: False 1259
Inherited: False 1260
Property Type: icom_core:ResourceBookingRule 1261
Cardinality: Single 1262
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 47 of 244
Updatability: Read Write 1263
1264
icom_core:bookingApprover 1265
Description: One or more persons who approve the booking of a resource. 1266
Required: False 1267
Inherited: False 1268
Property Type: icom_core:Person 1269
Cardinality: Multi 1270
Updatability: Read Write 1271
1272
The Resource class MAY include additional property definitions which are implementation-defined. 1273
1274
1275
Figure 12: Resource Class Diagram. 1276
1277
3.3.7 ResourceType 1278
3.3.7.1 Description 1279
A resource type is a category of resources. 1280
3.3.7.2 Class Definition 1281
The ResourceType class is a mixin class which defines a resource type. 1282
The ResourceType class has attribute values: 1283
1284
localNamespace 1285
Value: icom_core 1286
1287
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 48 of 244
localName 1288
Value: ResourceType 1289
1290
extendsFrom 1291
Value: 1292
1293
stereotype 1294
Value: mixin 1295
1296
description 1297
Value: ResourceType is a mixin class which defines a type of resources. 1298
1299
propertyDefinitions 1300
The values for this attribute are defined in Section 3.3.7.3. 1301
3.3.7.3 Property Definitions 1302
The ResourceType class MAY include additional property definitions which are implementation-defined. 1303
1304
3.3.8 ResourceTypeEnum 1305
The ResourceTypeEnum class is an enum class that enumerates the instances each of which expresses 1306 a type of resources. 1307
The ResourceTypeEnum class has attribute values: 1308
1309
localNamespace 1310
Value: icom_core 1311
1312
localName 1313
Value: ResourceTypeEnum 1314
1315
extendsFrom 1316
Value: icom_core:ResourceType 1317
1318
stereotype 1319
Value: primary 1320
1321
isEnumeration 1322
Value: TRUE 1323
1324
description 1325
Value: A type of resources. 1326
1327
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 49 of 244
instances 1328
Value: <icom_core:Room, icom_core:Equipment, icom_core:OnlineConference, 1329 icom_core:OtherResourceType> 1330
1331
ICOM defines four resource types: 1332
icom_core:Room a resource represents a room. 1333
icom_core:Equipment a resource represents an equipment. 1334
icom_core:OnlineConference a resource represents an online conference. 1335
icom_core:OtherResourceType a resource represents other things. 1336
1337
3.3.9 ResourceBookingRule 1338
3.3.9.1 Description 1339
A resource booking rule is a strategy for allocating resources for calendar scheduling. 1340
3.3.9.2 Class Definition 1341
The ResourceBookingRule class is a mixin class which defines a resource booking rule. 1342
The ResourceBookingRule class has attribute values: 1343
1344
localNamespace 1345
Value: icom_core 1346
1347
localName 1348
Value: ResourceBookingRule 1349
1350
extendsFrom 1351
Value: 1352
1353
stereotype 1354
Value: mixin 1355
1356
description 1357
Value: ResourceBookingRule is a mixin class which defines a rule for allocating resources for 1358 calendar scheduling. 1359
1360
propertyDefinitions 1361
The values for this attribute are defined in Section 3.3.9.3. 1362
3.3.9.3 Property Definitions 1363
The ResourceBookingRule class MAY include additional property definitions which are implementation-1364 defined. 1365
1366
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 50 of 244
3.3.10 ResourceBookingRuleEnum 1367
The ResourceBookingRuleEnum class is an enum class that enumerates the instances each of which 1368 expresses a booking rule. 1369
The ResourceBookingRuleEnum class has attribute values: 1370
1371
localNamespace 1372
Value: icom_core 1373
1374
localName 1375
Value: ResourceBookingRuleEnum 1376
1377
extendsFrom 1378
Value: icom_core:ResourceBookingRule 1379
1380
stereotype 1381
Value: primary 1382
1383
isEnumeration 1384
Value: TRUE 1385
1386
description 1387
Value: A resource booking rule for allocating resources for calendar scheduling. 1388
1389
instances 1390
Value: <icom_core:Open, icom_core:FirstComeFirstServed> 1391
1392
ICOM defines two resource booking rules: 1393
icom_core:Open a resource is open for booking. 1394
icom_core:FirstComeFirstServed a resource is first come first served. 1395
1396
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 51 of 244
3.4 Artifact Branch 1397
3.4.1 Artifact and Top-Level Subclasses 1398
1399
Figure 13: Artifact Branch. 1400
Figure 13 depicts the top-level classes of Artifact Branch, which includes Artifact, Folder, 1401 HeterogeneousFolder, Document, and Message. 1402
3.4.2 Item 1403
3.4.2.1 Description 1404
An item is an element of a container. 1405
The parent of an item MUST be a container. 1406
3.4.2.2 Class Definition 1407
The Item class is a mixin class which defines the characteristics of entities that can be elements of a 1408 Container. 1409
The Item class has attribute values: 1410
1411
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 52 of 244
localNamespace 1412
Value: icom_core 1413
1414
localName 1415
Value: Item 1416
1417
extendsFrom 1418
Value: icom_core:Identifiable 1419
1420
stereotype 1421
Value: mixin 1422
1423
description 1424
Value: Item is a mixin class which defines the characteristics of entities that can be placed in a 1425 Container. 1426
1427
propertyDefinitions 1428
The values for this attribute are defined in Section 3.4.2.3. 1429
3.4.2.3 Property Definitions 1430
The Item class inherits property definitions from super classes. 1431
The Item class MUST have the property definition: 1432
1433
icom_core:parent 1434
Description: A parent container of an item. 1435
Required: False 1436
Inherited: True 1437
Property Type: icom_core:Container 1438
Cardinality: Single 1439
Updatability: Read Only 1440
1441
The Item class MAY have the optional property definition: 1442
1443
icom_core:container 1444
Description: Zero, one, or more containers of an item, including the parent 1445 container. 1446
Required: False 1447
Inherited: False 1448
Property Type: icom_core:Container 1449
Cardinality: Multi 1450
Updatability: Read Write 1451
1452
The Item class MAY include additional property definitions which are implementation-defined. 1453
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 53 of 244
1454
3.4.3 SpaceItem 1455
3.4.3.1 Description 1456
A space item is an item that can be an element of a space. 1457
3.4.3.2 Class Definition 1458
The SpaceItem class is a mixin class which defines the characteristics of items that can be elements of a 1459 Space. 1460
The SpaceItem class has attribute values: 1461
1462
localNamespace 1463
Value: icom_core 1464
1465
localName 1466
Value: SpaceItem 1467
1468
extendsFrom 1469
Value: icom_core:Item 1470
1471
stereotype 1472
Value: mixin 1473
1474
description 1475
Value: SpaceItem is a mixin class which defines the characteristics of entities that can be 1476 elements of a Space. 1477
1478
propertyDefinitions 1479
The values for this attribute are defined in Section 3.4.3.3. 1480
3.4.3.3 Property Definitions 1481
The SpaceItem class inherits property definitions from super classes. 1482
The SpaceItem class MAY include additional property definitions which are implementation-defined. 1483
1484
3.4.4 Container 1485
3.4.4.1 Description 1486
A container is an extent that contains items. 1487
3.4.4.2 Class Definition 1488
The Container class is a mixin class which defines the characteristics of extents that contain items. 1489
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 54 of 244
The Container class has attribute values: 1490
1491
localNamespace 1492
Value: icom_core 1493
1494
localName 1495
Value: Container 1496
1497
extendsFrom 1498
Value: icom_core:Extent 1499
1500
stereotype 1501
Value: mixin 1502
1503
description 1504
Value: A container is an extent that contains items. 1505
1506
propertyDefinitions 1507
The values for this attribute are defined in Section 3.4.4.3. 1508
3.4.4.3 Property Definitions 1509
The Container class inherits property definitions from super classes. 1510
The Container class MUST have the property definition: 1511
1512
icom_core:element 1513
Description: Elements of a container, i.e. items whose parent container is 1514 the container or whose containers include the container. 1515
Required: False 1516
Inherited: False 1517
Property Type: icom_core:Item 1518
Cardinality: Multi 1519
Updatability: Read Only 1520
1521
The Container class MAY include additional property definitions which are implementation-defined. 1522
1523
3.4.5 FolderContainer 1524
3.4.5.1 Description 1525
A folder container is a container which may contain folders. Space and heterogeneous folder are folder 1526 containers. 1527
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 55 of 244
3.4.5.2 Class Definition 1528
The FolderContainer class is a mixin class that defines the characteristics of containers that may contain 1529 folders. 1530
The FolderContainer class has attribute values: 1531
1532
localNamespace 1533
Value: icom_core 1534
1535
localName 1536
Value: FolderContainer 1537
1538
extendsFrom 1539
Value: icom_core:Container 1540
1541
stereotype 1542
Value: mixin 1543
1544
description 1545
Value: A folder container is a container which may contain folders. 1546
1547
propertyDefinitions 1548
The values for this attribute are defined in Section 3.4.5.3. 1549
3.4.5.3 Property Definitions 1550
The FolderContainer class inherits property definitions from super classes. 1551
The FolderContainer class MAY include additional property definitions which are implementation-defined. 1552
1553
3.4.6 Artifact 1554
3.4.6.1 Description 1555
An artifact is a result of a communication, cooperation, content creation, or collaboration activity. 1556
Note: Document versioning is an example of content creation activity resulting in an artifact (a version of a 1557 document). 1558
3.4.6.2 Class Definition 1559
The Artifact class has attribute values: 1560
1561
localNamespace 1562
Value: icom_core 1563
1564
localName 1565
Value: Artifact 1566
1567
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 56 of 244
extendsFrom 1568
Value: icom_core:Entity, icom_core:Item, icom_meta:RelationshipBondable 1569
Optional Value: icom_core:SpaceItem 1570
1571
stereotype 1572
Value: primary 1573
1574
isAbstract 1575
Value: TRUE 1576
1577
description 1578
Value: An artifact is a result of a communication, cooperation, content creation, or collaboration 1579 activity. 1580
1581
propertyDefinitions 1582
The values for this attribute are defined in Section 3.4.6.3. 1583
3.4.6.3 Property Definitions 1584
The Artifact class inherits property definitions from super classes. 1585
The Artifact class MUST have the property definitions: 1586
1587
icom_core:description 1588
Description: A description of an artifact. 1589
Required: False 1590
Inherited: False 1591
Property Type: String 1592
Cardinality: Single 1593
Updatability: Read Write 1594
1595
icom_core:userCreationDate 1596
Description: Date and time when an artifact was created. 1597
Required: False 1598
Inherited: False 1599
Property Type: DateTime 1600
Cardinality: Single 1601
Updatability: Read Write 1602
1603
icom_core:userLastModificationDate 1604
Description: Date and time when an artifact was last modified. 1605
Required: False 1606
Inherited: False 1607
Property Type: DateTime 1608
Cardinality: Single 1609
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 57 of 244
Updatability: Read Write 1610
1611
icom_meta:property 1612
Description: Zero or more extended properties of an artifact. 1613
Required: False 1614
Inherited: False 1615
Property Type: icom_meta:Property 1616
Cardinality: Multi 1617
Updatability: Read Write 1618
1619
icom_meta:viewerProperty 1620
Description: Zero or more extended properties of an artifact visible to a 1621 viewer. 1622
Required: False 1623
Inherited: False 1624
Property Type: icom_meta:Property 1625
Cardinality: Multi 1626
Updatability: Read Write 1627
1628
icom_meta:relationship 1629
Description: Zero or more relationships associated with an artifact. 1630
Required: False 1631
Inherited: False 1632
Property Type: icom_meta:Relationship 1633
Cardinality: Multi 1634
Updatability: Read Only 1635
1636
The Artifact class MAY include additional property definitions which are implementation-defined. 1637
1638
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 58 of 244
1639
Figure 14: Artifact Class Diagram. 1640
1641
3.4.7 Folder 1642
3.4.7.1 Description 1643
A folder is an artifact that may contain other artifacts. 1644
Note: Every folder except root folders has at least one parent folder. The parent of a root folder is a 1645 space. Subclasses of Folder class should enforce their own semantics on elements. 1646
3.4.7.2 Class Definition 1647
The Folder class has attribute values: 1648
1649
localNamespace 1650
Value: icom_core 1651
1652
localName 1653
Value: Folder 1654
1655
extendsFrom 1656
Value: icom_core:Artifact, icom_core:Container, icom_core:SpaceItem 1657
1658
stereotype 1659
Value: primary 1660
1661
isAbstract 1662
Value: TRUE 1663
1664
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 59 of 244
description 1665
Value: A folder is an artifact that may contain other artifacts. 1666
1667
propertyDefinitions 1668
The values for this attribute are defined in Section 3.4.7.3. 1669
3.4.7.3 Property Definitions 1670
The Folder class inherits property definitions from super classes. 1671
The Folder class MUST have the property definition: 1672
1673
icom_core:parent 1674
Description: A parent container of a folder. 1675
Required: False 1676
Inherited: True 1677
Property Type: icom_core:FolderContainer 1678
Cardinality: Single 1679
Updatability: Read Only 1680
1681
The Folder class MAY include additional property definitions which are implementation-defined. 1682
1683
3.4.8 HeterogeneousFolder 1684
3.4.8.1 Description 1685
A heterogeneous folder is an unconstrained folder to contain any type of artifacts. 1686
Note: It is typically used for document folders, inbox, outbox, and trash folder of a space. 1687
3.4.8.2 Class Definition 1688
The HeterogeneousFolder class has attribute values: 1689
1690
localNamespace 1691
Value: icom_core 1692
1693
localName 1694
Value: HeterogeneousFolder 1695
1696
extendsFrom 1697
Value: icom_core:Folder, icom_core:FolderContainer 1698
1699
stereotype 1700
Value: primary 1701
1702
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 60 of 244
description 1703
Value: A heterogeneous folder is an unconstrained folder to contain any type of artifacts. 1704
1705
propertyDefinitions 1706
The values for this attribute are defined in Section 3.4.8.3. 1707
3.4.8.3 Property Definitions 1708
The HeterogeneousFolder class inherits property definitions from super classes. 1709
The HeterogeneousFolder class MUST have the property definition: 1710
1711
icom_core:element 1712
Description: Elements of a heterogeneous folder. 1713
Required: False 1714
Inherited: True 1715
Property Type: icom_core:Artifact 1716
Cardinality: Multi 1717
Updatability: Read Only 1718
1719
The HeterogeneousFolder class MAY include additional property definitions which are implementation-1720 defined. 1721
1722
1723
Figure 15: Heterogeneous Folder Class Diagram. 1724
1725
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 61 of 244
3.5 Access Control Model 1726
3.5.1 Accessor 1727
3.5.1.1 Description 1728
An accessor can be granted or denied access rights to objects. 1729
3.5.1.2 Class Definition 1730
The Accessor class is a mixin class which defines the characteristics of subjects such as groups and 1731 actors that can be granted or denied access types in access control lists and privileges in role 1732 assignments. 1733
The Accessor class has attribute values: 1734
1735
localNamespace 1736
Value: icom_ac 1737
1738
localName 1739
Value: Accessor 1740
1741
extendsFrom 1742
Value: icom_core:Identifiable 1743
1744
stereotype 1745
Value: mixin 1746
1747
description 1748
Value: Accessor is a mixin class which defines the characteristics of subjects such as groups 1749 and actors that can be granted or denied access types in access control lists and granted 1750 privileges in role assignments. 1751
1752
propertyDefinitions 1753
The values for this attribute are defined in Section 3.5.1.3. 1754
3.5.1.3 Property Definitions 1755
The Accessor class inherits property definitions from super classes. 1756
The Accessor class MAY include additional property definitions which are implementation-defined. 1757
1758
3.5.2 Owner 1759
3.5.2.1 Description 1760
An owner is a subject that can be the owner of entities. 1761
An owner of an entity MAY always have rights to update the access control list for the entity. 1762
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 62 of 244
3.5.2.2 Class Definition 1763
The Owner class is a mixin class which defines the characteristics of subjects such as groups and actors 1764 that can own entities. 1765
The Owner class has attribute values: 1766
1767
localNamespace 1768
Value: icom_ac 1769
1770
localName 1771
Value: Owner 1772
1773
extendsFrom 1774
Value: icom_ac:Accessor 1775
1776
stereotype 1777
Value: mixin 1778
1779
description 1780
Value: Owner is a mixin class which defines the characteristics of subjects such as groups and 1781 actors that can own entities. 1782
1783
propertyDefinitions 1784
The values for this attribute are defined in Section 3.5.2.3. 1785
3.5.2.3 Property Definitions 1786
The Owner class inherits property definitions from super classes. 1787
The Owner class MAY include additional property definitions which are implementation-defined. 1788
1789
3.5.3 RoleDefinition 1790
3.5.3.1 Description 1791
A role definition is a named set of privileges. 1792
3.5.3.2 Class Definition 1793
The RoleDefinition class has attribute values: 1794
1795
localNamespace 1796
Value: icom_ac 1797
1798
localName 1799
Value: RoleDefinition 1800
1801
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 63 of 244
extendsFrom 1802
Value: icom_core:Entity, icom_meta:RelationshipBondable 1803
1804
stereotype 1805
Value: primary 1806
1807
description 1808
Value: A role definition is a named set of privileges. 1809
1810
propertyDefinitions 1811
The values for this attribute are defined in Section 3.5.3.3. 1812
3.5.3.3 Property Definitions 1813
The RoleDefinition class inherits property definitions from super classes. 1814
The RoleDefinition class MUST have the property definition: 1815
1816
icom_core:description 1817
Description: A description of a role definition. 1818
Required: False 1819
Inherited: False 1820
Property Type: String 1821
Cardinality: Single 1822
Updatability: Read Write 1823
1824
icom_ac:privilege 1825
Description: A set of privileges. 1826
Required: True 1827
Inherited: False 1828
Property Type: icom_ac:Privilege 1829
Cardinality: Multi 1830
Updatability: Read Write 1831
1832
The RoleDefinition class MAY include additional property definitions which are implementation-defined. 1833
1834
3.5.4 Role 1835
3.5.4.1 Description 1836
A role assigns a named set of privileges to a set of accessors for operations within an assigned scope. 1837
3.5.4.2 Class Definition 1838
The Role class has attribute values: 1839
1840
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 64 of 244
localNamespace 1841
Value: icom_ac 1842
1843
localName 1844
Value: Role 1845
1846
extendsFrom 1847
Value: icom_core:Subject 1848
1849
stereotype 1850
Value: primary 1851
1852
description 1853
Value: A role assigns a named set of rights to a set of accessors for operations within an 1854 assigned scope. 1855
1856
propertyDefinitions 1857
The values for this attribute are defined in Section 3.5.4.3. 1858
3.5.4.3 Property Definitions 1859
The Role class inherits property definitions from super classes. 1860
The Role class MUST have the property definitions: 1861
1862
icom_ac:roleDefinition 1863
Description: A role definition containing a set of privileges. 1864
Required: True 1865
Inherited: False 1866
Property Type: icom_ac:RoleDefinition 1867
Cardinality: Single 1868
Updatability: On Create 1869
1870
icom_ac:assignedScope 1871
Description: A scope in which a role is assigned. 1872
Required: True 1873
Inherited: False 1874
Property Type: icom_core:Scope 1875
Cardinality: Single 1876
Updatability: Read Write 1877
1878
icom_ac:memberAccessor 1879
Description: Accessors (actors and groups) assigned to a role. 1880
Required: False 1881
Inherited: False 1882
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 65 of 244
Property Type: icom_ac:Accessor 1883
Cardinality: Multi 1884
Updatability: Read Write 1885
1886
The Role class MAY include additional property definitions which are implementation-defined. 1887
1888
1889
Figure 16: Role Definition and Role Class Diagram. 1890
1891
3.5.5 Privilege 1892
3.5.5.1 Description 1893
A privilege is an access right granted through roles. 1894
3.5.5.2 Class Definition 1895
The Privilege class is a mixin class which defines access rights that can be included in role definitions. 1896
The Privilege class has attribute values: 1897
1898
localNamespace 1899
Value: icom_ac 1900
1901
localName 1902
Value: Privilege 1903
1904
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 66 of 244
extendsFrom 1905
Value: 1906
1907
stereotype 1908
Value: mixin 1909
1910
description 1911
Value: Privilege is a mixin class which defines access rights that can be included in role 1912 definitions. 1913
1914
propertyDefinitions 1915
The values for this attribute are defined in Section 3.5.5.3. 1916
3.5.5.3 Property Definitions 1917
The Privilege class MAY include additional property definitions which are implementation-defined. 1918
1919
3.5.6 PrivilegeEnum 1920
The PrivilegeEnum class is an enum class that enumerates the instances each of which expresses a 1921 privilege that can be assigned to a role. 1922
The PrivilegeEnum class has attribute values: 1923
1924
localNamespace 1925
Value: icom_ac 1926
1927
localName 1928
Value: PrivilegeEnum 1929
1930
extendsFrom 1931
Value: icom_ac:Privilege 1932
1933
stereotype 1934
Value: primary 1935
1936
isEnumeration 1937
Value: TRUE 1938
1939
description 1940
Value: Privilege that can be assigned to a role. 1941
1942
instances 1943
Value: <icom_ac:Archive, icom_ac:Audit> 1944
1945
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 67 of 244
ICOM defines two privileges: 1946
icom_ac:Archive a right to archive contents in a scope. 1947
icom_ac:Audit a right to audit activities in a scope. 1948
1949
3.5.7 AccessControlList 1950
3.5.7.1 Description 1951
An access control list (ACL) is an object attached to an entity to specify a list of permissions to access the 1952 entity. 1953
3.5.7.2 Class Definition 1954
The AccessControlList class has attribute values: 1955
1956
localNamespace 1957
Value: icom_ac 1958
1959
localName 1960
Value: AccessControlList 1961
1962
extendsFrom 1963
Value: 1964
1965
stereotype 1966
Value: primary 1967
1968
description 1969
Value: An access control list (ACL) is an object attached to an entity to specify a list of 1970 permissions to access the entity. 1971
1972
propertyDefinitions 1973
The values for this attribute are defined in Section 3.5.7.3. 1974
3.5.7.3 Property Definitions 1975
The AccessControlList class MUST have the property definitions: 1976
1977
icom_ac:object 1978
Description: Associated object. 1979
Required: True 1980
Inherited: False 1981
Property Type: icom_core:Entity 1982
Cardinality: Single 1983
Updatability: On Create 1984
1985
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 68 of 244
icom_ac:accessControlEntry 1986
Description: One or more access control entries. 1987
Required: True 1988
Inherited: False 1989
Property Type: icom_ac:AccessControlEntry 1990
Cardinality: Multi 1991
Updatability: Read Write 1992
1993
AccessControlList class MAY include additional property definitions which are implementation-defined. 1994
1995
3.5.8 AccessControlEntry 1996
3.5.8.1 Description 1997
An access control entry specifies access types granted to or denied for an accessor. 1998
3.5.8.2 Class Definition 1999
The AccessControlEntry class has attribute values: 2000
2001
localNamespace 2002
Value: icom_ac 2003
2004
localName 2005
Value: AccessControlEntry 2006
2007
extendsFrom 2008
Value: 2009
2010
stereotype 2011
Value: primary 2012
2013
description 2014
Value: An access control entry is associated with an accessor and contains a list of access 2015 types (permissions) granted to or denied from the accessor. 2016
2017
propertyDefinitions 2018
The values for this attribute are defined in Section 3.5.8.3. 2019
3.5.8.3 Property Definitions 2020
The AccessControlEntry class MUST have the property definitions: 2021
2022
icom_ac:subject 2023
Description: Associated subject. 2024
Required: True 2025
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 69 of 244
Inherited: False 2026
Property Type: icom_ac:Accessor 2027
Cardinality: Single 2028
Updatability: On Create 2029
2030
icom_ac:grant 2031
Description: One or more access types granted to a subject. 2032
Required: False 2033
Inherited: False 2034
Property Type: icom_ac:AccessType 2035
Cardinality: Multi 2036
Updatability: Read Write 2037
2038
icom_ac:deny 2039
Description: One or more access type denied for a subject. 2040
Required: False 2041
Inherited: False 2042
Property Type: icom_ac:AccessType 2043
Cardinality: Multi 2044
Updatability: Read Write 2045
2046
The AccessControlEntry class MAY include additional property definitions which are implementation-2047 defined. 2048
2049
3.5.9 AccessType 2050
An AccessType is an access right granted through an access control entry. 2051
3.5.9.1 Class Definition 2052
The AccessType class is a mixin class which defines access rights that can be granted or denied in an 2053 access control entry. 2054
The AccessType class has attribute values: 2055
2056
localNamespace 2057
Value: icom_ac 2058
2059
localName 2060
Value: AccessType 2061
2062
extendsFrom 2063
Value: 2064
2065
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 70 of 244
stereotype 2066
Value: mixin 2067
2068
description 2069
Value: AccessType is a mixin class which defines access rights that can be granted or denied in 2070 an access control entry. 2071
2072
propertyDefinitions 2073
The values for this attribute are defined in Section 3.5.9.2. 2074
3.5.9.2 Property Definitions 2075
The AccessType class inherits property definitions from super classes. 2076
The AccessType class MAY include additional property definitions which are implementation-defined. 2077
2078
3.5.10 AccessTypeEnum 2079
The AccessTypeEnum class is an enum class that enumerates the instances each of which expresses an 2080 access type that can be granted or denied in an access control entry. 2081
The AccessTypeEnum class has attribute values: 2082
2083
localNamespace 2084
Value: icom_ac 2085
2086
localName 2087
Value: AccessTypeEnum 2088
2089
extendsFrom 2090
Value: icom_ac:AccessType 2091
2092
stereotype 2093
Value: primary 2094
2095
isEnumeration 2096
Value: TRUE 2097
2098
description 2099
Value: Access type that can be granted or denied in an access control entry. 2100
2101
instances 2102
Value: <icom_ac:Read, icom_ac:Write, icom_ac:Delete> 2103
2104
ICOM defines three access types: 2105
icom_ac:Read a right to retrieve an entity. 2106
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 71 of 244
icom_ac:Write a right to update an entity. 2107
icom_ac:Delete a right to delete an entity. 2108
2109
2110
Figure 17: Access Control List Class Diagram. 2111
2112
3.6 Metadata Model 2113
3.6.1 ClassDefinition 2114
3.6.1.1 Description 2115
A class definition is an entity that defines a type of entities. 2116
3.6.1.2 Class Definition 2117
The ClassDefinition class has attribute values: 2118
2119
localNamespace 2120
Value: icom_meta 2121
2122
localName 2123
Value: ClassDefinition 2124
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 72 of 244
2125
extendsFrom 2126
Value: icom_core:Entity, icom_meta:RelationshipBondable 2127
2128
stereotype 2129
Value: primary 2130
2131
isAbstract 2132
Value: FALSE 2133
2134
description 2135
Value: A class definition defines a type of entities. 2136
2137
propertyDefinitions 2138
The values for this attribute are defined in Section 3.6.1.3. 2139
3.6.1.3 Property Definitions 2140
The ClassDefinition class inherits property definitions from super classes. 2141
The ClassDefinition class MUST have the property definition: 2142
2143
icom_core:namespace 2144
Description: Namespace for a class name. 2145
Required: False 2146
Inherited: False 2147
Property Type: String 2148
Cardinality: Single 2149
Updatability: Read Write 2150
2151
icom_core:description 2152
Description: A description of a class. 2153
Required: False 2154
Inherited: False 2155
Property Type: String 2156
Cardinality: Single 2157
Updatability: Read Write 2158
2159
icom_meta:extendsFrom 2160
Description: One or more generalizations of a class. 2161
Required: True 2162
Inherited: False 2163
Property Type: icom_meta:ClassDefinition 2164
Cardinality: Multi 2165
Updatability: Read Write 2166
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 73 of 244
2167
icom_meta:stereoType 2168
Description: Stereo type of a class. 2169
Required: True 2170
Inherited: False 2171
Property Type: icom_meta:StereoType 2172
Cardinality: Single 2173
Updatability: Read Write 2174
2175
icom_meta:abstract 2176
Description: Indicates whether a class is abstract or concrete. 2177
Required: False 2178
Inherited: False 2179
Property Type: Boolean 2180
Cardinality: Single 2181
Updatability: Read Write 2182
2183
icom_meta:enumeration 2184
Description: Indicates whether instances of a class are enumerated. This 2185 property is applicable only if the stereo type property is 2186 primary. 2187
Required: False 2188
Inherited: False 2189
Property Type: Boolean 2190
Cardinality: Single 2191
Updatability: Read Write 2192
2193
icom_meta:instances 2194
Description: Instances of an enumeration class. This property is applicable 2195 only if the enumeration property is true. 2196
Required: False 2197
Inherited: False 2198
Property Type: IRI 2199
Cardinality: Multi 2200
Updatability: Read Write 2201
2202
icom_meta:propertyDefinition 2203
Description: One or more property definitions of a class definition. 2204
Required: False 2205
Inherited: False 2206
Property Type: icom_meta:PropertyDefinition 2207
Cardinality: Multi 2208
Updatability: Read Write 2209
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 74 of 244
2210
The ClassDefinition class MAY include additional property definitions which are implementation-defined. 2211
2212
2213
Figure 18: Class Definition and Property Definition Class Diagram. 2214
2215
3.6.2 StereoType 2216
3.6.2.1 Description 2217
A stereo type of a class definition. 2218
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 75 of 244
3.6.2.2 Class Definition 2219
The StereoType class is a mixin class which defines a stereo type of a class definition. 2220
The StereoType class has attribute values: 2221
2222
localNamespace 2223
Value: icom_meta 2224
2225
localName 2226
Value: StereoType 2227
2228
extendsFrom 2229
Value: 2230
2231
stereotype 2232
Value: mixin 2233
2234
description 2235
Value: StereoType is a mixin class which defines a stereo type of a class definition. 2236
2237
propertyDefinitions 2238
The values for this attribute are defined in Section 3.6.2.3. 2239
3.6.2.3 Property Definitions 2240
The StereoType class MAY include additional property definitions which are implementation-defined. 2241
2242
3.6.3 StereoTypeEnum 2243
The StereoTypeEnum class is an enum class that enumerates the instances each of which defines a 2244 stereo type of a class definition. 2245
The StereoTypeEnum has attribute values: 2246
2247
localNamespace 2248
Value: icom_meta 2249
2250
localName 2251
Value: StereoTypeEnum 2252
2253
extendsFrom 2254
Value: icom_meta:StereoType 2255
2256
stereotype 2257
Value: primary 2258
2259
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 76 of 244
isEnumeration 2260
Value: TRUE 2261
2262
description 2263
Value: Stereo type of a class definition. 2264
2265
instances 2266
Value: <icom_meta:Primary, icom_meta:Mixin> 2267
2268
ICOM defines two stereo types: 2269
icom_meta:Primary a primary class. 2270
icom_meta:Mixin a mixin class. 2271
2272
3.6.4 PropertyDefinition 2273
3.6.4.1 Description 2274
A property definition specifies the name, type, choice, and cardinality of values for properties. 2275
3.6.4.2 Class Definition 2276
The PropertyDefinition class has attribute values: 2277
2278
localNamespace 2279
Value: icom_meta 2280
2281
localName 2282
Value: PropertyDefinition 2283
2284
extendsFrom 2285
Value: icom_core:Identifiable 2286
2287
stereotype 2288
Value: primary 2289
2290
description 2291
Value: A property definition specifies the name, type, choice, and cardinality of values for 2292 properties. 2293
2294
propertyDefinitions 2295
The values for this attribute are defined in Section 3.6.4.3. 2296
3.6.4.3 Property Definitions 2297
The PropertyDefinition class inherits property definitions from super classes. 2298
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 77 of 244
The PropertyDefinition class MUST have the property definitions: 2299
2300
icom_core:namespace 2301
Description: Namespace for a property name. 2302
Required: False 2303
Inherited: False 2304
Property Type: String 2305
Cardinality: Single 2306
Updatability: Read Write 2307
2308
icom_core:name 2309
Description: Name for a property. 2310
Required: True 2311
Inherited: False 2312
Property Type: String 2313
Cardinality: Single 2314
Updatability: Read Write 2315
2316
icom_core:description 2317
Description: A description of a property definition. 2318
Required: False 2319
Inherited: False 2320
Property Type: String 2321
Cardinality: Single 2322
Updatability: Read Write 2323
2324
icom_meta:propertyType 2325
Description: Type of a property. 2326
Required: False 2327
Inherited: False 2328
Property Type: icom_meta:PropertyType 2329
Cardinality: Single 2330
Updatability: On Create 2331
Choices: {PropertyChoiceType} 2332
Open Choice: False 2333
2334
Note: The notation {PropertyChoiceType} represents a set of PropertyChoiceType. 2335
2336
icom_meta:defaultValue 2337
Description: A default value for a property. 2338
Required: False 2339
Inherited: False 2340
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 78 of 244
Property Type: property-type 2341
Cardinality: Single 2342
Updatability: Read Write 2343
2344
icom_meta:choice 2345
Description: An allowed value for a property. 2346
Required: False 2347
Inherited: False 2348
Property Type: icom_meta:PropertyChoiceType 2349
Cardinality: Multi 2350
Updatability: Read Write 2351
2352
icom_meta:openChoice 2353
Description: Indicates whether value of the property must be listed among 2354 the choices. 2355
Required: False 2356
Inherited: False 2357
Property Type: Boolean 2358
Cardinality: Single 2359
Updatability: Read Write 2360
2361
icom_meta:inherited 2362
Description: Indicates whether a property definition is inherited from a 2363 super class. 2364
Required: False 2365
Inherited: False 2366
Property Type: Boolean 2367
Cardinality: Single 2368
Updatability: Read Write 2369
2370
icom_meta:required 2371
Description: Indicates whether a property value must be provided. It is 2372 applicable only when the updatability of the property is read-2373 write or on-create. 2374
Required: True 2375
Inherited: False 2376
Property Type: Boolean 2377
Cardinality: Single 2378
Updatability: Read Write 2379
2380
icom_meta:updatability 2381
Description: Updatability of a property specifying under what 2382 circumstances the property value can be updated. 2383
Required: True 2384
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 79 of 244
Inherited: False 2385
Property Type: icom_meta:Updatability 2386
Cardinality: Single 2387
Updatability: On Create 2388
2389
icom_meta:cardinality 2390
Description: Cardinality of a property specifying whether the property can 2391 have “zero or one” or “zero or more” values. 2392
Required: True 2393
Inherited: False 2394
Property Type: icom_meta:Cardinality 2395
Cardinality: Single 2396
Updatability: On Create 2397
2398
icom_meta:minValue 2399
Description: Minimum value for an integer or decimal property. 2400
Required: False 2401
Inherited: False 2402
Property Type: Integer | Decimal 2403
Cardinality: Single 2404
Updatability: Read Write 2405
2406
icom_meta:maxValue 2407
Description: Maximum value for an integer or decimal property. 2408
Required: False 2409
Inherited: False 2410
Property Type: Integer | Decimal 2411
Cardinality: Single 2412
Updatability: Read Write 2413
2414
The PropertyDefinition class MAY include additional property definitions which are implementation-2415 defined. 2416
2417
3.6.5 Property 2418
3.6.5.1 Description 2419
The property holds a property value. 2420
3.6.5.2 Class Definition 2421
The Property class has attribute values: 2422
2423
localNamespace 2424
Value: icom_meta 2425
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 80 of 244
2426
localName 2427
Value: Property 2428
2429
extendsFrom 2430
Value: 2431
2432
stereotype 2433
Value: primary 2434
2435
description 2436
Value: A property value. 2437
2438
propertyDefinitions 2439
The values for this attribute are defined in Section 3.6.5.3. 2440
3.6.5.3 Property Definitions 2441
The Property class MUST have the property definitions: 2442
2443
icom_meta:propertyDefinition 2444
Description: A property definition that specifies the name, type, and 2445 cardinality of a property. 2446
Required: True 2447
Inherited: False 2448
Property Type: icom_meta:PropertyDefinition 2449
Cardinality: Single 2450
Updatability: On Create 2451
2452
icom_meta:value 2453
Description: A value of a property. 2454
Required: True 2455
Inherited: False 2456
Property Type: property-type 2457
Cardinality: Single 2458
Updatability: Read Write 2459
2460
The Property class MAY include additional property definitions which are implementation-defined. 2461
2462
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 81 of 244
2463
Figure 19: Property Definition and Property Class Diagram. 2464
2465
3.6.6 PropertyChoiceType 2466
3.6.6.1 Description 2467
The property choice type represents a value choice for a property. Each choice includes a display name 2468 to be used for presentation purpose and a value to be stored in a property when a choice is selected. 2469
3.6.6.2 Class Definition 2470
The PropertyChoiceType class has attribute values: 2471 2472
localNamespace 2473
Value: icom_meta 2474
2475
localName 2476
Value: PropertyChoiceType 2477
2478
extendsFrom 2479
Value: 2480
2481
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 82 of 244
stereotype 2482
Value: primary 2483
2484
description 2485
Value: A choice for a property value. 2486
2487
propertyDefinitions 2488
The values for this attribute are defined Section 3.6.6.3. 2489
3.6.6.3 Property Definitions 2490
The PropertyChoiceType class MUST have the property definitions: 2491
2492
icom_core:description 2493
Description: A description of a property choice. 2494
Required: False 2495
Inherited: False 2496
Property Type: String 2497
Cardinality: Single 2498
Updatability: Read Write 2499
2500
icom_meta:displayName 2501
Description: Display name of a property choice. 2502
Required: True 2503
Inherited: False 2504
Property Type: String 2505
Cardinality: Single 2506
Updatability: Read Write 2507
2508
icom_meta:value 2509
Description: A value of a property choice. 2510
Required: True 2511
Inherited: False 2512
Property Type: property-type 2513
Cardinality: Single 2514
Updatability: Read Write 2515
2516
The PropertyChoiceType class MAY include additional property definitions which are implementation-2517 defined. 2518
2519
3.6.7 PropertyType 2520
A PropertyType expresses a name of a property-type. 2521
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 83 of 244
3.6.7.1 Class Definition 2522
The PropertyType class is a mixin class which expresses a name of a property-type. 2523
The PropertyType class has attribute values: 2524
2525
localNamespace 2526
Value: icom_meta 2527
2528
localName 2529
Value: PropertyType 2530
2531
extendsFrom 2532
Value: 2533
2534
stereotype 2535
Value: mixin 2536
2537
description 2538
Value: PropertyType is a mixin class which expresses a name of a property-type. 2539
2540
propertyDefinitions 2541
The values for this attribute are defined in Section 3.6.7.2. 2542
3.6.7.2 Property Definitions 2543
The PropertyType class MAY include additional property definitions which are implementation-defined. 2544
2545
3.6.8 PropertyTypeEnum 2546
The PropertyTypeEnum class is an enum class that enumerates the instances each of which expresses 2547 the name of a property-type. 2548
The PropertyTypeEnum class has attribute values: 2549
2550
localNamespace 2551
Value: icom_meta 2552
2553
localName 2554
Value: PropertyTypeEnum 2555
2556
extendsFrom 2557
Value: icom_meta:PropertyType 2558
2559
stereotype 2560
Value: primary 2561
2562
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 84 of 244
isEnumeration 2563
Value: TRUE 2564
2565
description 2566
Value: Name of a basic data type. 2567
2568
instances 2569
Value: <icom_meta:String, icom_meta:Boolean, icom_meta:Decimal, icom_meta:Integer, 2570 icom_meta:Datetime, icom_meta:Duration, icom_meta:IRI, icom_meta:ID, icom_meta:HTML> 2571
2572
ICOM defines nine data types: 2573
icom_meta:String is equivalent to XML schema type xsd:string. 2574
icom_meta:Boolean is equivalent to XML schema type xsd:boolean. 2575
icom_meta:Decimal is equivalent to XML schema type xsd:decimal. 2576
icom_meta:Integer is equivalent to XML schema type xsd:integer. 2577
icom_meta:Datetime is equivalent to XML schema type xsd:dateTime. 2578
icom_meta:Duration is equivalent to XML schema type xsd:duration. 2579
icom_meta:IRI is equivalent to XML schema type xsd:anyURI. 2580
icom_meta:ID opaque object identifiers. 2581
icom_meta:HTML documents or fragments of Hypertext Markup Language (HTML) content 2582
2583
Note: ICOM uses basic data types defined by “XML Schema Part 2: Datatypes Second Edition” (W3C 2584 Recommendation, 28 October 2004, http://www.w3.org/TR/xmlschema-2/). 2585
2586
3.6.9 Updatability 2587
3.6.9.1 Description 2588
Updatability specifies under what circumstances a property value can be updated. 2589
3.6.9.2 Class Definition 2590
The Updatability class is a mixin class which specifies under what circumstances a property value can be 2591 updated. 2592
The Updatability class has attribute values: 2593
2594
localNamespace 2595
Value: icom_meta 2596
2597
localName 2598
Value: Updatability 2599
2600
extendsFrom 2601
Value: 2602
2603
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 85 of 244
stereotype 2604
Value: mixin 2605
2606
description 2607
Value: Updatability is a mixin class which specifies under what circumstances a property value 2608 can be updated. 2609
2610
propertyDefinitions 2611
The values for this attribute are defined in Section 3.6.9.3. 2612
3.6.9.3 Property Definitions 2613
The Updatability class MAY include additional property definitions which are implementation-defined. 2614
2615
3.6.10 UpdatabilityEnum 2616
The UpdatabilityEnum class is an enum class that enumerates instances each of which expresses the 2617 updatability of a property. 2618
The UpdatabilityEnum has attribute values: 2619
2620
localNamespace 2621
Value: icom_meta 2622
2623
localName 2624
Value: UpdatabilityEnum 2625
2626
extendsFrom 2627
Value: icom_meta:Updatability 2628
2629
stereotype 2630
Value: primary 2631
2632
isEnumeration 2633
Value: TRUE 2634
2635
description 2636
Value: Updatability of a property. 2637
2638
instances 2639
Value: <icom_meta:ReadOnly, icom_meta:WriteOnly, icom_meta:ReadWrite, 2640 icom_meta:OnCreate> 2641
2642
ICOM defines four updatability types: 2643
icom_meta:ReadOnly a property must not be updated directly by application. 2644
icom_meta:WriteOnly a property can be updated but cannot be read by application. 2645
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 86 of 244
icom_meta:ReadWrite a property can be updated by application. 2646
icom_meta:WriteOnly a property can be updated during the creation by application. 2647
2648
3.6.11 Cardinality 2649
3.6.11.1 Description 2650
Cardinality specifies whether a property is single or multi valued. 2651
3.6.11.2 Class Definition 2652
The Cardinality class is a mixin class which defines whether a property is single or multi valued. 2653
The Cardinality class has attribute values: 2654
2655
localNamespace 2656
Value: icom_meta 2657
2658
localName 2659
Value: Cardinality 2660
2661
extendsFrom 2662
Value: 2663
2664
stereotype 2665
Value: mixin 2666
2667
description 2668
Value: Cardinality is a mixin class which defines whether a property is single or multi valued. 2669
2670
propertyDefinitions 2671
The values for this attribute are defined in Section 3.6.11.3. 2672
3.6.11.3 Property Definitions 2673
The Cardinality class MAY include additional property definitions which are implementation-defined. 2674
2675
3.6.12 CardinalityEnum 2676
The CardinalityEnum class is an enum class that enumerates instances each of which expresses the 2677 cardinality of a property. 2678
The CardinalityEnum has attribute values: 2679
2680
localNamespace 2681
Value: icom_meta 2682
2683
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 87 of 244
localName 2684
Value: CardinalityEnum 2685
2686
extendsFrom 2687
Value: icom_meta:Cardinality 2688
2689
stereotype 2690
Value: primary 2691
2692
isEnumeration 2693
Value: TRUE 2694
2695
description 2696
Value: Cardinality of a property. 2697
2698
instances 2699
Value: <icom_meta:Single, icom_meta:Multi> 2700
2701
ICOM defines two cardinality types: 2702
icom_meta:Single a property can have zero or one value (if property is not required), or exactly 2703
one value (if property is required). 2704
icom_meta:Multi a property can have zero or more values (if property is not required), or one or 2705
more values (if property is required). 2706
2707
3.6.13 Marker and Subclasses 2708
2709
Figure 20: Marker Branch. 2710
Figure 20 depicts the main classes of Marker Branch, which includes Marker, Category, and Tag. 2711
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 88 of 244
3.6.14 Marker 2712
3.6.14.1 Description 2713
A marker is an artifact that groups together entities by a criterion. Markers can be flat or hierarchical. Flat 2714 markers are modeled by tag and hierarchical markers are modeled by category. 2715
Note: In some cases when a user applies a marker to an entity, the marker application should be private 2716 such that only the user who applies the marker can browse or locate the entity through the marker. This is 2717 especially the case when markers are created by a user and visible only to the user who created them. 2718
3.6.14.2 Class Definition 2719
The Marker class has attribute values: 2720
2721
localNamespace 2722
Value: icom_meta 2723
2724
localName 2725
Value: Marker 2726
2727
extendsFrom 2728
Value: icom_core:Artifact 2729
2730
stereotype 2731
Value: primary 2732
2733
isAbstract 2734
Value: TRUE 2735
2736
description 2737
Value: A marker is an artifact that groups together entities by a criterion. 2738
2739
propertyDefinitions 2740
The values for this attribute are defined in Section 3.6.14.3. 2741
3.6.14.3 Property Definitions 2742
The Marker class inherits property definitions from super classes. 2743
The Marker class MUST have the property definition: 2744
2745
icom_meta:markedEntity 2746
Description: A marked entity. 2747
Required: False 2748
Inherited: False 2749
Property Type: icom_core:Entity 2750
Cardinality: Multi 2751
Updatability: Read Only 2752
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 89 of 244
2753
The Marker class MAY include additional property definitions which are implementation-defined. 2754
2755
2756
Figure 21: Marker Class Diagram. 2757
2758
3.6.15 Category 2759
3.6.15.1 Description 2760
A category is a marker that classifies entities. 2761
3.6.15.2 Class Definition 2762
The Category class has attribute values: 2763
2764
localNamespace 2765
Value: icom_meta 2766
2767
localName 2768
Value: Category 2769
2770
extendsFrom 2771
Value: icom_meta:Marker, icom_core:Container 2772
2773
stereotype 2774
Value: primary 2775
2776
description 2777
Value: A category is a marker that classifies entities. 2778
2779
propertyDefinitions 2780
The values for this attribute are defined in Section 3.6.15.3. 2781
3.6.15.3 Property Definitions 2782
The Category class inherits property definitions from super classes. 2783
The Category class MUST have the property definitions: 2784
2785
icom_meta:superCategory 2786
Description: Zero or more super categories. 2787
Required: False 2788
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 90 of 244
Inherited: False 2789
Property Type: icom_meta:Category 2790
Cardinality: Multi 2791
Updatability: Read Only 2792
2793
icom_meta:subCategory 2794
Description: Zero or more sub categories. 2795
Required: False 2796
Inherited: False 2797
Property Type: icom_meta:Category 2798
Cardinality: Multi 2799
Updatability: Read Only 2800
2801
icom_meta:abstract 2802
Description: Indicates whether a category is abstract or concrete. 2803
Required: False 2804
Inherited: False 2805
Property Type: Boolean 2806
Cardinality: Single 2807
Updatability: Read Write 2808
2809
icom_meta:propertyDefinition 2810
Description: Optional or mandatory properties for a category application. 2811
Required: False 2812
Inherited: False 2813
Property Type: icom_meta:PropertyDefinition 2814
Cardinality: Multi 2815
Updatability: Read Write 2816
2817
The Category class MAY include additional property definitions which are implementation-defined. 2818
2819
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 91 of 244
2820
Figure 22: Category and Category Application Class Diagram. 2821
2822
3.6.16 CategoryApplication 2823
3.6.16.1 Description 2824
A category application is an instance of association between a category and a specific entity. 2825
3.6.16.2 Class Definition 2826
The CategoryApplication class has attribute values: 2827
2828
localNamespace 2829
Value: icom_meta 2830
2831
localName 2832
Value: CategoryApplication 2833
2834
extendsFrom 2835
Value: icom_core:Identifiable 2836
2837
stereotype 2838
Value: primary 2839
2840
description 2841
Value: A category application is an instance of association between a category and a specific 2842 entity. 2843
2844
propertyDefinitions 2845
The values for this attribute are defined in Section 3.6.16.3. 2846
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 92 of 244
3.6.16.3 Property Definitions 2847
The CategoryApplication class inherits property definitions from super classes. 2848
The CategoryApplication class MUST have the property definitions: 2849
2850
icom_meta:attachedEntity 2851
Description: An entity to which a category is applied. 2852
Required: True 2853
Inherited: False 2854
Property Type: icom_core:Entity 2855
Cardinality: Single 2856
Updatability: On Create 2857
2858
icom_meta:category 2859
Description: A category which is applied on an entity. 2860
Required: True 2861
Inherited: False 2862
Property Type: icom_meta:Category 2863
Cardinality: Single 2864
Updatability: On Create 2865
2866
icom_meta:property 2867
Description: Zero or more properties. 2868
Required: False 2869
Inherited: False 2870
Property Type: icom_meta:Property 2871
Cardinality: Multi 2872
Updatability: Read Write 2873
2874
The CategoryApplication class MAY include additional property definitions which are implementation-2875 defined. 2876
2877
3.6.17 Tag 2878
3.6.17.1 Description 2879
A tag is a marker that labels entities by a keyword. 2880
3.6.17.2 Class Definition 2881
The Tag class has attribute values: 2882
2883
localNamespace 2884
Value: icom_meta 2885
2886
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 93 of 244
localName 2887
Value: Tag 2888
2889
extendsFrom 2890
Value: icom_meta:Marker 2891
2892
stereotype 2893
Value: primary 2894
2895
description 2896
Value: A tag is a marker that labels entities by a keyword. 2897
2898
propertyDefinitions 2899
The values for this attribute are defined in Section 3.6.17.3. 2900
3.6.17.3 Property Definitions 2901
The Tag class inherits property definitions from super classes. 2902
The Tag class MUST have the property definition: 2903
2904
icom_meta:applicationCount 2905
Description: An estimate of the number of times a tag is applied on 2906 entities. 2907
Required: False 2908
Inherited: False 2909
Property Type: Integer 2910
Cardinality: Single 2911
Updatability: Read Only 2912
2913
The Tag class MAY include additional property definitions which are implementation-defined. 2914
2915
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 94 of 244
2916
Figure 23: Tag and Tag Application Class Diagram. 2917
2918
3.6.18 TagApplication 2919
3.6.18.1 Description 2920
A tag application is an instance of association between a tag and a specific entity. 2921
3.6.18.2 Class Definition 2922
The TagApplication class has attribute values: 2923
2924
localNamespace 2925
Value: icom_meta 2926
2927
localName 2928
Value: TagApplication 2929
2930
extendsFrom 2931
Value: icom_core:Identifiable 2932
2933
stereotype 2934
Value: primary 2935
2936
description 2937
Value: A tag application is an instance of association between a tag and a specific entity. 2938
2939
propertyDefinitions 2940
The values for this attribute are defined in Section 3.6.18.3. 2941
3.6.18.3 Property Definitions 2942
The TagApplication class inherits property definitions from super classes. 2943
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 95 of 244
The TagApplication class MUST have the property definitions: 2944
2945
icom_meta:attachedEntity 2946
Description: An entity on which a tag is applied. 2947
Required: True 2948
Inherited: False 2949
Property Type: icom_core:Entity 2950
Cardinality: Single 2951
Updatability: On Create 2952
2953
icom_meta:tag 2954
Description: A tag which is applied to an entity. 2955
Required: True 2956
Inherited: False 2957
Property Type: icom_meta:Tag 2958
Cardinality: Single 2959
Updatability: On Create 2960
2961
icom_meta:appliedBy 2962
Description: A user who applies a tag to an entity. 2963
Required: False 2964
Inherited: False 2965
Property Type: icom_core:Actor 2966
Cardinality: Single 2967
Updatability: Read Only 2968
2969
icom_meta:applicationDate 2970
Description: A date and time when a tag is applied to an entity. 2971
Required: False 2972
Inherited: False 2973
Property Type: DateTime 2974
Cardinality: Single 2975
Updatability: Read Write 2976
2977
The TagApplication class MAY include additional property definitions which are implementation-defined. 2978
2979
3.6.19 RelationshipBondable 2980
3.6.19.1 Description 2981
A relationship bondable entity is an entity which may be related to other entities by a relationship. 2982
Note: A relationship can exist among entities that are not relationships. 2983
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 96 of 244
3.6.19.2 Class Definition 2984
The RelationshipBondable class is a mixin class which defines the characteristics of entities that may be 2985 relationship bonded. It includes almost every subclass of Entity except Relationship. 2986
The RelationshipBondable class has attribute values: 2987
2988
localNamespace 2989
Value: icom_meta 2990
2991
localName 2992
Value: RelationshipBondable 2993
2994
extendsFrom 2995
Value: icom_core:Identifiable 2996
2997
stereotype 2998
Value: mixin 2999
3000
description 3001
Value: RelationshipBondable is a mixin class which defines the characteristics of entities that 3002 can be relationship bonded. 3003
3004
propertyDefinitions 3005
The values for this attribute are defined in Section 3.6.19.3. 3006
3.6.19.3 Property Definitions 3007
The RelationshipBondable class inherits property definitions from super classes. 3008
The RelationshipBondable class MAY include additional property definitions which are implementation-3009 defined. 3010
3011
3.6.20 RelationshipDefinition 3012
3.6.20.1 Description 3013
A relationship definition is an entity that defines a type of relationship, including a name and a description 3014 of the relationship type, types of source entity and target entities of a relationship, and definition of 3015 properties in a relationship. 3016
3.6.20.2 Class Definition 3017
The RelationshipDefinition class has attribute values: 3018
3019
localNamespace 3020
Value: icom_meta 3021
3022
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 97 of 244
localName 3023
Value: RelationshipDefinition 3024
3025
extendsFrom 3026
Value: icom_core:Entity, icom_meta:RelationshipBondable 3027
3028
stereotype 3029
Value: primary 3030
3031
description 3032
Value: A relationship definition is an entity that defines a type of relationship. 3033
3034
propertyDefinitions 3035
The values for this attribute are defined in Section 3.6.20.3. 3036
3.6.20.3 Property Definitions 3037
The RelationshipDefinition class inherits property definitions from super classes. 3038
The RelationshipDefinition class MUST have the property definitions: 3039
3040
icom_core:description 3041
Description: A description of a relationship definition. 3042
Required: False 3043
Inherited: False 3044
Property Type: String 3045
Cardinality: Single 3046
Updatability: Read Write 3047
3048
icom_meta:propertyDefinition 3049
Description: Optional or mandatory properties for a relationship. 3050
Required: False 3051
Inherited: False 3052
Property Type: icom_meta:PropertyDefinition 3053
Cardinality: Multi 3054
Updatability: Read Write 3055
3056
icom_meta:allowedSourceType 3057
Description: A list of expanded names of relationship bondable classes, 3058 indicating that the source entity of a relationship MUST be an 3059 instance of a class in the list. 3060
Required: False 3061
Inherited: False 3062
Property Type: IRI 3063
Cardinality: Multi 3064
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 98 of 244
Updatability: Read Write 3065
3066
icom_meta:allowedTargetType 3067
Description: A list of expanded names of relationship bondable classes, 3068 indicating that the target entity of a relationship MUST be an 3069 instance of a class in the list. 3070
Required: False 3071
Inherited: False 3072
Property Type: IRI 3073
Cardinality: Multi 3074
Updatability: Read Write 3075
3076
The RelationshipDefinition class MAY include additional property definitions which are implementation-3077 defined. 3078
3079
3.6.21 Relationship 3080
3.6.21.1 Description 3081
A relationship is an entity that relates a set of entities by a predicate. 3082
3.6.21.2 Class Definition 3083
The Relationship class has attribute values: 3084
3085
localNamespace 3086
Value: icom_meta 3087
3088
localName 3089
Value: Relationship 3090
3091
extendsFrom 3092
Value: icom_core:Entity 3093
3094
stereotype 3095
Value: primary 3096
3097
description 3098
Value: A relationship is an entity that relates a set of entities by a predicate. 3099
3100
propertyDefinitions 3101
The values for this attribute are defined in Section 3.6.21.3. 3102
3.6.21.3 Property Definitions 3103
The Relationship class inherits property definitions from super classes. 3104
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 99 of 244
The Relationship class MUST have the property definitions: 3105
3106
icom_meta:relationshipDefinition 3107
Description: A definition of relationships. 3108
Required: True 3109
Inherited: False 3110
Property Type: icom_meta:RelationshipDefinition 3111
Cardinality: Single 3112
Updatability: On Create 3113
3114
icom_meta:sourceEntity 3115
Description: A source entity of a relationship. 3116
Required: True 3117
Inherited: False 3118
Property Type: icom_meta:RelationshipBondable 3119
Cardinality: Single 3120
Updatability: On Create 3121
3122
icom_meta:targetEntity 3123
Description: One or more target entities of a relationship. 3124
Required: True 3125
Inherited: False 3126
Property Type: icom_meta:RelationshipBondable 3127
Cardinality: Multi 3128
Updatability: Read Write 3129
3130
icom_meta:property 3131
Description: Zero or more properties. 3132
Required: False 3133
Inherited: False 3134
Property Type: icom_meta:Property 3135
Cardinality: Multi 3136
Updatability: Read Write 3137
3138
The Relationship class MAY include additional property definitions which are implementation-defined. 3139
3140
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 100 of 244
3141
Figure 24: Relationship Class Diagram. 3142
3143
3.7 Common Concepts 3144
3.7.1 Addressable 3145
3.7.1.1 Description 3146
An addressable object is an identifiable object that has one or more addresses. 3147
3.7.1.2 Class Definition 3148
The Addressable class is a mixin class which defines the characteristics of entities that has one or more 3149 addresses. 3150
The Addressable class has attribute values: 3151
3152
localNamespace 3153
Value: icom_core 3154
3155
localName 3156
Value: Addressable 3157
3158
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 101 of 244
extendsFrom 3159
Value: icom_core:Identifiable 3160
3161
stereotype 3162
Value: mixin 3163
3164
description 3165
Value: Addressable is a mixin class which defines the characteristics of entities that has one or 3166 more addresses. 3167
3168
propertyDefinitions 3169
The values for this attribute are defined in Section 3.7.1.3. 3170
3.7.1.3 Property Definitions 3171
The Addressable class inherits property definitions from super classes. 3172
The Addressable class MUST have the property definitions: 3173
3174
icom_core:entityAddress 3175
Description: Zero or more addresses of an addressable object. 3176
Required: False 3177
Inherited: False 3178
Property Type: icom_core:EntityAddress 3179
Cardinality: Multi 3180
Updatability: Read Write 3181
3182
icom_core:primaryAddress 3183
Description: The primary address of an addressable object. 3184
Required: False 3185
Inherited: False 3186
Property Type: icom_core:EntityAddress 3187
Cardinality: Single 3188
Updatability: Read Write 3189
3190
The Addressable class MAY include additional property definitions which are implementation-defined. 3191
3192
3.7.2 EntityAddress 3193
3.7.2.1 Description 3194
An entity address object represents an address which is defined by type and IRI. 3195
3.7.2.2 Class Definition 3196
The EntityAddress class has attribute values: 3197
3198
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 102 of 244
localNamespace 3199
Value: icom_core 3200
3201
localName 3202
Value: EntityAddress 3203
3204
extendsFrom 3205
Value: 3206
3207
stereotype 3208
Value: primary 3209
3210
description 3211
Value: An entity address object represents an address which is defined by type and IRI. 3212
3213
propertyDefinitions 3214
The values for this attribute are defined in Section 3.7.2.3. 3215
3.7.2.3 Property Definitions 3216
The EntityAddress class MUST have the property definitions: 3217
3218
icom_core:addressType 3219
Description: Type of an address. 3220
Required: False 3221
Inherited: False 3222
Property Type: String 3223
Cardinality: Single 3224
Updatability: Read Write 3225
3226
icom_core:address 3227
Description: A IRI representing an address. 3228
Required: False 3229
Inherited: False 3230
Property Type: IRI 3231
Cardinality: Single 3232
Updatability: Read Write 3233
3234
3.7.3 Participant 3235
3.7.3.1 Description 3236
A participant object represents the participation of any addressable entity in a collaboration activity such 3237 as an occurrence, task, conference, discussion, and message. 3238
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 103 of 244
If an addressable entity is not specified, an address must be specified. 3239
3.7.3.2 Class Definition 3240
The Participant class has attribute values: 3241
3242
localNamespace 3243
Value: icom_core 3244
3245
localName 3246
Value: Participant 3247
3248
extendsFrom 3249
Value: 3250
3251
stereotype 3252
Value: primary 3253
3254
description 3255
Value: A participant object represents the participation of any addressable entity in a 3256 collaboration activity such as an occurrence, task, conference, discussion, and message. 3257
3258
propertyDefinitions 3259
The values for this attribute are defined in Section 3.7.3.3. 3260
3.7.3.3 Property Definitions 3261
The Participant class inherits property definitions from super classes. 3262
The Participant class MUST have the property definitions: 3263
3264
icom_core:participant 3265
Description: An addressable entity to participate in a collaboration activity. 3266
Required: False 3267
Inherited: False 3268
Property Type: icom_core:Addressable 3269
Cardinality: Single 3270
Updatability: On Create 3271
3272
icom_core:address 3273
Description: An address of a participant in a collaboration activity. 3274
Required: False 3275
Inherited: False 3276
Property Type: IRI 3277
Cardinality: Single 3278
Updatability: On Create 3279
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 104 of 244
3280
icom_core:name 3281
Description: Name of a participant in a collaboration activity. 3282
Required: False 3283
Inherited: False 3284
Property Type: String 3285
Cardinality: Single 3286
Updatability: On Create 3287
3288
The Participant class MAY include additional property definitions which are implementation-defined. 3289
3290
3.7.4 Priority 3291
3.7.4.1 Description 3292
A priority level for delivery of information. 3293
3.7.4.2 Class Definition 3294
The Priority class is a mixin class which defines a priority level for delivery of information. 3295
The Priority class has attribute values: 3296
3297
localNamespace 3298
Value: icom_core 3299
3300
localName 3301
Value: Priority 3302
3303
extendsFrom 3304
Value: 3305
3306
stereotype 3307
Value: mixin 3308
3309
description 3310
Value: Priority is a mixin class which defines a priority level for delivery of information. 3311
3312
propertyDefinitions 3313
The values for this attribute are defined in Section 3.7.4.3. 3314
3.7.4.3 Property Definitions 3315
The Priority class MAY include additional property definitions which are implementation-defined. 3316
3317
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 105 of 244
3.7.5 PriorityEnum 3318
The PriorityEnum class is an enum class that enumerates the instances each of which defines a priority 3319 level for delivery of information. 3320
The PriorityEnum has attribute values: 3321
3322
localNamespace 3323
Value: icom_core 3324
3325
localName 3326
Value: PriorityEnum 3327
3328
extendsFrom 3329
Value: icom_core:Priority 3330
3331
stereotype 3332
Value: primary 3333
3334
isEnumeration 3335
Value: TRUE 3336
3337
description 3338
Value: Priority level for delivery of information. 3339
3340
instances 3341
Value: <icom_core:Normal, icom_core:Low, icom_core:Medium, icom_core:High> 3342
3343
ICOM defines four priorities: 3344
icom_core:Normal a normal priority. 3345
icom_core:Low a low priority. 3346
icom_core:Medium a medium priority. 3347
icom_core:High a high priority. 3348
3349
3.7.6 DateTimeResolution 3350
3.7.6.1 Description 3351
A date time resolution is a resolution of date time value. 3352
3.7.6.2 Class Definition 3353
The DateTimeResolution class is a mixin class which defines a resolution of date time value. 3354
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 106 of 244
The DateTimeResolution class has attribute values: 3355
3356
localNamespace 3357
Value: icom_core 3358
3359
localName 3360
Value: DateTimeResolution 3361
3362
extendsFrom 3363
Value: 3364
3365
stereotype 3366
Value: mixin 3367
3368
description 3369
Value: DateTimeResolution is a mixin class which defines a resolution of date time value. 3370
3371
propertyDefinitions 3372
The values for this attribute are defined in Section 3.7.6.3. 3373
3.7.6.3 Property Definitions 3374
The DateTimeResolution class MAY include additional property definitions which are implementation-3375 defined. 3376
3377
3.7.7 DateTimeResolutionEnum 3378
The DateTimeResolutionEnum class is an enum class that enumerates the instances each of which 3379 expresses a resolution of a date time value. 3380
The DateTimeResolutionEnum has attribute values: 3381
3382
localNamespace 3383
Value: icom_core 3384
3385
localName 3386
Value: DateTimeResolutionEnum 3387
3388
extendsFrom 3389
Value: icom_core:DateTimeResolution 3390
3391
stereotype 3392
Value: primary 3393
3394
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 107 of 244
isEnumeration 3395
Value: TRUE 3396
3397
description 3398
Value: Resolution of a date time value. 3399
3400
instances 3401
Value: <icom_core:Year, icom_core:Date, icom_core:Time> 3402
3403
ICOM defines three date time resolutions: 3404
icom_core:Year date time resolution is in years. 3405
icom_core:Date date time resolution is in years and days. 3406
icom_core:Time date time resolution is in years, days, and time of day. 3407
3408
3.7.8 TimeZone 3409
3.7.8.1 Description 3410
A time zone is a region that has a uniform standard time. 3411
3.7.8.2 Class Definition 3412
The TimeZone class has attribute values: 3413
3414
localNamespace 3415
Value: icom_core 3416
3417
localName 3418
Value: TimeZone 3419
3420
extendsFrom 3421
Value: 3422
3423
stereotype 3424
Value: primary 3425
3426
description 3427
Value: A time zone is a region that has a uniform standard time. 3428
3429
propertyDefinitions 3430
The values for this attribute are defined in Section 3.7.8.3. 3431
3.7.8.3 Property Definitions 3432
The TimeZone class inherits property definitions from super classes. 3433
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 108 of 244
The TimeZone class MUST have the property definitions: 3434
3435
icom_core:ID 3436
Description: Identifier of a time zone. 3437
Required: False 3438
Inherited: False 3439
Property Type: String 3440
Cardinality: Single 3441
Updatability: On Create 3442
3443
icom_core:rawOffset 3444
Description: An offset to add to Universal Coordinated Time (UTC) to get 3445 local time. If Daylight Saving Time is in effect at the specified 3446 date, the offset value is adjusted with the amount of daylight 3447 saving. 3448
Required: False 3449
Inherited: False 3450
Property Type: Integer 3451
Cardinality: Single 3452
Updatability: On Create 3453
3454
The TimeZone class MAY include additional property definitions which are implementation-defined. 3455
3456
3.7.9 Location 3457
3.7.9.1 Description 3458
A location object represents a physical location which is defined by name, description, and geo 3459 coordinates. 3460
Note: The name of a location may remain unchanged while a physical location may be changing. For 3461 example, a location name might be “On an airplane” while a physical location might be the geo 3462 coordinates of a flight path or current coordinates of a plane. 3463
3.7.9.2 Class Definition 3464
The Location class has attribute values: 3465
3466
localNamespace 3467
Value: icom_core 3468
3469
localName 3470
Value: Location 3471
3472
extendsFrom 3473
Value: 3474
3475
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 109 of 244
stereotype 3476
Value: primary 3477
3478
description 3479
Value: A location object represents a physical location which is defined by name, description, or 3480 geo coordinates. 3481
3482
propertyDefinitions 3483
The values for this attribute are defined in Section 3.7.9.3. 3484
3.7.9.3 Property Definitions 3485
The Location class MUST have the property definitions: 3486
3487
icom_core:name 3488
Description: Name of a location. 3489
Required: False 3490
Inherited: False 3491
Property Type: String 3492
Cardinality: Single 3493
Updatability: Read Write 3494
3495
icom_core:description 3496
Description: A description of a location. 3497
Required: False 3498
Inherited: False 3499
Property Type: String 3500
Cardinality: Single 3501
Updatability: Read Write 3502
3503
icom_core:timeZone 3504
Description: Time zone of a location. 3505
Required: False 3506
Inherited: False 3507
Property Type: icom_core:TimeZone 3508
Cardinality: Single 3509
Updatability: Read Write 3510
3511
icom_core:coordinates 3512
Description: A list of geo coordinates marking a point, path, or area of a 3513 physical location. 3514
Required: False 3515
Inherited: False 3516
Property Type: icom_core:GeoCoordinates 3517
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 110 of 244
Cardinality: Multi 3518
Updatability: Read Write 3519
3520
The Location class MAY include additional property definitions which are implementation-defined. 3521
3522
3.7.10 GeoCoordinates 3523
3.7.10.1 Description 3524
A geo coordinates object specifies the latitude, longitude, and altitude of a physical location. 3525
3.7.10.2 Class Definition 3526
The GeoCoordinates class has attribute values: 3527
3528
localNamespace 3529
Value: icom_core 3530
3531
localName 3532
Value: GeoCoordinates 3533
3534
extendsFrom 3535
Value: 3536
3537
stereotype 3538
Value: primary 3539
3540
description 3541
Value: A geo coordinates object specifies the latitude, longitude, and altitude of a physical 3542 location. 3543
3544
propertyDefinitions 3545
The values for this attribute are defined in Section 3.7.10.3. 3546
3.7.10.3 Property Definitions 3547
The GeoCoordinates class MUST have the property definitions: 3548
3549
icom_core:latitude 3550
Description: Latitude of a location. 3551
Required: False 3552
Inherited: False 3553
Property Type: Float 3554
Cardinality: Single 3555
Updatability: Read Write 3556
3557
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 111 of 244
icom_core:longitude 3558
Description: Longitude of a location. 3559
Required: False 3560
Inherited: False 3561
Property Type: Float 3562
Cardinality: Single 3563
Updatability: Read Write 3564
3565
icom_core:altitude 3566
Description: Altitude of a location. 3567
Required: False 3568
Inherited: False 3569
Property Type: Float 3570
Cardinality: Single 3571
Updatability: Read Write 3572
3573
The GeoCoordinates class MAY include additional property definitions which are implementation-defined. 3574
3575
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 112 of 244
4 Extension Modules 3576
4.1 Overview of Extension Modules 3577
Each extension module defines a model of a collaboration activity. Different models of collaboration 3578 activities in this specification include content creation, communication, coordination, discussion forum, 3579 and conference. Except for the Presence Module and Free Busy Module, the extension modules in this 3580 section introduce specialized subclasses of Artifact and Folder of Artifact Branch. 3581
Note: ICOM Core Model (Section 3) establishes a framework to integrate specialized collaboration 3582 activities of the extension modules, which more or less represent technology or protocol channels. The 3583 framework is extensible with additional extension modules. For example, applications can adopt a model 3584 for CMIS Policy base type as a new extension module, which can be used to integrate with BPMN or 3585 BPEL processes outside the ICOM domain. An ICOM space can provide a durable context for continuity 3586 of conversations and activities related to a business process type or process instance. Some new 3587 extension modules may import the models from related standards. For example, social network model 3588 may be imported from [OpenGraph] or [OpenSocial]. 3589
3590
Figure 25: Containers of Collaboration Activities. 3591
ICOM defines containers that provide contexts and structures for specific areas of collaborative activities. 3592 The UML class diagram in Figure 25 depicts a Space as a hub of containers, including 3593 HeterogeneousFolder, AddressBook, Calendar, TaskList, Forum, and Conference. These containers are 3594 briefly described as follows: 3595
HeterogeneousFolder (defined in Core Model) is a general purpose container that can contain 3596
any type of artifacts, and therefore, can serve as 3597
a library of documents and wiki pages to support content sharing and co-creation, 3598
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 113 of 244
an inbox or outbox for communication, or 3599
a trash folder to archive all types of artifacts deleted from a space. 3600
AddressBook is a specialized container to manage contact or personal information, such as 3601 addresses, phone numbers, birthdays, anniversaries, and other entries. 3602
Calendar is a specialized container to support time management. 3603
TaskList is a specialized container to support task coordination. 3604
Forum is a specialized container to support 3605
Topic sub-containers for threaded discussions and 3606
Announcement sub-containers for time-sensitive communication. 3607
Conference is a specialized container that provides a durable context for real-time interactions. 3608
3609
The following ten modules are specified as extension modules of ICOM: 3610
1. Content Module (in Section 4.2) defines Content, MultiContent, and SimpleContent. A content 3611 represents a piece of data in a document or message. Content, multi-content, simple content, and 3612 online content form a composite design pattern. 3613
2. Document Module (in Section 4.3) defines Document, WikiPage, and version control model. A 3614 document can contain a composite content defined in Section 4.2. Documents are typically 3615 contained by heterogeneous folders. 3616
3. Message Module (in Section 4.4) defines Message, UnifiedMessage, InstantMessage, and 3617 related classes. A message can contain a composite content defined in Section 4.2. Unified 3618 messages are typically contained by heterogeneous folders. 3619
4. Presence Module (in Section 4.5) defines Presence, Activity, and Contact Method. Presence 3620 represents a watchable state of a presentity (which is usually a person). Presence state is derived 3621 using an actor's subscriptions. 3622
Note: Since a Presence is derived using a viewer's subscriptions, a Presence should not be shared 3623 with other viewers. For this reason, Presence is not modeled as Entity and is not assigned an access 3624 control list. 3625
5. Address Book Module (in Section 4.6) defines AddressBook and PersonContact. A person 3626 contact can bookmark a reference to a person in an ICOM community as well as store addresses, 3627 phone numbers, and other entries about a person who may not be in any ICOM community. 3628
6. Calendar Module (in Section 4.7) defines Calendar, Occurrence, and OccurrenceSeries. 3629 Occurrence artifacts are used to resolve the free-busy times of participants for scheduling of 3630 meetings and booking of rooms and other resources. 3631
7. Free Busy Module (in Section 4.8) defines FreeBusy. FreeBusy is a view derived from 3632 occurrences in a calendar or a set of calendars using an actor's privileges to determine the free 3633 or busy states of calendar occurrences. 3634
Note: Since a FreeBusy view is derived using a viewer's privileges, a FreeBusy should not be shared 3635 with other viewers. For this reason, FreeBusy is not modeled as Entity and is not assigned an access 3636 control list. 3637
8. Task List Module (in Section 4.9) defines TaskList and Task. Tasks are used to coordinate the 3638 assignment of tasks and to track the progress of task activities. 3639
9. Forum Module (in Section 4.10) defines Forum, Topic, Announcement, and DiscussionMessage. 3640 Topics, announcements, and discussions are used for treaded discussions. Moderators of a 3641 forum can prune, merge, or fork the discussion threads. 3642
10. Conference Module (in Section 4.11) defines Conference and related classes. A conference can 3643 contain visual, audio, and chat transcripts of the conference sessions. It also contains the current 3644 status, conference settings, past sessions, active session, and activity logs. 3645
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 114 of 244
4.2 Content Module 3646
4.2.1 MimeConvertible 3647
4.2.1.1 Description 3648
A MimeConvertible object represents an object that has Multipurpose Internet Mail Extensions (MIME) 3649 characteristics such as headers, content transfer encoding, and possible hierarchy of sub-contents. 3650
4.2.1.2 Class Definition 3651
The MimeConvertible class is a mixin class that defines the characteristics of objects that can be 3652 represented in MIME format. 3653
The MimeConvertible class has attribute values: 3654
3655
localNamespace 3656
Value: icom_content 3657
3658
localName 3659
Value: MimeConvertible 3660
3661
extendsFrom 3662
Value: icom_core:Identifiable 3663
3664
stereotype 3665
Value: mixin 3666
3667
description 3668
Value: MimeConvertible class is a mixin class that defines the characteristics of objects that can 3669 be represented in MIME format. 3670
3671
propertyDefinitions 3672
The values for this attribute are defined in Section 4.2.1.3. 3673
4.2.1.3 Property Definitions 3674
The MimeConvertible class inherits property definitions from super classes. 3675
The MimeConvertible class MAY include additional property definitions which are implementation-defined. 3676
3677
4.2.2 Content 3678
4.2.2.1 Description 3679
A content object represents a piece of data in a document or message. Content, multi-content, simple 3680 content, and online content form a composite design pattern. 3681
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 115 of 244
4.2.2.2 Class Definition 3682
The Content class has attribute values: 3683
3684
localNamespace 3685
Value: icom_content 3686
3687
localName 3688
Value: Content 3689
3690
extendsFrom 3691
Value: icom_core:Identifiable, icom_content:MimeConvertible 3692
3693
stereotype 3694
Value: primary 3695
3696
isAbstract 3697
Value: TRUE 3698
3699
description 3700
Value: Content represents a piece of data in a document or message. 3701
3702
propertyDefinitions 3703
The values for this attribute are defined in Section 4.2.2.3. 3704
4.2.2.3 Property Definitions 3705
The Content class inherits property definitions from super classes. 3706
The Content class MUST have the property definitions: 3707
3708
icom_content:contentId 3709
Description: A content id is a unique identifier for a part of content in multi-3710 part contents. 3711
Required: False 3712
Inherited: False 3713
Property Type: String 3714
Cardinality: Single 3715
Updatability: Read Write 3716
3717
icom_content:mediaType 3718
Description: Media type is a two-part identifier for Internet file formats. 3719
Required: False 3720
Inherited: False 3721
Property Type: String 3722
Cardinality: Single 3723
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 116 of 244
Updatability: Read Write 3724
3725
icom_content:contentDisposition 3726
Description: Content disposition specifies a presentation style. 3727
Required: False 3728
Inherited: False 3729
Property Type: icom_content:ContentDispositionType 3730
Cardinality: Single 3731
Updatability: Read Write 3732
3733
The Content class MAY include additional property definitions which are implementation-defined. 3734
3735
3736
Figure 26: Composite Content Class Diagram. 3737
3738
4.2.3 MultiContent 3739
4.2.3.1 Description 3740
A multi-content object represents multiple parts of a message or document. It is a composite content that 3741 can contain a list of simple or composite contents. 3742
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 117 of 244
4.2.3.2 Class Definition 3743
The MultiContent class has attribute values: 3744
3745
localNamespace 3746
Value: icom_content 3747
3748
localName 3749
Value: MultiContent 3750
3751
extendsFrom 3752
Value: icom_content:Content 3753
3754
stereotype 3755
Value: primary 3756
3757
description 3758
Value: A multi-content object represents the multiple parts of a message or document. 3759
3760
propertyDefinitions 3761
The values for this attribute are defined in Section 4.2.3.3. 3762
4.2.3.3 Property Definitions 3763
The MultiContent class inherits property definitions from super classes. 3764
The MultiContent class MUST have the property definitions: 3765
3766
icom_content:part 3767
Description: Zero or more parts of a hierarchical composite content. 3768
Required: False 3769
Inherited: False 3770
Property Type: icom_content:MimeConvertible 3771
Cardinality: Multi 3772
Updatability: Read Write 3773
3774
The MultiContent class MAY include additional property definitions which are implementation-defined. 3775
3776
4.2.4 SimpleContent 3777
4.2.4.1 Description 3778
A simple content holds a single piece of data. 3779
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 118 of 244
4.2.4.2 Class Definition 3780
The SimpleContent class has attribute values: 3781
3782
localNamespace 3783
Value: icom_content 3784
3785
localName 3786
Value: SimpleContent 3787
3788
extendsFrom 3789
Value: icom_content:Content 3790
3791
stereotype 3792
Value: primary 3793
3794
description 3795
Value: A simple content holds a single piece of data. 3796
3797
propertyDefinitions 3798
The values for this attribute are defined in Section 4.2.4.3. 3799
4.2.4.3 Property Definitions 3800
The SimpleContent class inherits property definitions from super classes. 3801
The SimpleContent class MUST have the property definitions: 3802
3803
icom_content:characterEncoding 3804
Description: Character encoding specifies character set of a content (a 3805 missing value means that a piece of content should be 3806 treated as binary or raw). 3807
Required: False 3808
Inherited: False 3809
Property Type: String 3810
Cardinality: Single 3811
Updatability: Read Write 3812
3813
icom_content:contentEncoding 3814
Description: Content encoding specifies encoding of a piece of content. 3815
Required: False 3816
Inherited: False 3817
Property Type: String 3818
Cardinality: Single 3819
Updatability: Read Write 3820
3821
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 119 of 244
icom_content:contentLanguage 3822
Description: Content language specifies language for a piece of content (a 3823 missing value means non-natural language content). 3824
Required: False 3825
Inherited: False 3826
Property Type: Locale 3827
Cardinality: Single 3828
Updatability: Read Write 3829
3830
icom_content:contentLength 3831
Description: Length of a piece of content. 3832
Required: False 3833
Inherited: False 3834
Property Type: Integer 3835
Cardinality: Single 3836
Updatability: Read Write 3837
3838
icom_content:contentBody 3839
Description: Body of a simple content. 3840
Required: False 3841
Inherited: False 3842
Property Type: Object 3843
Cardinality: Single 3844
Updatability: Read Write 3845
3846
The SimpleContent class MAY include additional property definitions which are implementation-defined. 3847
3848
4.2.5 OnlineContent 3849
4.2.5.1 Description 3850
An online content holds an online artifact attached to a document, message, or invitation. 3851
Note: An online artifact must be rendered as an IRI when a message or invitation is delivered to external 3852 recipients. 3853
4.2.5.2 Class Definition 3854
The OnlineContent class has attribute values: 3855
3856
localNamespace 3857
Value: icom_content 3858
3859
localName 3860
Value: OnlineContent 3861
3862
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 120 of 244
extendsFrom 3863
Value: icom_content:Content 3864
3865
stereotype 3866
Value: primary 3867
3868
description 3869
Value: An online content holds an online artifact attached to a message or invitation. 3870
3871
propertyDefinitions 3872
The values for this attribute are defined in Section 4.2.5.3. 3873
4.2.5.3 Property Definitions 3874
The OnlineContent class inherits property definitions from super classes. 3875
The OnlineContent class MUST have the property definition: 3876
3877
icom_content:onlineAttachment 3878
Description: An online artifact attached to a message. 3879
Required: True 3880
Inherited: False 3881
Property Type: icom_core:Artifact 3882
Cardinality: Single 3883
Updatability: Read Write 3884
3885
The OnlineContent class MAY include additional property definitions which are implementation-defined. 3886
3887
4.2.6 ContentDispositionType 3888
4.2.6.1 Description 3889
A content disposition type is a presentation style of content. 3890
4.2.6.2 Class Definition 3891
The ContentDispositionType class is a mixin class which defines a presentation style of content. 3892
The ContentDispositionType class has attribute values: 3893
3894
localNamespace 3895
Value: icom_content 3896
3897
localName 3898
Value: ContentDispositionType 3899
3900
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 121 of 244
extendsFrom 3901
Value: 3902
3903
stereotype 3904
Value: mixin 3905
3906
description 3907
Value: ContentDispositionType is a mixin class which defines a presentation style of content. 3908
3909
propertyDefinitions 3910
The values for this attribute are defined in Section 4.2.6.3. 3911
4.2.6.3 Property Definitions 3912
The ContentDispositionType class MAY include additional property definitions which are implementation-3913 defined. 3914
3915
4.2.7 ContentDispositionTypeEnum 3916
The ContentDispositionTypeEnum class is an enum class that enumerates the instances each of which 3917 expresses a presentation style of content. 3918
The ContentDispositionTypeEnum class has attribute values: 3919
3920
localNamespace 3921
Value: icom_content 3922
3923
localName 3924
Value: ContentDispositionTypeEnum 3925
3926
extendsFrom 3927
Value: icom_content:ContentDispositionType 3928
3929
stereotype 3930
Value: primary 3931
3932
isEnumeration 3933
Value: TRUE 3934
3935
description 3936
Value: A presentation style of content. 3937
3938
instances 3939
Value: <icom_content:Inline, icom_content:Attachment> 3940
3941
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 122 of 244
ICOM defines two content disposition types: 3942
icom_content:Inline content is to be displayed automatically upon display of the main body of an 3943
artifact. 3944
icom_content:Attachment content is separate from the main body of an artifact, and that its 3945 display should not be automatic, but contingent upon some further action of a user. 3946
3947
4.2.8 AttachedItem 3948
4.2.8.1 Description 3949
An attached item holds a content for an occurrence, task, and contact artifact. 3950
4.2.8.2 Class Definition 3951
The AttachedItem class has attribute values: 3952
3953
localNamespace 3954
Value: icom_content 3955
3956
localName 3957
Value: AttachedItem 3958
3959
extendsFrom 3960
Value: 3961
3962
stereotype 3963
Value: primary 3964
3965
description 3966
Value: An attachedItem holds a content for an occurrence, task, and contact artifact. 3967
3968
propertyDefinitions 3969
The values for this attribute are defined in Section 4.2.8.3. 3970
4.2.8.3 Property Definitions 3971
The AttachedItem class MUST have the property definitions: 3972
3973
icom_core:name 3974
Description: Name of a content attachment. 3975
Required: True 3976
Inherited: False 3977
Property Type: String 3978
Cardinality: Single 3979
Updatability: Read Write 3980
3981
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 123 of 244
icom_content:content 3982
Description: A content attached to an occurrence, task, or contact artifact. 3983
Required: True 3984
Inherited: False 3985
Property Type: icom_content:Content 3986
Cardinality: Single 3987
Updatability: Read Write 3988
3989
The AttachedItem class MAY include additional property definitions which are implementation-defined. 3990
3991
4.3 Document Module 3992
4.3.1 Versionable 3993
4.3.1.1 Description 3994
A versionable artifact is 3995
1. a non-version-controlled copy, 3996
2. a specific versioned copy, 3997
3. a private working copy, or 3998
4. a representative copy (optional) 3999
of an artifact version series. 4000
When a versionable artifact is not under version control, a non-version-controlled copy MUST be the only 4001 copy in a version series, i.e. there is only one copy and one objectId. 4002
When a versionable artifact is under version control, a representative copy MAY provide a version-4003 independent view of a versionable artifact. 4004
When a non-version-controlled copy is placed under version control, a versioned copy MUST be created. 4005 Assignment of an object identifier to a versioned copy is implementation-dependent: 4006
if a versioned copy retains the object identifier of a non-version-controlled copy, the version type 4007 of a versionable artifact MUST change from NonVersionControlledCopy to VersionedCopy; 4008
if a versioned copy is assigned a new object identifier that is different from the object identifier of 4009 a non-version-controlled copy, a representative copy MAY retain the object identifier of the non-4010 version-controlled copy; 4011
if both versioned copy and representative copy are assigned new object identifiers that are 4012 different from the object identifier of a non-version-controlled copy, the non-version-controlled 4013 copy SHALL be discarded. 4014
When a private working copy is checked in, a versioned copy MUST be created. Assignment of an object 4015 identifier to a versioned copy is implementation-dependent: 4016
if a versioned copy retains the object identifier of a private working copy, the version type of a 4017 versionable artifact MUST change from PrivateWorkingCopy to VersionedCopy; 4018
if a versioned copy is assigned a new object identifier that is different from the object identifier of 4019 a private working copy, the private working copy SHALL be discarded. 4020
It is optional for a service provider to provide a representative copy for a version series. If a representative 4021 copy is provided: 4022
a representative copy MUST have its own object identifier that is different from the object 4023 identifier of any versioned copy or private working copy; 4024
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 124 of 244
assignment of an object identifier to a representative copy is implementation-dependent: 4025
o a representative copy MAY retain the object identifier of a non-version-controlled copy; if 4026 so the version type of a versionable artifact MUST change from 4027 NonVersionControlledCopy to RepresentativeCopy; 4028
o a representative copy MAY be assigned a new object identifier that is different from the 4029 object identifier of a non-version-controlled copy; 4030
content and state of a representative copy is implementation-dependent: 4031
o a representative copy MAY be a copy of the content and state of the latest versioned 4032 copy or the latest major versioned copy in a version series; 4033
o a representative copy MAY be a copy of the content and state of a private working copy if 4034 the current user loading the representative copy is the same user who checks out a 4035 version series. 4036
Note: Each versioned copy of a versionable artifact is itself a versionable artifact, i.e. it has its own 4037 objectId. A versioned copy has a version number, label, and check in comment. 4038
Note: A private working copy is a versionable artifact created by an explicit checkout operation on a 4039 versionable artifact under version control. The properties for a private working copy are identical to the 4040 properties of a versioned copy on which a checkout operation was performed. Certain properties such as 4041 objectId and creationDate are different from a versioned copy. The content of a private working copy is 4042 identical to the content of a versioned copy. Its object identifier is different from that of the representative 4043 copy or any versioned copy. 4044
A private working copy MAY be saved in a version series for sharing and co-editing, however, it needs 4045 not be visible to users who may only have permissions to view other versioned copies in a version series. 4046
Note: Until it is checked in using an explicit check-in operation, a private working copy must not be 4047 considered the LatestMajorVersion in a version series. 4048
A container of a versionable artifact CAN contain a representative copy so that it provides a version-4049 independent view of a state of the version series. 4050
Note: Starting from a representative copy in a container, an actor can traverse a version series to retrieve 4051 any versioned copy or private working copy. 4052
ICOM version control model is based on the CMIS version control model specified in Section 2.1.9 of 4053 Content Management Interoperability Services Version 1.0 [CMIS]. 4054
4.3.1.2 Class Definition 4055
The Versionable class is a mixin class that defines the characteristics of artifacts that can be versioned. 4056
The Versionable class has attribute values: 4057
4058
localNamespace 4059
Value: icom_doc 4060
4061
localName 4062
Value: Versionable 4063
4064
extendsFrom 4065
Value: icom_core:Identifiable 4066
4067
stereotype 4068
Value: mixin 4069
4070
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 125 of 244
description 4071
Value: Versionable class is a mixin class that defines the characteristics of artifacts that can be 4072 versioned. 4073
4074
propertyDefinitions 4075
The values for this attribute are defined in Section 4.3.1.3. 4076
4.3.1.3 Property Definitions 4077
The Versionable class inherits property definitions from super classes. 4078
The Versionable class MUST have the property definitions: 4079
4080
icom_doc:versionControlMetadata 4081
Description: A version control metadata object attached to a versionable 4082 artifact. 4083
Required: False 4084
Inherited: False 4085
Property Type: icom_doc:VersionControlMetadata 4086
Cardinality: Single 4087
Updatability: Read Only 4088
4089
icom_doc:versionType 4090
Description: A type of version controlled copy of a versionable artifact. 4091
Required: False 4092
Inherited: False 4093
Property Type: icom_doc:VersionType 4094
Cardinality: Single 4095
Updatability: Read Only 4096
4097
The Versionable class MAY include additional property definitions which are implementation-defined. 4098
4099
4.3.2 VersionControlMetadata 4100
4.3.2.1 Description 4101
A version control metadata is an object that contains version control information. 4102
There are two classes of version control metadata: version series and version. A version control metadata 4103 of a versionable artifact is either a version series or a version depending on the version type. 4104
If the version type is icom_doc:NonVersionControlledCopy then metadata is optional; if metadata 4105 is present, it MUST be a version series object. 4106
If the version type is icom_doc:RepresentativeCopy, then metadata MUST be a version series 4107 object. 4108
If the version type is icom_doc:VersionedCopy or icom_doc:PrivateWorkingCopy, then metadata 4109 MUST be a version object. 4110
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 126 of 244
4.3.2.2 Class Definition 4111
The VersionControlMetadata class is a mixin class that defines the characteristics of version or version 4112 series metadata for version control. 4113
The VersionControlMetadata class has attribute values: 4114
4115
localNamespace 4116
Value: icom_doc 4117
4118
localName 4119
Value: VersionControlMetadata 4120
4121
extendsFrom 4122
Value: icom_core:Identifiable 4123
4124
stereotype 4125
Value: mixin 4126
4127
description 4128
Value: VersionControlMetadata is a mixin class that defines the characteristics of entities that 4129 serve as metadata for version control. 4130
4131
propertyDefinitions 4132
The values for this attribute are defined in Section 4.3.2.3. 4133
4.3.2.3 Property Definitions 4134
The VersionControlMetadata class inherits property definitions from super classes. 4135
The VersionControlMetadata class MUST have the property definition: 4136
4137
icom_doc:representativeCopy 4138
Description: A representative copy of a versionable artifact. 4139
Required: False 4140
Inherited: False 4141
Property Type: icom_doc:Versionable 4142
Cardinality: Single 4143
Updatability: Read Only 4144
4145
The VersionControlMetadata class MAY include additional property definitions which are implementation-4146 defined. 4147
4148
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 127 of 244
4.3.3 VersionSeries 4149
4.3.3.1 Description 4150
A version series is a version control metadata that contains a version history and check in/out states of a 4151 versionable artifact. 4152
A version series object is a version control metadata of a representative copy of a versionable artifact. 4153
4.3.3.2 Class Definition 4154
The VersionSeries class has attribute values: 4155
4156
localNamespace 4157
Value: icom_doc 4158
4159
localName 4160
Value: VersionSeries 4161
4162
extendsFrom 4163
Value: icom_core:Entity, icom_doc:VersionControlMetadata, icom_meta:RelationshipBondable 4164
4165
stereotype 4166
Value: primary 4167
4168
description 4169
Value: A version series is version control metadata that contains a version history and check 4170 in/out states of a versionable artifact. 4171
4172
propertyDefinitions 4173
The values for this attribute are defined in Section 4.3.3.3. 4174
4.3.3.3 Property Definitions 4175
The VersionSeries class inherits property definitions from super classes. 4176
The VersionSeries class MUST have the property definitions: 4177
4178
icom_doc:versionHistory 4179
Description: A history of version nodes of a versionable artifact. 4180
Required: False 4181
Inherited: False 4182
Property Type: icom_doc:Version 4183
Cardinality: Multi 4184
Updatability: Read Only 4185
4186
icom_doc:versionableHistory 4187
Description: A history of the versioned copies of a versionable artifact. 4188
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 128 of 244
Required: False 4189
Inherited: False 4190
Property Type: icom_doc:Versionable 4191
Cardinality: Multi 4192
Updatability: Read Only 4193
4194
icom_doc:latestVersionedCopy 4195
Description: Latest versioned copy of a versionable artifact. 4196
Required: False 4197
Inherited: False 4198
Property Type: icom_doc:Versionable 4199
Cardinality: Single 4200
Updatability: Read Only 4201
4202
icom_doc:privateWorkingCopy 4203
Description: A private working copy of a versionable artifact. 4204
Required: False 4205
Inherited: False 4206
Property Type: icom_doc:Versionable 4207
Cardinality: Single 4208
Updatability: Read Only 4209
4210
icom_doc:versionSeriesCheckedOut 4211
Description: Indicates whether a version series is checked out. 4212
Required: False 4213
Inherited: False 4214
Property Type: Boolean 4215
Cardinality: Single 4216
Updatability: Read Only 4217
4218
icom_doc:versionSeriesCheckedOutBy 4219
Description: An actor who checks out a version series. 4220
Required: False 4221
Inherited: False 4222
Property Type: icom_core:Actor 4223
Cardinality: Single 4224
Updatability: Read Only 4225
4226
icom_doc:versionSeriesCheckedOutOn 4227
Description: The time when a version series is checked out. 4228
Required: False 4229
Inherited: False 4230
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 129 of 244
Property Type: DateTime 4231
Cardinality: Single 4232
Updatability: Read Only 4233
4234
icom_doc:versionSeriesCheckoutComment 4235
Description: A check out comment of a version series. 4236
Required: False 4237
Inherited: False 4238
Property Type: String 4239
Cardinality: Single 4240
Updatability: Read Only 4241
4242
icom_doc:totalSize 4243
Description: Total size of all versioned copies of a versionable artifact in a 4244 version series. 4245
Required: False 4246
Inherited: False 4247
Property Type: Integer 4248
Cardinality: Single 4249
Updatability: Read Only 4250
4251
The VersionSeries class MAY include additional property definitions which are implementation-defined. 4252
4253
4.3.4 Version 4254
4.3.4.1 Description 4255
A version is a version control metadata that contains a version number, label, and description. 4256
A version object is a version control metadata of a versioned copy or a private working copy of a 4257 versionable artifact. 4258
4.3.4.2 Class Definition 4259
The Version class has attribute values: 4260
4261
localNamespace 4262
Value: icom_doc 4263
4264
localName 4265
Value: Version 4266
4267
extendsFrom 4268
Value: icom_core:Entity, icom_doc:VersionControlMetadata, icom_meta:RelationshipBondable 4269
4270
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 130 of 244
stereotype 4271
Value: primary 4272
4273
description 4274
Value: A version is a version control metadata that contains a version number, label, and 4275 description. 4276
4277
propertyDefinitions 4278
The values for this attribute are defined in Section 4.3.4.3. 4279
4.3.4.3 Property Definitions 4280
The Version class inherits property definitions from super classes. 4281
The Version class MUST have the property definitions; 4282
4283
icom_doc:checkinComment 4284
Description: A check in comment of a versioned copy. 4285
Required: False 4286
Inherited: False 4287
Property Type: String 4288
Cardinality: Single 4289
Updatability: Read Write 4290
4291
icom_doc:versionNumber 4292
Description: A version number of a versioned copy. 4293
Required: True 4294
Inherited: False 4295
Property Type: Integer 4296
Cardinality: Single 4297
Updatability: Read Write 4298
4299
icom_doc:versionLabel 4300
Description: A version label of a versioned copy. 4301
Required: True 4302
Inherited: False 4303
Property Type: String 4304
Cardinality: Single 4305
Updatability: Read Write 4306
4307
icom_doc:majorVersion 4308
Description: Indicates whether a versioned copy is a major version. 4309
Required: True 4310
Inherited: False 4311
Property Type: Boolean 4312
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 131 of 244
Cardinality: Single 4313
Updatability: Read Write 4314
4315
icom_doc:versionedOrPrivateWorkingCopy 4316
Description: A versioned copy or private working copy corresponding to a 4317 version of a versionable artifact. 4318
Required: False 4319
Inherited: False 4320
Property Type: icom_doc:Versionable 4321
Cardinality: Single 4322
Updatability: Read Only 4323
4324
The Version class MAY include additional property definitions which are implementation-defined. 4325
4326
4.3.5 VersionType 4327
4.3.5.1 Description 4328
A version type is a version state of a copy of versionable document. 4329
4.3.5.2 Class Definition 4330
The VersionType class is a mixin class which defines a version state of a copy of versionable document. 4331
The VersionType class has attribute values: 4332
4333
localNamespace 4334
Value: icom_doc 4335
4336
localName 4337
Value: VersionType 4338
4339
extendsFrom 4340
Value: 4341
4342
stereotype 4343
Value: mixin 4344
4345
description 4346
Value: VersionType is a mixin class which defines a version state of a copy of versionable 4347 document. 4348
4349
propertyDefinitions 4350
The values for this attribute are defined in Section 4.3.5.3. 4351
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 132 of 244
4.3.5.3 Property Definitions 4352
The VersionType class MAY include additional property definitions which are implementation-defined. 4353
4354
4.3.6 VersionTypeEnum 4355
The VersionTypeEnum class is an enum class that enumerates the instances each of which expresses a 4356 version type. 4357
The VersionTypeEnum class has attribute values: 4358
4359
localNamespace 4360
Value: icom_doc 4361
4362
localName 4363
Value: VersionTypeEnum 4364
4365
extendsFrom 4366
Value: icom_doc:VersionType 4367
4368
stereotype 4369
Value: primary 4370
4371
isEnumeration 4372
Value: TRUE 4373
4374
description 4375
Value: A version type of a copy of versionable document. 4376
4377
instances 4378
Value: <icom_doc:NonVersionControlledCopy, icom_doc:VersionedCopy, 4379 icom_doc:PrivateWorkingCopy, icom_doc:RepresentativeCopy> 4380
4381
ICOM defines four version types: 4382
icom_doc:NonVersionControlledCopy a versionable artifact is not under version control. 4383
icom_doc:VersionedCopy a versionable artifact is a version of an artifact version series. 4384
icom_doc:PrivateWorkingCopy a versionable artifact is a private working copy of an artifact 4385 version series. 4386
icom_doc:RepresentativeCopy a versionable artifact is a version-independent representative 4387
copy of an artifact. This version type is optional and implementation-dependent. 4388
4389
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 133 of 244
4.3.7 Document 4390
4.3.7.1 Description 4391
A document is a versionable artifact that can contain a single content of a media type or composite 4392 contents of an assortment of media types. 4393
4.3.7.2 Class Definition 4394
The Document class has attribute values: 4395
4396
localNamespace 4397
Value: icom_doc 4398
4399
localName 4400
Value: Document 4401
4402
extendsFrom 4403
Value: icom_core:Artifact, icom_doc:Versionable, icom_content:MimeConvertible 4404
4405
stereotype 4406
Value: primary 4407
4408
description 4409
Value: A document is a versionable artifact that may contain a single content of a media type or 4410 composite contents of an assortment of media types. 4411
4412
propertyDefinitions 4413
The values for this attribute are defined in Section 4.3.7.3. 4414
4.3.7.3 Property Definitions 4415
The Document class inherits property definitions from super classes. 4416
The Document class MUST have the property definitions: 4417
4418
icom_content:content 4419
Description: Content of a document. 4420
Required: False 4421
Inherited: False 4422
Property Type: icom_content:Content 4423
Cardinality: Single 4424
Updatability: Read Write 4425
4426
icom_doc:size 4427
Description: The size of a copy of a document. 4428
Required: False 4429
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 134 of 244
Inherited: False 4430
Property Type: Integer 4431
Cardinality: Single 4432
Updatability: Read Only 4433
4434
The Document class MAY include additional property definitions which are implementation-defined. 4435
4436
4437
Figure 27: Document, Version Series, and Version Class Diagram. 4438
4439
4.3.8 WikiPage 4440
4.3.8.1 Description 4441
A wiki page is a document that contains a wiki content and that provides an html page generated from the 4442 wiki content. 4443
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 135 of 244
4.3.8.2 Class Definition 4444
The WikiPage class has attribute values: 4445
4446
localNamespace 4447
Value: icom_doc 4448
4449
localName 4450
Value: WikiPage 4451
4452
extendsFrom 4453
Value: icom_doc:Document 4454
4455
stereotype 4456
Value: primary 4457
4458
description 4459
Value: A wiki page is a document that contains a wiki content and that provides an html page 4460 generated from the wiki content. 4461
4462
propertyDefinitions 4463
The values for this attribute are defined in Section 4.3.8.3. 4464
4.3.8.3 Property Definitions 4465
The WikiPage class inherits property definitions from super classes. 4466
The WikiPage class MUST have the property definitions: 4467
4468
icom_doc:renderedPage 4469
Description: An html page generated from a wiki content. 4470
Required: False 4471
Inherited: False 4472
Property Type: String 4473
Cardinality: Single 4474
Updatability: Read Only 4475
4476
The WikiPage class MAY include additional property definitions which are implementation-defined. 4477
4478
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 136 of 244
4479
Figure 28: Wiki Page Class Diagram. 4480
4481
4.4 Message Module 4482
4.4.1 Message 4483
4.4.1.1 Description 4484
A message is a unit of conversation. It holds a simple content or multipart message contents in a content 4485 property. It has a single sender. 4486
Note: The delivered time is the time when a message is delivered to a given recipient. The user creation 4487 date and time property can be used as the sent date and time of a message. The name property can be 4488 used as the subject of a message. 4489
4.4.1.2 Class Definition 4490
The Message class has attribute values: 4491
4492
localNamespace 4493
Value: icom_msg 4494
4495
localName 4496
Value: Message 4497
4498
extendsFrom 4499
Value: icom_core:Artifact 4500
4501
stereotype 4502
Value: primary 4503
4504
isAbstract 4505
Value: TRUE 4506
4507
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 137 of 244
description 4508
Value: A message is a unit of conversation. 4509
4510
propertyDefinitions 4511
The values for this attribute are defined in Section 4.4.1.3. 4512
4.4.1.3 Property Definitions 4513
The Message class inherits property definitions from super classes. 4514
The Message class MUST have the property definitions: 4515
4516
icom_content:content 4517
Description: Content of a message 4518
Required: False 4519
Inherited: False 4520
Property Type: icom_content:Content 4521
Cardinality: Single 4522
Updatability: Read Write 4523
4524
icom_msg:sender 4525
Description: Sender of a message. 4526
Required: False 4527
Inherited: False 4528
Property Type: icom_core:Participant 4529
Cardinality: Single 4530
Updatability: Read Write 4531
4532
icom_msg:deliveredTime 4533
Description: The date and time when a message is delivered to a given 4534 recipient. 4535
Required: False 4536
Inherited: False 4537
Property Type: DateTime 4538
Cardinality: Single 4539
Updatability: Read Only 4540
4541
The Message class MAY include additional property definitions which are implementation-defined. 4542
4543
4.4.2 UnifiedMessage 4544
4.4.2.1 Description 4545
A unified message is a type of message delivered electronically over a computer, voice, fax, and other 4546 networks. 4547
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 138 of 244
A unified message can be one of these types: 4548
Email is a message delivered electronically over a computer network. 4549
Voice is a message that contains a voice or audio stream. 4550
Fax is a message that contains an image transmitted via phone lines using the fax protocol. 4551
Notification is a type of message sent by applications. 4552
4.4.2.2 Class Definition 4553
The UnifiedMessage class has attribute values: 4554
4555
localNamespace 4556
Value: icom_msg 4557
4558
localName 4559
Value: UnifiedMessage 4560
4561
extendsFrom 4562
Value: icom_msg:Message, icom_content:MimeConvertible 4563
4564
stereotype 4565
Value: primary 4566
4567
description 4568
Value: A unified message is a type of message delivered electronically over a computer, voice, 4569 fax, and other networks. 4570
4571
propertyDefinitions 4572
The values for this attribute are defined in Section 4.4.2.3. 4573
4.4.2.3 Property Definitions 4574
The UnifiedMessage class inherits property definitions from super classes. 4575
The UnifiedMessage class MUST have the property definitions: 4576
4577
icom_core:priority 4578
Description: The priority of a message. 4579
Required: False 4580
Inherited: False 4581
Property Type: icom_core:Priority 4582
Cardinality: Single 4583
Updatability: Read Write 4584
4585
icom_content:contentId 4586
Description: Content id is a unique identifier for a message part in multi-4587 part messages. 4588
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 139 of 244
Required: False 4589
Inherited: False 4590
Property Type: String 4591
Cardinality: Single 4592
Updatability: Read Write 4593
4594
icom_content:mediaType 4595
Description: Media type is a two-part identifier for Internet file formats. 4596
Required: False 4597
Inherited: False 4598
Property Type: String 4599
Cardinality: Single 4600
Updatability: Read Write 4601
4602
icom_content:contentDisposition 4603
Description: Content disposition specifies a presentation style. 4604
Required: False 4605
Inherited: False 4606
Property Type: icom_content:ContentDispositionType 4607
Cardinality: Single 4608
Updatability: Read Write 4609
4610
icom_msg:envelopeSender 4611
Description: An envelope sender is a participant to receive bounced 4612 message. It is also known as return path. 4613
Required: False 4614
Inherited: False 4615
Property Type: icom_core:Participant 4616
Cardinality: Single 4617
Updatability: Read Write 4618
4619
icom_msg:toReceivers 4620
Description: A list of participants to receive a message. 4621
Required: False 4622
Inherited: False 4623
Property Type: icom_core:Participant 4624
Cardinality: Multi 4625
Updatability: Read Write 4626
4627
icom_msg:ccReceivers 4628
Description: A list of participants to receive carbon-copies of a message. 4629
Required: False 4630
Inherited: False 4631
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 140 of 244
Property Type: icom_core:Participant 4632
Cardinality: Multi 4633
Updatability: Read Write 4634
4635
icom_msg:bccReceivers 4636
Description: A list of participants to receive blind-carbon-copies of a 4637 message. 4638
Required: False 4639
Inherited: False 4640
Property Type: icom_core:Participant 4641
Cardinality: Multi 4642
Updatability: Read Write 4643
4644
icom_msg:replyTo 4645
Description: A list of participants to receive a reply message. 4646
Required: False 4647
Inherited: False 4648
Property Type: icom_core:Participant 4649
Cardinality: Multi 4650
Updatability: Read Write 4651
4652
icom_msg:flag 4653
Description: Zero or more flags on a message. 4654
Required: False 4655
Inherited: False 4656
Property Type: icom_msg:UnifiedMessageFlag 4657
Cardinality: Multi 4658
Updatability: Read Write 4659
4660
icom_msg:messageDispositionNotificationRequested 4661
Description: A message disposition notification requested for a message. 4662
Required: False 4663
Inherited: False 4664
Property Type: Boolean 4665
Cardinality: Single 4666
Updatability: Read Write 4667
4668
icom_msg:messageDeliveryStatusNotificationRequest 4669
Description: Indicates the types of delivery status notifications requested 4670 for a message. Default is icom_msg:Failure. 4671
Required: False 4672
Inherited: False 4673
Property Type: icom_msg:UnifiedMessageDeliveryStatusNotificationRequest 4674
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 141 of 244
Cardinality: Multi 4675
Updatability: Read Write 4676
4677
icom_msg:channel 4678
Description: Indicates the delivery channel of a message. 4679
Required: False 4680
Inherited: False 4681
Property Type: icom_msg:UnifiedMessageChannel 4682
Cardinality: Single 4683
Updatability: Read Write 4684
4685
icom_msg:editMode 4686
Description: Indicates an editable mode (new, draft, or delivered) of a 4687 message. 4688
Required: False 4689
Inherited: False 4690
Property Type: icom_msg:UnifiedMessageEditMode 4691
Cardinality: Single 4692
Updatability: Read Only 4693
4694
icom_msg:mimeHeader 4695
Description: A list of headers. Each header is represented by a multi-4696 valued property. 4697
Required: False 4698
Inherited: False 4699
Property Type: icom_meta:Property 4700
Cardinality: Multi 4701
Updatability: Read Write 4702
4703
icom_msg:size 4704
Description: The size of a unified message. 4705
Required: False 4706
Inherited: False 4707
Property Type: Integer 4708
Cardinality: Single 4709
Updatability: Read Only 4710
4711
The UnifiedMessage class MAY include additional property definitions which are implementation-defined. 4712
4713
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 142 of 244
4.4.3 UnifiedMessageParticipant 4714
4.4.3.1 Description 4715
A unified message participant object represents the participation of an addressable entity in a unified 4716 message. 4717
4.4.3.2 Class Definition 4718
The UnifiedMessageParticipant class has attribute values: 4719
4720
localNamespace 4721
Value: icom_msg 4722
4723
localName 4724
Value: UnifiedMessageParticipant 4725
4726
extendsFrom 4727
Value: icom_core:Participant 4728
4729
stereotype 4730
Value: primary 4731
4732
description 4733
Value: A unified message participant object represents the participation of an addressable entity 4734 in a unified message. 4735
4736
propertyDefinitions 4737
The values for this attribute are defined in Section 4.4.3.3. 4738
4.4.3.3 Property Definitions 4739
The UnifiedMessageParticipant class inherits property definitions from super classes. 4740
The UnifiedMessageParticipant class MUST have the property definitions: 4741
4742
icom_msg:fullAddress 4743
Description: Full address of a participant. 4744
Required: False 4745
Inherited: False 4746
Property Type: IRI 4747
Cardinality: Single 4748
Updatability: Read Write 4749
4750
icom_msg:localPart 4751
Description: Local part of a full address. 4752
Required: False 4753
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 143 of 244
Inherited: False 4754
Property Type: String 4755
Cardinality: Single 4756
Updatability: Read Write 4757
4758
icom_msg:domainPart 4759
Description: Domain part of a full address. 4760
Required: False 4761
Inherited: False 4762
Property Type: String 4763
Cardinality: Single 4764
Updatability: Read Write 4765
4766
The UnifiedMessageParticipant class MAY include additional property definitions which are 4767 implementation-defined. 4768
4769
4.4.4 UnifiedMessageFlag 4770
4.4.4.1 Description 4771
A unified message flag is a flag on a message. 4772
4.4.4.2 Class Definition 4773
The UnifiedMessageFlag class is a mixin class which defines a flag on a message. 4774
The UnifiedMessageFlag class has attribute values: 4775
4776
localNamespace 4777
Value: icom_msg 4778
4779
localName 4780
Value: UnifiedMessageFlag 4781
4782
extendsFrom 4783
Value: 4784
4785
stereotype 4786
Value: mixin 4787
4788
description 4789
Value: UnifiedMessageFlag is a mixin class which defines a flag on a message. 4790
4791
propertyDefinitions 4792
The values for this attribute are defined in Section 4.4.4.3. 4793
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 144 of 244
4.4.4.3 Property Definitions 4794
The UnifiedMessageFlag class MAY include additional property definitions which are implementation-4795 defined. 4796
4797
4.4.5 UnifiedMessageFlagEnum 4798
The UnifiedMessageFlagEnum class is an enum class that enumerates the instances each of which 4799 expresses a flag on a message. 4800
The UnifiedMessageFlagEnum class has attribute values: 4801
4802
localNamespace 4803
Value: icom_msg 4804
4805
localName 4806
Value: UnifiedMessageFlagEnum 4807
4808
extendsFrom 4809
Value: icom_msg:UnifiedMessageFlag 4810
4811
stereotype 4812
Value: primary 4813
4814
isEnumeration 4815
Value: TRUE 4816
4817
description 4818
Value: A flag on a message. 4819
4820
instances 4821
Value: <icom_msg:Answered, icom_msg:Forwarded, icom_msg:Redirected, icom_msg:Hidden, 4822 icom_msg:MarkedForDelete, icom_msg:MarkedForFollowUp, icom_msg:MarkedForDraft, 4823 icom_msg:MessageDispositionNotificationProcessed> 4824
4825
ICOM defines eight flags: 4826
icom_msg:Answered a message is answered. 4827
icom_msg:Forwarded a message is forwarded. 4828
icom_msg:Redirected a message is redirected. 4829
icom_msg:Hidden a message is hidden. 4830
icom_msg:MarkedForDelete a message is marked for delete. 4831
icom_msg:MarkedForFollowUp a message is marked for follow up. 4832
icom_msg:MarkedForDraft a message is marked for draft. 4833
icom_msg:MessageDispositionNotificationProcessed a message disposition notification is 4834
processed. 4835
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 145 of 244
4836
4.4.6 UnifiedMessageDeliveryStatusNotificationRequest 4837
4.4.6.1 Description 4838
A unified message delivery status notification request is a directive for notifying a participant of delivery 4839 status of a message. 4840
4.4.6.2 Class Definition 4841
The UnifiedMessageDeliveryStatusNotificationRequest class is a mixin class which defines a directive for 4842 notifying a participant of delivery status of a message. 4843
The UnifiedMessageDeliveryStatusNotificationRequest class has attribute values: 4844
4845
localNamespace 4846
Value: icom_msg 4847
4848
localName 4849
Value: UnifiedMessageDeliveryStatusNotificationRequest 4850
4851
extendsFrom 4852
Value: 4853
4854
stereotype 4855
Value: mixin 4856
4857
description 4858
Value: UnifiedMessageDeliveryStatusNotificationRequest is a mixin class which defines a 4859 directive for notifying a participant of delivery status of a message. 4860
4861
propertyDefinitions 4862
The values for this attribute are defined in Section 4.4.6.3. 4863
4.4.6.3 Property Definitions 4864
The UnifiedMessageDeliveryStatusNotificationRequest class MAY include additional property definitions 4865 which are implementation-defined. 4866
4867
4.4.7 UnifiedMessageDeliveryStatusNotificationRequestEnum 4868
The UnifiedMessageDeliveryStatusNotificationRequestEnum class is an enum class that enumerates the 4869 instances each of which expresses a request for one of several types of delivery status notification. 4870
The UnifiedMessageDeliveryStatusNotificationRequestEnum class has attribute values: 4871
4872
localNamespace 4873
Value: icom_msg 4874
4875
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 146 of 244
localName 4876
Value: UnifiedMessageDeliveryStatusNotificationRequestEnum 4877
4878
extendsFrom 4879
Value: icom_msg:UnifiedMessageDeliveryStatusNotificationRequest 4880
4881
stereotype 4882
Value: primary 4883
4884
isEnumeration 4885
Value: TRUE 4886
4887
description 4888
Value: A request for one of several types of delivery status notification. 4889
4890
instances 4891
Value: <icom_msg:Never, icom_msg:Success, icom_msg:Failure, icom_msg:Delay> 4892
4893
ICOM defines four delivery status notification requests: 4894
icom_msg:Never a sender requests status notification not be returned to the sender under any 4895
condition. 4896
icom_msg:Success a sender requests a status notification for successful delivery of a message. 4897
icom_msg:Failure a sender requests a status notification for delivery failure of a message. 4898
icom_msg:Delay a sender requests a status notification when delivery of a message has been 4899 delayed for an unusual length of time. 4900
4901
4.4.8 UnifiedMessageChannel 4902
4.4.8.1 Description 4903
A message channel used to deliver a unified message. 4904
4.4.8.2 Class Definition 4905
The UnifiedMessageChannel class is a mixin class which defines a channel used to deliver a unified 4906 message. 4907
The UnifiedMessageChannel class has attribute values: 4908
4909
localNamespace 4910
Value: icom_msg 4911
4912
localName 4913
Value: UnifiedMessageChannel 4914
4915
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 147 of 244
extendsFrom 4916
Value: 4917
4918
stereotype 4919
Value: mixin 4920
4921
description 4922
Value: UnifiedMessageChannel is a mixin class which defines a channel used to deliver a 4923 unified message. 4924
4925
propertyDefinitions 4926
The values for this attribute are defined in Section 4.4.8.3. 4927
4.4.8.3 Property Definitions 4928
The UnifiedMessageChannel class MAY include additional property definitions which are implementation-4929 defined. 4930
4931
4.4.9 UnifiedMessageChannelEnum 4932
The UnifiedMessageChannelEnum class is an enum class that enumerates the instances each of which 4933 expresses a type of delivery channel. 4934
The UnifiedMessageChannelEnum class has attribute values: 4935
4936
localNamespace 4937
Value: icom_msg 4938
4939
localName 4940
Value: UnifiedMessageChannelEnum 4941
4942
extendsFrom 4943
Value: icom_msg:UnifiedMessageChannel 4944
4945
stereotype 4946
Value: primary 4947
4948
isEnumeration 4949
Value: TRUE 4950
4951
description 4952
Value: A delivery channel. 4953
4954
instances 4955
Value: <icom_msg:Email, icom_msg:Voice, icom_msg:Fax, icom_msg:Notification> 4956
4957
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 148 of 244
ICOM defines four channel types: 4958
icom_msg:Email delivery channel is email. 4959
icom_msg:Voice delivery channel is voice. 4960
icom_msg:Fax delivery channel is fax. 4961
icom_msg:Notification delivery channel is notification. 4962
4963
4.4.10 UnifiedMessageEditMode 4964
4.4.10.1 Description 4965
A unified message edit mode is a mode that indicates whether a unified message is editable. 4966
4.4.10.2 Class Definition 4967
The UnifiedMessageEditMode class is a mixin class which defines a mode that indicates whether a 4968 unified message is editable. 4969
The UnifiedMessageEditMode class has attribute values: 4970
4971
localNamespace 4972
Value: icom_msg 4973
4974
localName 4975
Value: UnifiedMessageEditMode 4976
4977
extendsFrom 4978
Value: 4979
4980
stereotype 4981
Value: mixin 4982
4983
description 4984
Value: UnifiedMessageEditMode is a mixin class which defines a mode that indicates whether a 4985 unified message is editable. 4986
4987
propertyDefinitions 4988
The values for this attribute are defined in Section 4.4.10.3. 4989
4.4.10.3 Property Definitions 4990
The UnifiedMessageEditMode class MAY include additional property definitions which are 4991 implementation-defined. 4992
4993
4.4.11 UnifiedMessageEditModeEnum 4994
The UnifiedMessageEditModeEnum class is an enum class that enumerates the instances each of which 4995 expresses whether a message is a new copy, saved draft copy, or delivered copy. 4996
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 149 of 244
The UnifiedMessageEditModeEnum class has attribute values: 4997
4998
localNamespace 4999
Value: icom_msg 5000
5001
localName 5002
Value: UnifiedMessageEditModeEnum 5003
5004
extendsFrom 5005
Value: icom_msg:UnifiedMessageEditMode 5006
5007
stereotype 5008
Value: primary 5009
5010
isEnumeration 5011
Value: TRUE 5012
5013
description 5014
Value: A message is a new copy, a saved draft copy, or a delivered copy. New or draft copies 5015 are usually editable while delivered copies are usually not editable. 5016
5017
instances 5018
Value: <icom_msg:NewCopy, icom_msg:DraftCopy, icom_msg:DeliveredCopy> 5019
5020
ICOM defines three modes: 5021
icom_msg:NewCopy a message is a new message. 5022
icom_msg:DraftCopy a message is saved as a draft. 5023
icom_msg:DeliveredCopy a message is a sent or received message. 5024
5025
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 150 of 244
5026
Figure 29: Unified Message Class Diagram. 5027
5028
4.4.12 InstantMessage 5029
4.4.12.1 Description 5030
An instant message is a type of message for synchronous, usually text based, conversation. 5031
4.4.12.2 Class Definition 5032
The InstantMessage class has attribute values: 5033
5034
localNamespace 5035
Value: icom_msg 5036
5037
localName 5038
Value: InstantMessage 5039
5040
extendsFrom 5041
Value: icom_msg:Message 5042
5043
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 151 of 244
stereotype 5044
Value: primary 5045
5046
isAbstract 5047
Value: FALSE 5048
5049
description 5050
Value: An instant message is a type of message for synchronous, usually text based, 5051 conversation. 5052
5053
propertyDefinitions 5054
The values for this attribute are defined in Section 4.4.12.3. 5055
4.4.12.3 Property Definitions 5056
The InstantMessage class inherits property definitions from super classes. 5057
The InstantMessage class MUST have the property definitions: 5058
5059
icom_msg:toReceivers 5060
Description: A list of participants to receive a message. 5061
Required: False 5062
Inherited: False 5063
Property Type: icom_core:Participant 5064
Cardinality: Multi 5065
Updatability: Read Write 5066
5067
icom_msg:conversationId 5068
Description: An identifier of a conversation involving one or more instant 5069 messages. 5070
Required: False 5071
Inherited: False 5072
Property Type: Integer 5073
Cardinality: Single 5074
Updatability: Read Write 5075
5076
icom_msg:clientSideId 5077
Description: An identifier of a client. 5078
Required: False 5079
Inherited: False 5080
Property Type: String 5081
Cardinality: Single 5082
Updatability: Read Write 5083
5084
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 152 of 244
icom_msg:formatingStyle 5085
Description: A style for formatting a rich text message. 5086
Required: False 5087
Inherited: False 5088
Property Type: String 5089
Cardinality: Single 5090
Updatability: Read Write 5091
5092
icom_msg:instantMessageType 5093
Description: A type of instant message. 5094
Required: False 5095
Inherited: False 5096
Property Type: icom_msg:InstantMessageType 5097
Cardinality: Single 5098
Updatability: Read Write 5099
5100
icom_msg:chatStatus 5101
Description: A chat status of a user. 5102
Required: False 5103
Inherited: False 5104
Property Type: icom_msg:InstantMessageChatStatus 5105
Cardinality: Single 5106
Updatability: Read Write 5107
5108
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 153 of 244
5109
Figure 30: Instant Message Class Diagram. 5110
5111
4.4.13 InstantMessageType 5112
4.4.13.1 Description 5113
An instant message type. 5114
4.4.13.2 Class Definition 5115
The InstantMessageType class is a mixin class which defines a type of instant message. 5116
The InstantMessageType class has attribute values: 5117
5118
localNamespace 5119
Value: icom_msg 5120
5121
localName 5122
Value: InstantMessageType 5123
5124
extendsFrom 5125
Value: 5126
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 154 of 244
5127
stereotype 5128
Value: mixin 5129
5130
description 5131
Value: InstantMessageType is a mixin class which defines a type of instant message. 5132
5133
propertyDefinitions 5134
The values for this attribute are defined in Section 4.4.13.3. 5135
4.4.13.3 Property Definitions 5136
The InstantMessageType class MAY include additional property definitions which are implementation-5137 defined. 5138
5139
4.4.14 InstantMessageTypeEnum 5140
The InstantMessageTypeEnum class is an enum class that enumerates the instances each of which 5141 expresses a type of instant message. 5142
The InstantMessageTypeEnum class has attribute values: 5143
5144
localNamespace 5145
Value: icom_msg 5146 5147
localName 5148
Value: InstantMessageTypeEnum 5149
5150
extendsFrom 5151
Value: icom_msg:InstantMessageType 5152
5153
stereotype 5154
Value: primary 5155
5156
isEnumeration 5157
Value: TRUE 5158
5159
description 5160
Value: A type of instant message. 5161
5162
instances 5163
Value: <icom_msg:System, icom_msg:Chat, icom_msg:Broadcast, icom_msg:Gone, 5164 icom_msg:OtherInstantMessageType> 5165
5166
ICOM defines five instant message types: 5167
icom_msg:System an instant message is a system message. 5168
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 155 of 244
icom_msg:Chat an instant message is a chat message. 5169
icom_msg:Broadcast an instant message is a broadcast message. 5170
icom_msg:Gone an instant message is a message indicating that a user is gone. 5171
icom_msg:OtherInstantMessageType an instant message is of other type. 5172
5173
4.4.15 InstantMessageChatStatus 5174
4.4.15.1 Description 5175
An instant message chat status defines a vocabulary of chat status. 5176
4.4.15.2 Class Definition 5177
The InstantMessageChatStatus class is a mixin class which defines a chat status. 5178
The InstantMessageChatStatus class has attribute values: 5179
5180
localNamespace 5181
Value: icom_msg 5182
5183
localName 5184
Value: InstantMessageChatStatus 5185
5186
extendsFrom 5187
Value: 5188
5189
stereotype 5190
Value: mixin 5191
5192
description 5193
Value: InstantMessageChatStatus is a mixin class which defines a chat status. 5194
5195
propertyDefinitions 5196
The values for this attribute are defined in Section 4.4.15.3. 5197
4.4.15.3 Property Definitions 5198
The InstantMessageChatStatus class MAY include additional property definitions which are 5199 implementation-defined. 5200
5201
4.4.16 InstantMessageChatStatusEnum 5202
The InstantMessageChatStatusEnum class is an enum class that enumerates the instances each of 5203 which expresses a chat status of a user. 5204
The InstantMessageChatStatusEnum class has attribute values: 5205
5206
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 156 of 244
localNamespace 5207
Value: icom_msg 5208 5209
localName 5210
Value: InstantMessageChatStatusEnum 5211
5212
extendsFrom 5213
Value: icom_msg:InstantMessageChatStatus 5214
5215
stereotype 5216
Value: primary 5217
5218
isEnumeration 5219
Value: TRUE 5220
5221
description 5222
Value: A chat status of a user. 5223
5224
instances 5225
Value: <icom_msg:Active, icom_msg:Typing, icom_msg:Paused, icom_msg:Inactive, 5226 icom_msg:Gone> 5227
5228
ICOM defines five chat status: 5229
icom_msg:Active a user is active. 5230
icom_msg:Typing a user is typing. 5231
icom_msg:Paused a user has paused. 5232
icom_msg:Inactive a user is inactive. 5233
icom_msg:Gone a user is gone. 5234
5235
4.4.17 InstantMessageFeed 5236
4.4.17.1 Description 5237
An instant message feed contains a set of instant message connections and a queue of outbound instant 5238 messages. 5239
4.4.17.2 Class Definition 5240
The InstantMessageFeed class has attribute values: 5241
5242
localNamespace 5243
Value: icom_msg 5244
5245
localName 5246
Value: InstantMessageFeed 5247
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 157 of 244
5248
extendsFrom 5249
Value: icom_core:Entity 5250
5251
stereotype 5252
Value: primary 5253
5254
description 5255
Value: An instant message feed contains a set of instant message connections and a queue of 5256 outbound instant messages. 5257
5258
propertyDefinitions 5259
The values for this attribute are defined in Section 4.4.17.3. 5260
4.4.17.3 Property Definitions 5261
The InstantMessageFeed class inherits property definitions from super classes. 5262
The InstantMessageFeed class MUST have the property definitions: 5263
5264
icom_msg:connection 5265
Description: One or more instant messaging connections. 5266
Required: False 5267
Inherited: False 5268
Property Type: icom_msg:InstantMessageConnection 5269
Cardinality: Multi 5270
Updatability: Read Only 5271
5272
icom_msg:outboundInstantMessage 5273
Description: Outbound instant messages. 5274
Required: False 5275
Inherited: False 5276
Property Type: icom_msg:InstantMessage 5277
Cardinality: Multi 5278
Updatability: Write Only 5279
5280
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 158 of 244
5281
Figure 31: Instant Message Feed and Connection Class Diagram. 5282
5283
4.4.18 InstantMessageConnection 5284
4.4.18.1 Description 5285
An instant message connection contains queues for inbound instant messages. 5286
A presentity can update the contact status, contact priority, and note for a contact method associated with 5287 a connection. 5288
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 159 of 244
4.4.18.2 Class Definition 5289
The InstantMessageConnection class has attribute values: 5290
5291
localNamespace 5292
Value: icom_msg 5293
5294
localName 5295
Value: InstantMessageConnection 5296
5297
extendsFrom 5298
Value: icom_core:Entity 5299
5300
stereotype 5301
Value: primary 5302
5303
description 5304
Value: An instant message connection contains queues for inbound instant messages. 5305
5306
propertyDefinitions 5307
The values for this attribute are defined in Section 4.4.18.3. 5308
4.4.18.3 Property Definitions 5309
The InstantMessageConnection class inherits property definitions from super classes. 5310
The InstantMessageConnection class MUST have the property definitions: 5311
5312
icom_msg:connectionId 5313
Description: An identifier of a connection. 5314
Required: False 5315
Inherited: False 5316
Property Type: String 5317
Cardinality: Single 5318
Updatability: Read Only 5319
5320
icom_msg:selfAddress 5321
Description: Address of a presentity who opens a connection. 5322
Required: True 5323
Inherited: False 5324
Property Type: IRI 5325
Cardinality: Single 5326
Updatability: On Create 5327
5328
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 160 of 244
icom_msg:selfResourceName 5329
Description: Resource name associated with a connection. 5330
Required: True 5331
Inherited: False 5332
Property Type: String 5333
Cardinality: Single 5334
Updatability: On Create 5335
5336
icom_msg:inboundInstantMessage 5337
Description: Inbound instant messages. 5338
Required: False 5339
Inherited: False 5340
Property Type: icom_msg:InstantMessage 5341
Cardinality: Multi 5342
Updatability: Read Only 5343
5344
icom_presence:contactStatus 5345
Description: Reachability status to be propagated to an associated contact 5346 method in presence. 5347
Required: False 5348
Inherited: False 5349
Property Type: icom_presence:ContactReachabilityStatus 5350
Cardinality: Single 5351
Updatability: Write Only 5352
5353
icom_presence:contactPriority 5354
Description: Priority to be propagated to an associated contact method in 5355 presence. 5356
Required: False 5357
Inherited: False 5358
Property Type: Integer 5359
Cardinality: Single 5360
Updatability: Write Only 5361
5362
icom_presence:note 5363
Description: Note to be propagated to an associated contact method in 5364 presence. 5365
Required: False 5366
Inherited: False 5367
Property Type: String 5368
Cardinality: Single 5369
Updatability: Write Only 5370
5371
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 161 of 244
4.5 Presence Module 5372
4.5.1 Presence 5373
4.5.1.1 Description 5374
A presence describes the contact methods and activities of a presentity. 5375
It provides a list of contact methods describing how to contact a presentity. A viewer may choose any one 5376 of the contact methods based on circumstances. 5377
It includes a list of activities describing what a presentity is doing. 5378
4.5.1.2 Class Definition 5379
The Presence class has attribute values: 5380
5381
localNamespace 5382
Value: icom_presence 5383
5384
localName 5385
Value: Presence 5386
5387
extendsFrom 5388
Value: icom_core:Identifiable 5389
5390
stereotype 5391
Value: primary 5392
5393
description 5394
Value: A presence describes the contact methods and activities of a presentity. 5395
5396
propertyDefinitions 5397
The values for this attribute are defined in Section 4.5.1.3. 5398
4.5.1.3 Property Definitions 5399
The Presence class inherits property definitions from super classes. 5400
The Presence class MUST have the property definitions: 5401
5402
icom_core:lastModificationDate 5403
Description: Last modification date and time of information in a presence. 5404
Required: False 5405
Inherited: False 5406
Property Type: DateTime 5407
Cardinality: Single 5408
Updatability: Read Only 5409
5410
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 162 of 244
icom_core:location 5411
Description: Location of a presentity. 5412
Required: False 5413
Inherited: False 5414
Property Type: icom_core:Location 5415
Cardinality: Single 5416
Updatability: Read Only 5417
5418
icom_presence:editMode 5419
Description: Indicates a mode which determines whether a presence is 5420 editable. 5421
Required: False 5422
Inherited: False 5423
Property Type: icom_presence:PresenceEditMode 5424
Cardinality: Single 5425
Updatability: Read Only 5426
5427
icom_presence:contactMethod 5428
Description: A collection of contact methods describing how to contact a 5429 presentity. A viewer may choose any one of the contact 5430 methods based on circumstances. 5431
Required: False 5432
Inherited: False 5433
Property Type: icom_presence:ContactMethod 5434
Cardinality: Multi 5435
Updatability: Read Only 5436
5437
icom_presence:activity 5438
Description: A collection of activities describing what a presentity is doing. 5439
Required: False 5440
Inherited: False 5441
Property Type: icom_presence:Activity 5442
Cardinality: Multi 5443
Updatability: Read Only 5444
5445
The Presence class MAY include additional property definitions which are implementation-defined. 5446
5447
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 163 of 244
5448
Figure 32: Presence Class Diagram. 5449
5450
4.5.2 PresenceEditMode 5451
4.5.2.1 Description 5452
A presence edit mode is a mode that indicates whether a presence is editable. 5453
4.5.2.2 Class Definition 5454
The PresenceEditMode class is a mixin class which defines a mode that indicates whether a presence is 5455 editable. 5456
The PresenceEditMode class has attribute values: 5457
5458
localNamespace 5459
Value: icom_presence 5460
5461
localName 5462
Value: PresenceEditMode 5463
5464
extendsFrom 5465
Value: 5466
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 164 of 244
5467
stereotype 5468
Value: mixin 5469
5470
description 5471
Value: PresenceEditMode is a mixin class which defines a mode that indicates whether a 5472 presence is editable. 5473
5474
propertyDefinitions 5475
The values for this attribute are defined in Section 4.5.2.3. 5476
4.5.2.3 Property Definitions 5477
The PresenceEditMode class MAY include additional property definitions which are implementation-5478 defined. 5479
5480
4.5.3 PresenceEditModeEnum 5481
The PresenceEditModeEnum class is an enum class that enumerates the instances each of which 5482 expresses a mode that indicates whether a presence is editable. 5483
The PresenceEditModeEnum class has attribute values: 5484
5485
localNamespace 5486
Value: icom_presence 5487 5488
localName 5489
Value: PresenceEditModeEnum 5490
5491
extendsFrom 5492
Value: icom_presence:PresenceEditMode 5493
5494
stereotype 5495
Value: primary 5496
5497
isEnumeration 5498
Value: TRUE 5499
5500
description 5501
Value: A mode that indicates whether a presence is editable. 5502
5503
instances 5504
Value: <icom_presence:PresentityCopy, icom_presence:ViewerCopy> 5505
5506
ICOM defines two presence editable modes: 5507
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 165 of 244
icom_presence:PresentityCopy a presence is a copy belonging to a presentity who may update 5508 the properties such as activities. 5509
icom_presence:ViewerCopy a presence is a copy visible to a subscriber who may not update 5510 the properties. 5511
5512
4.5.4 ContactMethod 5513
4.5.4.1 Description 5514
A contact method object describes reachability circumstances of a presentity. 5515
4.5.4.2 Class Definition 5516
The ContactMethod class has attribute values: 5517
5518
localNamespace 5519
Value: icom_presence 5520
5521
localName 5522
Value: ContactMethod 5523
5524
extendsFrom 5525
Value: 5526
5527
stereotype 5528
Value: primary 5529
5530
description 5531
Value: A contact method object describes reachability circumstances of a presentity. 5532
5533
propertyDefinitions 5534
The values for this attribute are defined in Section 4.5.4.3 5535
4.5.4.3 Property Definitions 5536
The ContactMethod class MUST have the property definitions: 5537
5538
icom_core:creationDate 5539
Description: Creation date and time of information in a contact method. 5540
Required: False 5541
Inherited: False 5542
Property Type: DateTime 5543
Cardinality: Single 5544
Updatability: Read Only 5545
5546
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 166 of 244
icom_core:lastModificationDate 5547
Description: Last modification date and time of information in a contact 5548 method. 5549
Required: False 5550
Inherited: False 5551
Property Type: DateTime 5552
Cardinality: Single 5553
Updatability: Read Only 5554
5555
icom_presence:activeConnectionId 5556
Description: A list of active connection ids of a presentity. 5557
Required: False 5558
Inherited: False 5559
Property Type: String 5560
Cardinality: Multi 5561
Updatability: Read Only 5562
5563
icom_presence:contactEndpoint 5564
Description: A list of endpoints or IRIs for contacting a presentity. 5565
Required: False 5566
Inherited: False 5567
Property Type: String 5568
Cardinality: Multi 5569
Updatability: Read Only 5570
5571
icom_presence:contactPriority 5572
Description: Priority of a contact method relative to other contact methods 5573 in a presence. 5574
Required: False 5575
Inherited: False 5576
Property Type: Integer 5577
Cardinality: Single 5578
Updatability: Read Only 5579
5580
icom_presence:contactStatus 5581
Description: Status of a contact method in a presence. 5582
Required: False 5583
Inherited: False 5584
Property Type: icom_presence:ContactReachabilityStatus 5585
Cardinality: Single 5586
Updatability: Read Only 5587
5588
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 167 of 244
icom_presence:note 5589
Description: A note about contacting a presentity. 5590
Required: False 5591
Inherited: False 5592
Property Type: String 5593
Cardinality: Single 5594
Updatability: Read Only 5595
5596
4.5.5 ContactReachabilityStatus 5597
4.5.5.1 Description 5598
A contact reachability status is a status of a contact method. 5599
4.5.5.2 Class Definition 5600
The ContactReachabilityStatus class is a mixin class which defines a status of a contact method. 5601
The ContactReachabilityStatus class has attribute values: 5602
5603
localNamespace 5604
Value: icom_presence 5605
5606
localName 5607
Value: ContactReachabilityStatus 5608
5609
extendsFrom 5610
Value: 5611
5612
stereotype 5613
Value: mixin 5614
5615
description 5616
Value: ContactReachabilityStatus is a mixin class which defines a status of a contact method. 5617
5618
propertyDefinitions 5619
The values for this attribute are defined in Section 4.5.5.3. 5620
4.5.5.3 Property Definitions 5621
The ContactReachabilityStatus class MAY include additional property definitions which are 5622 implementation-defined. 5623
5624
4.5.6 ContactReachabilityStatusEnum 5625
The ContactReachabilityStatusEnum class is an enum class that enumerates the instances each of which 5626 expresses a reachability status of a contact method. 5627
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 168 of 244
The ContactReachabilityStatusEnum class has attribute values: 5628
5629
localNamespace 5630
Value: icom_presence 5631 5632
localName 5633
Value: ContactReachabilityStatusEnum 5634
5635
extendsFrom 5636
Value: icom_presence:ContactReachabilityStatus 5637
5638
stereotype 5639
Value: primary 5640
5641
isEnumeration 5642
Value: TRUE 5643
5644
description 5645
Value: A reachability status of a contact method. 5646
5647
instances 5648
Value: <icom_presence:Reachable, icom_presence:NotReachable, icom_presence:Chatty, 5649 icom_presence:Away, icom_presence:ExtendedAway, icom_presence:DoNotDisturb> 5650
5651
ICOM defines six reachability status: 5652
icom_presence:Reachable a presentity is reachable through a contact method. 5653
icom_presence:NotReachable a presentity is not reachable through a contact method. 5654
icom_presence:Chatty a presentity is chatty. 5655
icom_presence:Away a presentity is away. 5656
icom_presence:ExtendedAway a presentity is away for an extended period. 5657
icom_presence:DoNotDisturb a presentity prefers not to be disturbed. 5658
5659
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 169 of 244
5660
Figure 33: Presence Contact Method and Instant Message Connection Class Diagram. 5661
5662
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 170 of 244
4.5.7 Activity 5663
4.5.7.1 Description 5664
An activity object describes what a presentity is doing. 5665
4.5.7.2 Class Definition 5666
The Activity class has attribute values: 5667
5668
localNamespace 5669
Value: icom_presence 5670
5671
localName 5672
Value: Activity 5673
5674
extendsFrom 5675
Value: 5676
5677
stereotype 5678
Value: primary 5679
5680
description 5681
Value: An activity object describes what a presentity is doing. 5682
5683
propertyDefinitions 5684
The values for this attribute are defined in Section 4.5.7.3. 5685
4.5.7.3 Property Definitions 5686
The Activity class MUST have the property definitions: 5687
5688
icom_core:startDate 5689
Description: Start date and time of an activity. 5690
Required: True 5691
Inherited: False 5692
Property Type: DateTime 5693
Cardinality: Single 5694
Updatability: Read Write 5695
5696
icom_core:endDate 5697
Description: End date and time of an activity. 5698
Required: True 5699
Inherited: False 5700
Property Type: DateTime 5701
Cardinality: Single 5702
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 171 of 244
Updatability: Read Write 5703
5704
icom_presence:activityType 5705
Description: Type of an activity. 5706
Required: true 5707
Inherited: False 5708
Property Type: icom_presence:ActivityType 5709
Cardinality: Single 5710
Updatability: Read Write 5711
5712
icom_presence:note 5713
Description: A note describing an activity. 5714
Required: False 5715
Inherited: False 5716
Property Type: String 5717
Cardinality: Single 5718
Updatability: Read Write 5719
5720
icom_presence:reference 5721
Description: An entity, such as occurrence, task, conference, etc., which is 5722 the source of or reference for an activity. 5723
Required: False 5724
Inherited: False 5725
Property Type: icom_core:Entity 5726
Cardinality: Single 5727
Updatability: Read Write 5728
5729
4.5.8 ActivityType 5730
4.5.8.1 Description 5731
An activity type is a vocabulary of activities for rich presence information model. 5732
4.5.8.2 Class Definition 5733
The ActivityType class is a mixin class which defines an activity. 5734
The ActivityType class has attribute values: 5735
5736
localNamespace 5737
Value: icom_presence 5738
5739
localName 5740
Value: ActivityType 5741
5742
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 172 of 244
extendsFrom 5743
Value: 5744
5745
stereotype 5746
Value: mixin 5747
5748
description 5749
Value: ActivityType is a mixin class which defines a type of activity. 5750
5751
propertyDefinitions 5752
The values for this attribute are defined in Section 4.5.8.3. 5753
4.5.8.3 Property Definitions 5754
The ActivityType class MAY include additional property definitions which are implementation-defined. 5755
5756
4.5.9 ActivityTypeEnum 5757
The ActivityTypeEnum class is an enum class that enumerates the instances each of which expresses a 5758 type of activity. 5759
The ActivityTypeEnum class has attribute values: 5760
5761
localNamespace 5762
Value: icom_presence 5763 5764
localName 5765
Value: ActivityTypeEnum 5766
5767
extendsFrom 5768
Value: icom_presence:ActivityType 5769
5770
stereotype 5771
Value: primary 5772
5773
isEnumeration 5774
Value: TRUE 5775
5776
description 5777
Value: A type of activity. 5778
5779
instances 5780
Value: <icom_presence:OnThePhone, icom_presence:Conference, icom_presence:Meeting, 5781 icom_presence:Travel, icom_presence:Steering, icom_presence:Meal, 5782 icom_presence:OutOfOffice, icom_presence:Holiday, icom_presence:Vacation, 5783 icom_presence:OutOfContact, icom_presence:OtherActivityType> 5784
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 173 of 244
5785
ICOM defines eleven activity types: 5786
icom_presence:OnThePhone a presentity is on the phone. 5787
icom_presence:Conference a presentity is in a conference. 5788
icom_presence:Meeting a presentity is in a meeting. 5789
icom_presence:Travel a presentity is traveling. 5790
icom_presence:Steering a presentity is steering a vehicle. 5791
icom_presence:Meal a presentity is having a meal. 5792
icom_presence:OutOfOffice a presentity is out of office. 5793
icom_presence:Holiday a presentity is on holiday. 5794
icom_presence:Vacation a presentity is on vacation. 5795
icom_presence:OutOfContact a presentity is out of contact. 5796
icom_presence:OtherActivityType a presentity is involved in an unspecified activity. 5797
5798
4.6 Address Book Module 5799
4.6.1 AddressBook 5800
4.6.1.1 Description 5801
An address book is a folder that contains sub-address books and addressable contacts. 5802
4.6.1.2 Class Definition 5803
The AddressBook class has attribute values: 5804
5805
localNamespace 5806
Value: icom_card 5807
5808
localName 5809
Value: AddressBook 5810
5811
extendsFrom 5812
Value: icom_core:Folder 5813
5814
stereotype 5815
Value: primary 5816
5817
description 5818
Value: An address book is a folder that contains sub-address books and addressable contacts. 5819
5820
propertyDefinitions 5821
The values for this attribute are defined in Section 4.6.1.3. 5822
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 174 of 244
4.6.1.3 Property Definitions 5823
The AddressBook class inherits property definitions from super classes. 5824
The AddressBook class MUST have the property definitions: 5825
5826
icom_card:addressBook 5827
Description: Sub-address books in an address book. 5828
Required: False 5829
Inherited: False 5830
Property Type: icom_card:AddressBook 5831
Cardinality: Multi 5832
Updatability: Read Only 5833
5834
icom_card:contact 5835
Description: Contacts in an address book. 5836
Required: False 5837
Inherited: False 5838
Property Type: icom_card:PersonContact 5839
Cardinality: Multi 5840
Updatability: Read Only 5841
5842
The AddressBook class MAY include additional property definitions which are implementation-defined. 5843
5844
5845
Figure 34: Address Book Class Diagram. 5846
5847
4.6.2 PersonContact 5848
4.6.2.1 Description 5849
A person contact is an artifact that contains address information about a person. 5850
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 175 of 244
4.6.2.2 Class Definition 5851
The PersonContact class has attribute values: 5852
5853
localNamespace 5854
Value: icom_card 5855
5856
localName 5857
Value: PersonContact 5858
5859
extendsFrom 5860
Value: icom_core:Artifact, icom_core:Addressable 5861
5862
stereotype 5863
Value: primary 5864
5865
description 5866
Value: A person contact is an artifact that contains address information about a person. 5867
5868
propertyDefinitions 5869
The values for this attribute are defined in Section 4.6.2.3. 5870
4.6.2.3 Property Definitions 5871
The PersonContact class inherits property definitions from super classes. 5872
The PersonContact class MUST have the property definitions: 5873
5874
icom_core:timeZone 5875
Description: Time zone of a person. 5876
Required: False 5877
Inherited: False 5878
Property Type: icom_core:TimeZone 5879
Cardinality: Single 5880
Updatability: Read Write 5881
5882
icom_core:givenName 5883
Description: Given name of a person. 5884
Required: False 5885
Inherited: False 5886
Property Type: String 5887
Cardinality: Single 5888
Updatability: Read Write 5889
5890
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 176 of 244
icom_core:middleName 5891
Description: Middle name of a person. Can include multiple names 5892 concatenated. 5893
Required: False 5894
Inherited: False 5895
Property Type: String 5896
Cardinality: Single 5897
Updatability: Read Write 5898
5899
icom_core:familyName 5900
Description: Family name of a person. 5901
Required: False 5902
Inherited: False 5903
Property Type: String 5904
Cardinality: Single 5905
Updatability: Read Write 5906
5907
icom_core:prefix 5908
Description: Prefix of a person’s name. 5909
Required: False 5910
Inherited: False 5911
Property Type: String 5912
Cardinality: Single 5913
Updatability: Read Write 5914
5915
icom_core:suffix 5916
Description: Suffix of a person’s name. 5917
Required: False 5918
Inherited: False 5919
Property Type: String 5920
Cardinality: Single 5921
Updatability: Read Write 5922
5923
icom_core:nickname 5924
Description: Nickname of a person. 5925
Required: False 5926
Inherited: False 5927
Property Type: String 5928
Cardinality: Multi 5929
Updatability: Read Write 5930
5931
icom_core:jobTitle 5932
Description: Job title of a person. 5933
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 177 of 244
Required: False 5934
Inherited: False 5935
Property Type: String 5936
Cardinality: Single 5937
Updatability: Read Write 5938
5939
icom_core:department 5940
Description: A person’s affiliated department. 5941
Required: False 5942
Inherited: False 5943
Property Type: String 5944
Cardinality: Single 5945
Updatability: Read Write 5946
5947
icom_core:officeLocation 5948
Description: Location of a person’s department. 5949
Required: False 5950
Inherited: False 5951
Property Type: String 5952
Cardinality: Single 5953
Updatability: Read Write 5954
5955
icom_core:company 5956
Description: A person’s affiliated company. 5957
Required: False 5958
Inherited: False 5959
Property Type: String 5960
Cardinality: Single 5961
Updatability: Read Write 5962
5963
icom_core:profession 5964
Description: A person’s profession. 5965
Required: False 5966
Inherited: False 5967
Property Type: String 5968
Cardinality: Single 5969
Updatability: Read Write 5970
5971
icom_content:attachment 5972
Description: One or more content attachments in a contact. 5973
Required: False 5974
Inherited: False 5975
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 178 of 244
Property Type: icom_content:AttachedItem 5976
Cardinality: Multi 5977
Updatability: Read Write 5978
5979
icom_card:bookmark 5980
Description: A person which is bookmarked by a contact. 5981
Required: False 5982
Inherited: False 5983
Property Type: icom_core:Person 5984
Cardinality: Single 5985
Updatability: On Create 5986
5987
The PersonContact class MAY include additional property definitions which are implementation-defined. 5988
5989
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 179 of 244
5990
Figure 35: Person Contact Class Diagram. 5991
5992
4.7 Calendar Module 5993
4.7.1 Calendar 5994
4.7.1.1 Description 5995
A calendar contains time management artifacts that include occurrences and occurrence series. 5996
4.7.1.2 Class Definition 5997
The Calendar class has attribute values: 5998
5999
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 180 of 244
localNamespace 6000
Value: icom_cal 6001
6002
localName 6003
Value: Calendar 6004
6005
extendsFrom 6006
Value: icom_core:Folder 6007
6008
stereotype 6009
Value: primary 6010
6011
description 6012
Value: A calendar contains time management artifacts that include occurrences and occurrence 6013 series. 6014
6015
propertyDefinitions 6016
The values for this attribute are defined in 4.7.1.3. 6017
4.7.1.3 Property Definitions 6018
The Calendar class inherits property definitions from super classes. 6019
The Calendar class MUST have the property definitions: 6020
6021
icom_core:timeZone 6022
Description: Time zone setting for a calendar. 6023
Required: True 6024
Inherited: False 6025
Property Type: icom_core:TimeZone 6026
Cardinality: Single 6027
Updatability: Read Write 6028
6029
icom_core:element 6030
Description: Elements of a calendar. 6031
Required: False 6032
Inherited: True 6033
Property Type: icom_cal:Occurrence 6034
Cardinality: Multi 6035
Updatability: Read Only 6036
6037
icom_cal:recurrence 6038
Description: Occurrence series of a calendar. 6039
Required: False 6040
Inherited: False 6041
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 181 of 244
Property Type: icom_cal:OccurrenceSeries 6042
Cardinality: Multi 6043
Updatability: Read Only 6044
6045
6046
Figure 36: Calendar Class Diagram. 6047
6048
4.7.2 OccurrenceSeries 6049
4.7.2.1 Description 6050
An occurrence series represents a series of occurrences associated with the same calendar event. 6051
4.7.2.2 Class Definition 6052
The OccurrenceSeries class has attribute values: 6053
6054
localNamespace 6055
Value: icom_cal 6056
6057
localName 6058
Value: OccurrenceSeries 6059
6060
extendsFrom 6061
Value: icom_core:Artifact 6062
6063
stereotype 6064
Value: primary 6065
6066
description 6067
Value: An occurrence series represents a series of occurrences associated with the same 6068 calendar event. 6069
6070
propertyDefinitions 6071
The values for this attribute are defined in 4.7.2.3. 6072
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 182 of 244
4.7.2.3 Property Definitions 6073
The OccurrenceSeries class inherits property definitions from super classes. 6074
The OccurrenceSeries class MUST have the property definitions: 6075
6076
icom_core:location 6077
Description: Location of an occurrence series. 6078
Required: False 6079
Inherited: False 6080
Property Type: icom_core:Location 6081
Cardinality: Single 6082
Updatability: Read Write 6083
6084
icom_core:organizer 6085
Description: Organizer of an occurrence series. 6086
Required: True 6087
Inherited: False 6088
Property Type: icom_core:Participant 6089
Cardinality: Single 6090
Updatability: On Create 6091
6092
icom_core:participant 6093
Description: Participants in an occurrence series. 6094
Required: False 6095
Inherited: False 6096
Property Type: icom_cal:OccurrenceParticipant 6097
Cardinality: Multi 6098
Updatability: Read Write 6099
6100
icom_core:priority 6101
Description: Priority for an attendee of an occurrence series. 6102
Required: False 6103
Inherited: False 6104
Property Type: icom_core:Priority 6105
Cardinality: Single 6106
Updatability: Read Write 6107
6108
icom_content:attachment 6109
Description: One or more content attachments in an occurrence series. 6110
Required: False 6111
Inherited: False 6112
Property Type: icom_content:AttachedItem 6113
Cardinality: Multi 6114
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 183 of 244
Updatability: Read Write 6115
6116
icom_cal:recurrenceStartDate 6117
Description: Start date and time of an occurrence series. 6118
Required: True 6119
Inherited: False 6120
Property Type: DateTime 6121
Cardinality: Single 6122
Updatability: On Create 6123
6124
icom_cal:recurrenceStartDateResolution 6125
Description: Resolution of start date and time of an occurrence series. 6126
Required: True 6127
Inherited: False 6128
Property Type: icom_core:DateTimeResolution 6129
Cardinality: Single 6130
Updatability: On Create 6131
6132
icom_cal:duration 6133
Description: Duration of each occurrence in an occurrence series. 6134
Required: True 6135
Inherited: False 6136
Property Type: Duration 6137
Cardinality: Single 6138
Updatability: On Create 6139
6140
icom_cal:recurrenceRule 6141
Description: A recurrence rule of an occurrence series. 6142
Required: True 6143
Inherited: False 6144
Property Type: String 6145
Cardinality: Single 6146
Updatability: On Create 6147
6148
icom_cal:occurrenceStatus 6149
Description: Status of an occurrence series. 6150
Required: True 6151
Inherited: False 6152
Property Type: icom_cal:OccurrenceStatus 6153
Cardinality: Single 6154
Updatability: Read Write 6155
6156
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 184 of 244
icom_cal:occurrenceType 6157
Description: Type of an occurrence series. 6158
Required: True 6159
Inherited: False 6160
Property Type: icom_cal:OccurrenceType 6161
Cardinality: Single 6162
Updatability: Read Write 6163
6164
icom_cal:editMode 6165
Description: Indicates a mode which determines whether an occurrence 6166 series is editable. 6167
Required: False 6168
Inherited: False 6169
Property Type: icom_cal:OccurrenceEditMode 6170
Cardinality: Single 6171
Updatability: Read Only 6172
6173
icom_cal:occurrence 6174
Description: Occurrences in an occurrence series. 6175
Required: False 6176
Inherited: False 6177
Property Type: icom_cal:Occurrence 6178
Cardinality: Multi 6179
Updatability: Read Only 6180
6181
icom_cal:attendee 6182
Description: An attendee of an occurrence series. 6183
Required: False 6184
Inherited: False 6185
Property Type: icom_core:Participant 6186
Cardinality: Single 6187
Updatability: Read Only 6188
6189
icom_cal:attendeeParticipantStatus 6190
Description: Participation status for an attendee of an occurrence series. 6191
Required: False 6192
Inherited: False 6193
Property Type: icom_cal:OccurrenceParticipantStatus 6194
Cardinality: Single 6195
Updatability: Read Write 6196
6197
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 185 of 244
icom_cal:transparency 6198
Description: Participant transparency for an attendee of an occurrence 6199 series. 6200
Required: False 6201
Inherited: False 6202
Property Type: icom_cal:OccurrenceParticipantTransparency 6203
Cardinality: Single 6204
Updatability: Read Write 6205
6206
icom_cal:attendeeProperty 6207
Description: Extensible properties for an attendee of an occurrence series. 6208
Required: False 6209
Inherited: False 6210
Property Type: icom_meta:Property 6211
Cardinality: Multi 6212
Updatability: Read Write 6213
6214
icom_conf:conference 6215
Description: One or more conferences for an occurrence series. 6216
Required: False 6217
Inherited: False 6218
Property Type: icom_conf:Conference 6219
Cardinality: Multi 6220
Updatability: Read Write 6221
6222
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 186 of 244
6223
Figure 37: Occurrence Series Class Diagram. 6224
6225
4.7.3 Occurrence 6226
4.7.3.1 Description 6227
An occurrence represents an event in a calendar. 6228
4.7.3.2 Class Definition 6229
The Occurrence class has attribute values: 6230
6231
localNamespace 6232
Value: icom_cal 6233
6234
localName 6235
Value: Occurrence 6236
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 187 of 244
6237
extendsFrom 6238
Value: icom_core:Artifact 6239
6240
stereotype 6241
Value: primary 6242
6243
description 6244
Value: An occurrence represents an event in a calendar. 6245
6246
propertyDefinitions 6247
The values for this attribute are defined in 4.7.3.3. 6248
6249
4.7.3.3 Property Definitions 6250
The Occurrence class inherits property definitions from super classes. 6251
The Occurrence class MUST have the property definitions: 6252
6253
icom_core:location 6254
Description: Location of an occurrence. 6255
Required: False 6256
Inherited: False 6257
Property Type: icom_core:Location 6258
Cardinality: Single 6259
Updatability: Read Write 6260
6261
icom_core:organizer 6262
Description: Organizer of an occurrence. 6263
Required: True 6264
Inherited: False 6265
Property Type: icom_core:Participant 6266
Cardinality: Single 6267
Updatability: On Create 6268
6269
icom_core:participant 6270
Description: Participants of an occurrence. 6271
Required: False 6272
Inherited: False 6273
Property Type: icom_cal:OccurrenceParticipant 6274
Cardinality: Multi 6275
Updatability: Read Write 6276
6277
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 188 of 244
icom_core:priority 6278
Description: Priority for an attendee of an occurrence. 6279
Required: False 6280
Inherited: False 6281
Property Type: icom_core:Priority 6282
Cardinality: Single 6283
Updatability: Read Write 6284
6285
icom_core:startDate 6286
Description: Start date and time of an occurrence. 6287
Required: True 6288
Inherited: False 6289
Property Type: DateTime 6290
Cardinality: Single 6291
Updatability: On Create 6292
6293
icom_core:startDateResolution 6294
Description: Resolution of start date and time of an occurrence. 6295
Required: True 6296
Inherited: False 6297
Property Type: icom_core:DateTimeResolution 6298
Cardinality: Single 6299
Updatability: On Create 6300
6301
icom_core:endDate 6302
Description: End date and time of an occurrence. 6303
Required: True 6304
Inherited: False 6305
Property Type: DateTime 6306
Cardinality: Single 6307
Updatability: On Create 6308
6309
icom_core:endDateResolution 6310
Description: Resolution of end date and time of an occurrence. 6311
Required: True 6312
Inherited: False 6313
Property Type: icom_core:DateTimeResolution 6314
Cardinality: Single 6315
Updatability: On Create 6316
6317
icom_content:attachment 6318
Description: One or more content attachments in an occurrence. 6319
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 189 of 244
Required: False 6320
Inherited: False 6321
Property Type: icom_content:AttachedItem 6322
Cardinality: Multi 6323
Updatability: Read Write 6324
6325
icom_cal:occurrenceSeries 6326
Description: An occurrence is part of this occurrence series. 6327
Required: False 6328
Inherited: False 6329
Property Type: icom_cal:OccurrenceSeries 6330
Cardinality: Single 6331
Updatability: Read Only 6332
6333
icom_cal:fromRecurringOccurrenceSeries 6334
Description: Occurrence is part of a recurring occurrence series. 6335
Required: False 6336
Inherited: False 6337
Property Type: Boolean 6338
Cardinality: Single 6339
Updatability: Read Only 6340
6341
icom_cal:exceptionToOccurrenceSeries 6342
Description: Occurrence is an exception to an occurrence series. 6343
Required: False 6344
Inherited: False 6345
Property Type: Boolean 6346
Cardinality: Single 6347
Updatability: Read Only 6348
6349
icom_cal:occurrenceStatus 6350
Description: Status of an occurrence. 6351
Required: True 6352
Inherited: False 6353
Property Type: icom_cal:OccurrenceStatus 6354
Cardinality: Single 6355
Updatability: Read Write 6356
6357
icom_cal:occurrenceType 6358
Description: Type of an occurrence. 6359
Required: True 6360
Inherited: False 6361
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 190 of 244
Property Type: icom_cal:OccurrenceType 6362
Cardinality: Single 6363
Updatability: Read Write 6364
6365
icom_cal:editMode 6366
Description: Indicates a mode which determines whether an occurrence is 6367 editable. 6368
Required: False 6369
Inherited: False 6370
Property Type: icom_cal:OccurrenceEditMode 6371
Cardinality: Single 6372
Updatability: Read Only 6373
6374
icom_cal:attendee 6375
Description: An attendee of an occurrence. 6376
Required: False 6377
Inherited: False 6378
Property Type: icom_core:Participant 6379
Cardinality: Single 6380
Updatability: Read Only 6381
6382
icom_cal:attendeeParticipantStatus 6383
Description: Status for an attendee of an occurrence. 6384
Required: False 6385
Inherited: False 6386
Property Type: icom_cal:OccurrenceParticipantStatus 6387
Cardinality: Single 6388
Updatability: Read Write 6389
6390
icom_cal:transparency 6391
Description: Transparency for an attendee of an occurrence. 6392
Required: False 6393
Inherited: False 6394
Property Type: icom_cal:OccurrenceParticipantTransparency 6395
Cardinality: Single 6396
Updatability: Read Write 6397
6398
icom_cal:attendeeProperty 6399
Description: Extensible properties for an attendee of an occurrence. 6400
Required: False 6401
Inherited: False 6402
Property Type: icom_meta:Property 6403
Cardinality: Multi 6404
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 191 of 244
Updatability: Read Write 6405
6406
icom_conf:conference 6407
Description: One or more conferences for an occurrence. 6408
Required: False 6409
Inherited: False 6410
Property Type: icom_conf:Conference 6411
Cardinality: Multi 6412
Updatability: Read Write 6413
6414
6415
Figure 38: Occurrence Class Diagram. 6416
6417
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 192 of 244
4.7.4 OccurrenceStatus 6418
4.7.4.1 Description 6419
An occurrence status is a status of a calendar occurrence. 6420
4.7.4.2 Class Definition 6421
The OccurrenceStatus class is a mixin class which defines status of a calendar occurrence. 6422
The OccurrenceStatus class has attribute values: 6423
6424
localNamespace 6425
Value: icom_cal 6426
6427
localName 6428
Value: OccurrenceStatus 6429
6430
extendsFrom 6431
Value: 6432
6433
stereotype 6434
Value: mixin 6435
6436
description 6437
Value: OccurrenceStatus is a mixin class which defines status of a calendar occurrence. 6438
6439
propertyDefinitions 6440
The values for this attribute are defined in Section 4.7.4.3. 6441
4.7.4.3 Property Definitions 6442
The OccurrenceStatus class MAY include additional property definitions which are implementation-6443 defined. 6444
6445
4.7.5 OccurrenceStatusEnum 6446
The OccurrenceStatusEnum class is an enum class that enumerates the instances each of which 6447 expresses a status of an occurrence or occurrence series. 6448
The OccurrenceStatusEnum class has attribute values: 6449
6450
localNamespace 6451
Value: icom_cal 6452 6453
localName 6454
Value: OccurrenceStatusEnum 6455
6456
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 193 of 244
extendsFrom 6457
Value: icom_cal:OccurrenceStatus 6458
6459
stereotype 6460
Value: primary 6461
6462
isEnumeration 6463
Value: TRUE 6464
6465
description 6466
Value: Status of an occurrence or occurrence series. 6467
6468
instances 6469
Value: <icom_cal:Cancelled, icom_cal:Tentative, icom_cal:Confirmed> 6470
6471
ICOM defines three occurrence status: 6472
icom_cal:Cancelled an occurrence or occurrence series is cancelled. 6473
icom_cal:Tentative an occurrence or occurrence series is tentative. 6474
icom_cal:Confirmed an occurrence or occurrence series is confirmed. 6475
6476
4.7.6 OccurrenceType 6477
4.7.6.1 Description 6478
An occurrence type is a category of calendar occurrences. 6479
4.7.6.2 Class Definition 6480
The OccurrenceType class is a mixin class which defines a type of occurrence. 6481
The OccurrenceType class has attribute values: 6482
6483
localNamespace 6484
Value: icom_cal 6485
6486
localName 6487
Value: OccurrenceType 6488
6489
extendsFrom 6490
Value: 6491
6492
stereotype 6493
Value: mixin 6494
6495
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 194 of 244
description 6496
Value: OccurrenceType is a mixin class which defines a type of occurrence. 6497
6498
propertyDefinitions 6499
The values for this attribute are defined in Section 4.7.6.3. 6500
4.7.6.3 Property Definitions 6501
The OccurrenceType class MAY include additional property definitions which are implementation-defined. 6502
6503
4.7.7 OccurrenceTypeEnum 6504
The OccurrenceTypeEnum class is an enum class that enumerates the instances each of which 6505 expresses a type of an occurrence or occurrence series. 6506
The OccurrenceTypeEnum class has attribute values: 6507
6508
localNamespace 6509
Value: icom_cal 6510 6511
localName 6512
Value: OccurrenceTypeEnum 6513
6514
extendsFrom 6515
Value: icom_cal:OccurrenceType 6516
6517
stereotype 6518
Value: primary 6519
6520
isEnumeration 6521
Value: TRUE 6522
6523
description 6524
Value: Type of an occurrence or occurrence series. 6525
6526
instances 6527
Value: <icom_cal:Meeting, icom_cal:DayEvent, icom_cal:Holiday, icom_cal:JournalEntry, 6528 icom_cal:OtherOccurrenceType> 6529
6530
ICOM defines five occurrence types: 6531
icom_cal:Meeting an occurrence or occurrence series is a meeting. 6532
icom_cal:DayEvent an occurrence or occurrence series is a day event. 6533
icom_cal:Holiday an occurrence or occurrence series is a holiday. 6534
icom_cal:JournalEntry an occurrence or occurrence series is a journal entry. 6535
icom_cal:OtherOccurrenceType an occurrence or occurrence series is of other type. 6536
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 195 of 244
6537
4.7.8 OccurrenceParticipant 6538
4.7.8.1 Description 6539
An occurrence participant object is a participant object that contains an occurrence participant status. 6540
4.7.8.2 Class Definition 6541
The OccurrenceParticipant class has attribute values: 6542
6543
localNamespace 6544
Value: icom_cal 6545
6546
localName 6547
Value: OccurrenceParticipant 6548
6549
extendsFrom 6550
Value: icom_core:Participant 6551
6552
stereotype 6553
Value: primary 6554
6555
description 6556
Value: An occurrence participant object is a participant object that contains an occurrence 6557 participant status. 6558
6559
propertyDefinitions 6560
The values for this attribute are defined in Section 4.7.8.3. 6561
4.7.8.3 Property Definitions 6562
The OccurrenceParticipant class inherits property definitions from super classes. 6563
The OccurrenceParticipant class MUST have the property definition: 6564
6565
icom_cal:participantStatus 6566
Description: Status of an occurrence participant. 6567
Required: False 6568
Inherited: False 6569
Property Type: icom_cal:OccurrenceParticipantStatus 6570
Cardinality: Single 6571
Updatability: Read Write 6572
6573
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 196 of 244
4.7.9 OccurrenceParticipantStatus 6574
4.7.9.1 Description 6575
An occurrence participant status is a participant’s response status for an occurrence or occurrence series. 6576
4.7.9.2 Class Definition 6577
The OccurrenceParticipantStatus class is a mixin class which defines a participant’s response status for 6578 an occurrence or occurrence series. 6579
The OccurrenceParticipantStatus class has attribute values: 6580
6581
localNamespace 6582
Value: icom_cal 6583
6584
localName 6585
Value: OccurrenceParticipantStatus 6586
6587
extendsFrom 6588
Value: 6589
6590
stereotype 6591
Value: mixin 6592
6593
description 6594
Value: OccurrenceParticipantStatus is a mixin class which defines a participant’s response 6595 status for an occurrence or occurrence series. 6596
6597
propertyDefinitions 6598
The values for this attribute are defined in Section 4.7.9.3. 6599
4.7.9.3 Property Definitions 6600
The OccurrenceParticipantStatus class MAY include additional property definitions which are 6601 implementation-defined. 6602
6603
4.7.10 OccurrenceParticipantStatusEnum 6604
The OccurrenceParticipantStatusEnum class is an enum class that enumerates the instances each of 6605 which expresses a participant’s response status for an occurrence or occurrence series. 6606
The OccurrenceParticipantStatusEnum class has attribute values: 6607
6608
localNamespace 6609
Value: icom_cal 6610 6611
localName 6612
Value: OccurrenceParticipantStatusEnum 6613
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 197 of 244
6614
extendsFrom 6615
Value: icom_cal:OccurrenceParticipantStatus 6616
6617
stereotype 6618
Value: primary 6619
6620
isEnumeration 6621
Value: TRUE 6622
6623
description 6624
Value: Participant’s response status for an occurrence or occurrence series. 6625
6626
instances 6627
Value: <icom_cal:NeedsAction, icom_cal:Accepted, icom_cal:Declined, icom_cal:Tentative> 6628
6629
ICOM defines four occurrence participant’s status: 6630
icom_cal:NeedsAction an attendee needs to act on an occurrence or occurrence series. 6631
icom_cal:Accepted an attendee accepted an occurrence or occurrence series. 6632
icom_cal:Declined an attendee declined an occurrence or occurrence series. 6633
icom_cal:Tentative an attendee is tentative about attending an occurrence or occurrence series. 6634
6635
4.7.11 OccurrenceParticipantTransparency 6636
4.7.11.1 Description 6637
An occurrence participant transparency is visibility of an occurrence or occurrence series in a participant’s 6638 calendar or free busy. 6639
4.7.11.2 Class Definition 6640
The OccurrenceParticipantTransparency class is a mixin class which defines visibility of an occurrence or 6641 occurrence series in a participant’s calendar or free busy. 6642
The OccurrenceParticipantTransparency class has attribute values: 6643
6644
localNamespace 6645
Value: icom_cal 6646
6647
localName 6648
Value: OccurrenceParticipantTransparency 6649
6650
extendsFrom 6651
Value: 6652
6653
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 198 of 244
stereotype 6654
Value: mixin 6655
6656
description 6657
Value: OccurrenceParticipantTransparency is a mixin class which defines visibility of an 6658 occurrence or occurrence series in a participant’s calendar or free busy. 6659
6660
propertyDefinitions 6661
The values for this attribute are defined in Section 4.7.11.3. 6662
4.7.11.3 Property Definitions 6663
The OccurrenceParticipantTransparency class MAY include additional property definitions which are 6664 implementation-defined. 6665
6666
4.7.12 OccurrenceParticipantTransparencyEnum 6667
The OccurrenceParticipantTransparencyEnum class is an enum class that enumerates the instances 6668 each of which expresses an occurrence or occurrence series transparency in a participant’s calendar or 6669 free busy. 6670
The OccurrenceParticipantTransparencyEnum class has attribute values: 6671
6672
localNamespace 6673
Value: icom_cal 6674 6675
localName 6676
Value: OccurrenceParticipantTransparencyEnum 6677
6678
extendsFrom 6679
Value: icom_cal:OccurrenceParticipantTransparency 6680
6681
stereotype 6682
Value: primary 6683
6684
isEnumeration 6685
Value: TRUE 6686
6687
description 6688
Value: Occurrence or occurrence series transparency in a participant’s calendar or free busy. 6689
6690
instances 6691
Value: <icom_cal:Opaque, icom_cal:Transparent, icom_cal:Tentative, icom_cal:OutOfOffice, 6692 icom_cal:DefaultTransparency> 6693
6694
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 199 of 244
ICOM defines five participant transparencies: 6695
icom_cal:Opaque an occurrence or occurrence series is opaque in a participant’s calendar or 6696
free busy. 6697
icom_cal:Transparent an occurrence or occurrence series is transparent in a participant’s 6698 calendar or free busy. 6699
icom_cal:Tentative an occurrence or occurrence series has a tentative transparency in a 6700
participant’s calendar or free busy. 6701
icom_cal:OutOfOffice an occurrence or occurrence series has out of office transparency in a 6702 participant’s calendar or free busy. 6703
icom_cal:DefaultTransparency an occurrence or occurrence series has default transparency in 6704 a participant’s calendar or free busy. 6705
6706
4.7.13 OccurrenceEditMode 6707
4.7.13.1 Description 6708
An occurrence edit mode is a mode that indicates whether an occurrence or occurrence series is editable. 6709
4.7.13.2 Class Definition 6710
The OccurrenceEditMode class is a mixin class which defines a mode that indicates whether an 6711 occurrence or occurrence series is editable. 6712
The OccurrenceEditMode class has attribute values: 6713
6714
localNamespace 6715
Value: icom_cal 6716
6717
localName 6718
Value: OccurrenceEditMode 6719
6720
extendsFrom 6721
Value: 6722
6723
stereotype 6724
Value: mixin 6725
6726
description 6727
Value: OccurrenceEditMode is a mixin class which defines a mode that indicates whether an 6728 occurrence or occurrence series is editable. 6729
6730
propertyDefinitions 6731
The values for this attribute are defined in Section 4.7.13.3. 6732
4.7.13.3 Property Definitions 6733
The OccurrenceEditMode class MAY include additional property definitions which are implementation-6734 defined. 6735
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 200 of 244
6736
4.7.14 OccurrenceEditModeEnum 6737
The OccurrenceEditModeEnum class is an enum class that enumerates the instances each of which 6738 expresses a mode that indicates whether an occurrence or occurrence series is editable. 6739
The OccurrenceEditModeEnum class has attribute values: 6740
6741
localNamespace 6742
Value: icom_cal 6743 6744
localName 6745
Value: OccurrenceEditModeEnum 6746
6747
extendsFrom 6748
Value: icom_cal:OccurrenceEditMode 6749
6750
stereotype 6751
Value: primary 6752
6753
isEnumeration 6754
Value: TRUE 6755
6756
description 6757
Value: A mode that indicates whether an occurrence or occurrence series is editable. 6758
6759
instances 6760
Value: <icom_cal:OrganizerCopy, icom_cal:AttendeeCopy> 6761
6762
ICOM defines two occurrence editable modes: 6763
icom_cal:OrganizerCopy an occurrence or occurrence series is a copy created by an organizer 6764 who may update the properties such as occurrence type, occurrence status, etc. 6765
icom_cal:AttendeeCopy an occurrence or occurrence series is a copy delivered to an attendee 6766
who may only update the attendee properties such as priority, transparency, etc . 6767
6768
4.8 Free Busy Module 6769
4.8.1 FreeBusy 6770
4.8.1.1 Description 6771
A free busy object specifies the free time and busy time intervals of one or more participants. 6772
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 201 of 244
4.8.1.2 Class Definition 6773
The FreeBusy class has attribute values: 6774
6775
localNamespace 6776
Value: icom_cal 6777
6778
localName 6779
Value: FreeBusy 6780
6781
extendsFrom 6782
Value: 6783
6784
stereotype 6785
Value: primary 6786
6787
description 6788
Value: A free busy object specifies the free time and busy time intervals of one or more 6789 participants. 6790
6791
propertyDefinitions 6792
The values for this attribute are defined in Section 4.8.1.3. 6793
4.8.1.3 Property Definitions 6794
The FreeBusy class MUST have the property definitions: 6795
6796
icom_core:participant 6797
Description: A list of participants whose free busy intervals are included. 6798
Required: False 6799
Inherited: False 6800
Property Type: icom_core:Participant 6801
Cardinality: Multi 6802
Updatability: Read Only 6803
6804
icom_core:creationDate 6805
Description: Creation date and time of a free busy object. 6806
Required: False 6807
Inherited: False 6808
Property Type: DateTime 6809
Cardinality: Single 6810
Updatability: Read Only 6811
6812
icom_core:startDate 6813
Description: Start date and time of a list of free busy intervals. 6814
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 202 of 244
Required: False 6815
Inherited: False 6816
Property Type: DateTime 6817
Cardinality: Single 6818
Updatability: Read Only 6819
6820
icom_core:endDate 6821
Description: End date and time of a list of free busy intervals. 6822
Required: False 6823
Inherited: False 6824
Property Type: DateTime 6825
Cardinality: Single 6826
Updatability: Read Only 6827
6828
icom_cal:interval 6829
Description: A list of free busy intervals. 6830
Required: False 6831
Inherited: False 6832
Property Type: icom_cal:FreeBusyInterval 6833
Cardinality: Multi 6834
Updatability: Read Only 6835
6836
4.8.2 FreeBusyInterval 6837
4.8.2.1 Description 6838
A free busy interval specifies an interval of free or busy time. 6839
If a free busy type is icom_cal:Free, then a time interval is free for scheduling. 6840
If a free busy type is icom_cal:Busy, then a time interval is busy because one or more events have been 6841 scheduled for the interval. 6842
4.8.2.2 Class Definition 6843
The FreeBusyInterval class has attribute values: 6844
6845
localNamespace 6846
Value: icom_cal 6847
6848
localName 6849
Value: FreeBusyInterval 6850
6851
extendsFrom 6852
Value: 6853
6854
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 203 of 244
stereotype 6855
Value: primary 6856
6857
description 6858
Value: A free busy interval object specifies an interval of free or busy time. 6859
6860
propertyDefinitions 6861
The values for this attribute are defined in Section 4.8.2.3 6862
4.8.2.3 Property Definitions 6863
The FreeBusyInterval class MUST have the property definitions: 6864
6865
icom_core:startDate 6866
Description: Start date and time of a free busy interval. 6867
Required: False 6868
Inherited: False 6869
Property Type: DateTime 6870
Cardinality: Single 6871
Updatability: Read Only 6872
6873
icom_core:endDate 6874
Description: End date and time of a free busy interval. 6875
Required: False 6876
Inherited: False 6877
Property Type: DateTime 6878
Cardinality: Single 6879
Updatability: Read Only 6880
6881
icom_cal:freeBusyType 6882
Description: A type of free busy interval. 6883
Required: False 6884
Inherited: False 6885
Property Type: icom_cal:FreeBusyType 6886
Cardinality: Single 6887
Updatability: Read Only 6888
6889
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 204 of 244
6890
Figure 39: Free Busy Class Diagram. 6891
6892
4.8.3 FreeBusyType 6893
4.8.3.1 Description 6894
A free busy type classifies a time interval as free, busy, or other. 6895
4.8.3.2 Class Definition 6896
The FreeBusyType class is a mixin class which defines different types to classify a time interval. 6897
The FreeBusyType class has attribute values: 6898
6899
localNamespace 6900
Value: icom_cal 6901
6902
localName 6903
Value: FreeBusyType 6904
6905
extendsFrom 6906
Value: 6907
6908
stereotype 6909
Value: mixin 6910
6911
description 6912
Value: FreeBusyType is a mixin class which defines different types to classify a time interval. 6913
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 205 of 244
6914
propertyDefinitions 6915
The values for this attribute are defined in Section 4.8.3.3. 6916
4.8.3.3 Property Definitions 6917
The FreeBusyType class MAY include additional property definitions which are implementation-defined. 6918
6919
4.8.4 FreeBusyTypeEnum 6920
The FreeBusyTypeEnum class is an enum class that enumerates the instances each of which expresses 6921 a type of free busy interval. 6922
The FreeBusyTypeEnum class has attribute values: 6923
6924
localNamespace 6925
Value: icom_cal 6926 6927
localName 6928
Value: FreeBusyTypeEnum 6929
6930
extendsFrom 6931
Value: icom_cal:FreeBusyType 6932
6933
stereotype 6934
Value: primary 6935
6936
isEnumeration 6937
Value: TRUE 6938
6939
description 6940
Value: A type of free busy interval. 6941
6942
instances 6943
Value: <icom_cal:Free, icom_cal:Busy, icom_cal:Tentative, icom_cal:OutsideAvailableHours, 6944 icom_cal:OutOfOffice, icom_cal:OtherFreeBusyType> 6945
6946
ICOM defines six free busy types: 6947
icom_cal:Free a free busy interval is free. 6948
icom_cal:Busy a free busy interval is busy. 6949
icom_cal:Tentative a free busy interval is tentative. 6950
icom_cal:OutsideAvailableHours a free busy interval is outside available hours. 6951
icom_cal:OutOfOffice a free busy interval is within out of office hours. 6952
icom_cal:OtherFreeBusyType a free busy interval is of other type. 6953
6954
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 206 of 244
4.9 Task List Module 6955
4.9.1 TaskList 6956
4.9.1.1 Description 6957
A task list contains task management artifacts. 6958
4.9.1.2 Class Definition 6959
The TaskList class has attribute values: 6960
6961
localNamespace 6962
Value: icom_task 6963
6964
localName 6965
Value: TaskList 6966
6967
extendsFrom 6968
Value: icom_core:Folder 6969
6970
stereotype 6971
Value: primary 6972
6973
description 6974
Value: A task list contains task management artifacts. 6975
6976
propertyDefinitions 6977
The values for this attribute are defined in 4.9.1.3. 6978
4.9.1.3 Property Definitions 6979
The TaskList class inherits property definitions from super classes. 6980
The TaskList class MUST have the property definitions: 6981
6982
icom_core:timeZone 6983
Description: Time zone of a task list. 6984
Required: True 6985
Inherited: False 6986
Property Type: icom_core:TimeZone 6987
Cardinality: Single 6988
Updatability: Read Write 6989
6990
icom_core:element 6991
Description: Elements of a task list. 6992
Required: False 6993
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 207 of 244
Inherited: True 6994
Property Type: icom_task:Task 6995
Cardinality: Multi 6996
Updatability: Read Only 6997
6998
6999
Figure 40: Task List Class Diagram. 7000
7001
4.9.2 Task 7002
4.9.2.1 Description 7003
A task is an artifact that represents a task to do or a task assignment in a task list. 7004
4.9.2.2 Class Definition 7005
The Task class has attribute values: 7006
7007
localNamespace 7008
Value: icom_task 7009
7010
localName 7011
Value: Task 7012
7013
extendsFrom 7014
Value: icom_core:Artifact 7015
7016
stereotype 7017
Value: primary 7018
7019
description 7020
Value: A task is an artifact that represents a task to do or a task assignment in a task list. 7021
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 208 of 244
7022
propertyDefinitions 7023
The values for this attribute are defined in 4.9.2.3. 7024
4.9.2.3 Property Definitions 7025
The Task class inherits property definitions from super classes. 7026
The Task class MUST have the property definitions: 7027
7028
icom_core:location 7029
Description: Location of a task. 7030
Required: False 7031
Inherited: False 7032
Property Type: icom_core:Location 7033
Cardinality: Single 7034
Updatability: Read Write 7035
7036
icom_core:organizer 7037
Description: Organizer of a task. 7038
Required: True 7039
Inherited: False 7040
Property Type: icom_core:Participant 7041
Cardinality: Single 7042
Updatability: On Create 7043
7044
icom_core:priority 7045
Description: Priority of a task. 7046
Required: False 7047
Inherited: False 7048
Property Type: icom_core:Priority 7049
Cardinality: Single 7050
Updatability: Read Write 7051
7052
icom_core:startDate 7053
Description: Start date and time of a task. 7054
Required: True 7055
Inherited: False 7056
Property Type: DateTime 7057
Cardinality: Single 7058
Updatability: On Create 7059
7060
icom_core:startDateResolution 7061
Description: Resolution of start date and time of a task. 7062
Required: True 7063
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 209 of 244
Inherited: False 7064
Property Type: icom_core:DateTimeResolution 7065
Cardinality: Single 7066
Updatability: On Create 7067
7068
icom_content:attachment 7069
Description: One or more content attachments in a task. 7070
Required: False 7071
Inherited: False 7072
Property Type: icom_content:AttachedItem 7073
Cardinality: Multi 7074
Updatability: Read Write 7075
7076
icom_task:dueDate 7077
Description: Due date and time of a task. 7078
Required: True 7079
Inherited: False 7080
Property Type: DateTime 7081
Cardinality: Single 7082
Updatability: On Create 7083
7084
icom_task:dueDateResolution 7085
Description: Resolution of due date and time of a task. 7086
Required: True 7087
Inherited: False 7088
Property Type: icom_core:DateTimeResolution 7089
Cardinality: Single 7090
Updatability: On Create 7091
7092
icom_task:editMode 7093
Description: Indicates a mode which determines whether a task is 7094 editable. 7095
Required: False 7096
Inherited: False 7097
Property Type: icom_task:TaskEditMode 7098
Cardinality: Single 7099
Updatability: Read Only 7100
7101
icom_task:taskStatus 7102
Description: Status of a task. 7103
Required: True 7104
Inherited: False 7105
Property Type: icom_task:TaskStatus 7106
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 210 of 244
Cardinality: Single 7107
Updatability: Read Write 7108
7109
icom_task:assignee 7110
Description: An assignee of a task. 7111
Required: False 7112
Inherited: False 7113
Property Type: icom_core:Participant 7114
Cardinality: Single 7115
Updatability: Read Only 7116
7117
icom_task:participantStatus 7118
Description: Participation status of a task. 7119
Required: False 7120
Inherited: False 7121
Property Type: icom_task:TaskParticipantStatus 7122
Cardinality: Single 7123
Updatability: Read Write 7124
7125
icom_task:completionDate 7126
Description: Completion date and time of a task. 7127
Required: False 7128
Inherited: False 7129
Property Type: DateTime 7130
Cardinality: Single 7131
Updatability: Read Write 7132
7133
icom_task:completionDateResolution 7134
Description: Resolution of completion date and time of a task. 7135
Required: False 7136
Inherited: False 7137
Property Type: icom_core:DateTimeResolution 7138
Cardinality: Single 7139
Updatability: Read Write 7140
7141
icom_task:percentComplete 7142
Description: Percentage of task completed. 7143
Required: False 7144
Inherited: False 7145
Property Type: Integer 7146
Cardinality: Single 7147
Updatability: Read Write 7148
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 211 of 244
7149
icom_task:assigneeProperty 7150
Description: Extensible properties for an assignee of a task. 7151
Required: False 7152
Inherited: False 7153
Property Type: icom_meta:Property 7154
Cardinality: Multi 7155
Updatability: Read Write 7156
7157
7158
Figure 41: Task Class Diagram. 7159
7160
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 212 of 244
4.9.3 TaskStatus 7161
4.9.3.1 Description 7162
A task status is a status of a task. 7163
4.9.3.2 Class Definition 7164
The TaskStatus class is a mixin class which defines status of a task. 7165
The TaskStatus class has attribute values: 7166
7167
localNamespace 7168
Value: icom_task 7169
7170
localName 7171
Value: TaskStatus 7172
7173
extendsFrom 7174
Value: 7175
7176
stereotype 7177
Value: mixin 7178
7179
description 7180
Value: TaskStatus is a mixin class which defines status of a task. 7181
7182
propertyDefinitions 7183
The values for this attribute are defined in Section 4.9.3.3. 7184
4.9.3.3 Property Definitions 7185
The TaskStatus class MAY include additional property definitions which are implementation-defined. 7186
7187
4.9.4 TaskStatusEnum 7188
The TaskStatusEnum class is an enum class that enumerates the instances each of which expresses a 7189 status of task. 7190
The TaskStatusEnum class has attribute values: 7191
7192
localNamespace 7193
Value: icom_task 7194 7195
localName 7196
Value: TaskStatusEnum 7197
7198
extendsFrom 7199
Value: icom_task:TaskStatus 7200
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 213 of 244
7201
stereotype 7202
Value: primary 7203
7204
isEnumeration 7205
Value: TRUE 7206
7207
description 7208
Value: Status of a task. 7209
7210
instances 7211
Value: <icom_task:NeedsAction, icom_task:InProgress, icom_task:Completed, 7212 icom_task:Cancelled> 7213
7214
ICOM defines four task status: 7215
icom_task:NeedsAction a task needs action. 7216
icom_task:InProgress a task is in progress. 7217
icom_task:Completed a task is completed. 7218
icom_task:Cancelled a task is cancelled. 7219
7220
4.9.5 TaskParticipantStatus 7221
4.9.5.1 Description 7222
A task participant status is a participant’s response status for a task assignment. 7223
4.9.5.2 Class Definition 7224
The TaskParticipantStatus class is a mixin class which defines a participant’s response status for a task 7225 assignment. 7226
The TaskParticipantStatus class has attribute values: 7227
7228
localNamespace 7229
Value: icom_task 7230
7231
localName 7232
Value: TaskParticipantStatus 7233
7234
extendsFrom 7235
Value: 7236
7237
stereotype 7238
Value: mixin 7239
7240
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 214 of 244
description 7241
Value: TaskParticipantStatus is a mixin class which defines a participant’s response status for a 7242 task assignment. 7243
7244
propertyDefinitions 7245
The values for this attribute are defined in Section 4.9.5.3. 7246
4.9.5.3 Property Definitions 7247
The TaskParticipantStatus class MAY include additional property definitions which are implementation-7248 defined. 7249
7250
4.9.6 TaskParticipantStatusEnum 7251
The TaskParticipantStatusEnum class is an enum class that enumerates the instances each of which 7252 expresses a participant’s response status for a task. 7253
The TaskParticipantStatusEnum class has attribute values: 7254
7255
localNamespace 7256
Value: icom_task 7257 7258
localName 7259
Value: TaskParticipantStatusEnum 7260
7261
extendsFrom 7262
Value: icom_task:TaskParticipantStatus 7263
7264
stereotype 7265
Value: primary 7266
7267
isEnumeration 7268
Value: TRUE 7269
7270
description 7271
Value: Participant’s response status for a task. 7272
7273
instances 7274
Value: <icom_task:NeedsAction, icom_task:Accepted, icom_task:Declined, 7275 icom_task:InProgress, icom_task:Completed, icom_task:WaitingOnOther, icom_task:Tentative, 7276 icom_task:Deferred> 7277
7278
ICOM defines eight task participant’s status: 7279
icom_task:NeedsAction an assignee needs to act on a task. 7280
icom_task:Accepted an assignee accepted a task. 7281
icom_task:Declined an assignee declined a task. 7282
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 215 of 244
icom_task:InProgress a task is in progress. 7283
icom_task:Completed a task is completed. 7284
icom_task:WaitingOnOther an assignee is waiting on other. 7285
icom_task:Tentative an assignee is tentative about a task. 7286
icom_task:Deferred an assignee deferred a task. 7287
7288
4.9.7 TaskEditMode 7289
4.9.7.1 Description 7290
A task edit mode is a mode that indicates whether a task is editable. 7291
4.9.7.2 Class Definition 7292
The TaskEditMode class is a mixin class which defines a mode that indicates whether a task is editable. 7293
The TaskEditMode class has attribute values: 7294
7295
localNamespace 7296
Value: icom_task 7297
7298
localName 7299
Value: TaskEditMode 7300
7301
extendsFrom 7302
Value: 7303
7304
stereotype 7305
Value: mixin 7306
7307
description 7308
Value: TaskEditMode is a mixin class which defines a mode that indicates whether task is 7309 editable. 7310
7311
propertyDefinitions 7312
The values for this attribute are defined in Section 4.9.7.3. 7313
4.9.7.3 Property Definitions 7314
The TaskEditMode class MAY include additional property definitions which are implementation-defined. 7315
7316
4.9.8 TaskEditModeEnum 7317
The TaskEditModeEnum class is an enum class that enumerates the instances each of which expresses 7318 an editable mode of a task. 7319
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 216 of 244
The TaskEditModeEnum class has attribute values: 7320
7321
localNamespace 7322
Value: icom_task 7323 7324
localName 7325
Value: TaskEditModeEnum 7326
7327
extendsFrom 7328
Value: icom_task:TaskEditMode 7329
7330
stereotype 7331
Value: primary 7332
7333
isEnumeration 7334
Value: TRUE 7335
7336
description 7337
Value: A mode that indicates whether a task is editable. 7338
7339
instances 7340
Value: <icom_task:OrganizerCopy, icom_task:AssigneeCopy> 7341
7342
ICOM defines two task editable modes: 7343
icom_task:OrganizerCopy: a task is a copy created by an organizer who may update the 7344 properties such as start time, due time. 7345
icom_task:AssigneeCopy: a task is a copy delivered to an assignee who may only update the 7346
assignee properties such as completion time, participant status, percent completed. 7347
7348
4.10 Forum Module 7349
4.10.1 Discussion 7350
4.10.1.1 Description 7351
A discussion is an item in a discussion container. 7352
4.10.1.2 Class Definition 7353
The Discussion class is a mixin class that defines the characteristics of artifacts that can be elements of 7354 discussion containers. 7355
The Discussion class has attribute values: 7356
7357
localNamespace 7358
Value: icom_forum 7359
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 217 of 244
7360
localName 7361
Value: Discussion 7362
7363
extendsFrom 7364
Value: icom_core:Item 7365
7366
stereotype 7367
Value: mixin 7368
7369
description 7370
Value: Discussion is a mixin class that defines the characteristics of artifacts that can be placed 7371 in a discussion container. 7372
7373
propertyDefinitions 7374
The values for this attribute are defined in Section 4.10.1.3. 7375
4.10.1.3 Property Definitions 7376
The Discussion class inherits property definitions from super classes. 7377
The Discussion class MUST have the property definition: 7378
7379
icom_forum:inReplyTo 7380
Description: Another discussion object that a discussion object is replying 7381 to. 7382
Required: False 7383
Inherited: False 7384
Property Type: icom_forum:Discussion 7385
Cardinality: Single 7386
Updatability: Read Write 7387
7388
The Discussion class MAY include additional property definitions which are implementation-defined. 7389
7390
4.10.2 DiscussionContainer 7391
4.10.2.1 Description 7392
A discussion container contains discussion items. 7393
4.10.2.2 Class Definition 7394
The DiscussionContainer class is a mixin class that defines the characteristics of folders that contain 7395 Discussion items. 7396
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 218 of 244
The DiscussionContainer class has attribute values: 7397
7398
localNamespace 7399
Value: icom_forum 7400
7401
localName 7402
Value: DiscussionContainer 7403
7404
extendsFrom 7405
Value: icom_core:Container 7406
7407
stereotype 7408
Value: mixin 7409
7410
description 7411
Value: DiscussionContainer is a mixin class that defines the characteristics of folders that 7412 contain Discussion items. 7413
7414
propertyDefinitions 7415
The values for this attribute are defined in Section 4.10.2.3. 7416
4.10.2.3 Property Definitions 7417
The DiscussionContainer class inherits property definitions from super classes. 7418
The DiscussionContainer class MUST have the property definition: 7419
7420
icom_core:element 7421
Description: Elements of a discussion container. 7422
Required: False 7423
Inherited: True 7424
Property Type: icom_forum:Discussion 7425
Cardinality: Multi 7426
Updatability: Read Only 7427
7428
The DiscussionContainer class MAY include additional property definitions which are implementation-7429 defined. 7430
7431
4.10.3 DiscussionMessage 7432
4.10.3.1 Description 7433
A discussion message is a message in a forum discussion thread. 7434
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 219 of 244
4.10.3.2 Class Definition 7435
The DiscussionMessage class has attribute values: 7436
7437
localNamespace 7438
Value: icom_forum 7439
7440
localName 7441
Value: DiscussionMessage 7442
7443
extendsFrom 7444
Value: icom_msg:Message, icom_forum:Discussion 7445
7446
stereotype 7447
Value: primary 7448
7449
description 7450
Value: Discussion message is a message in a forum discussion thread. 7451
7452
propertyDefinitions 7453
The values for this attribute are defined in Section 4.10.3.3. 7454
4.10.3.3 Property Definitions 7455
The DiscussionMessage class inherits property definitions from super classes. 7456
The DiscussionMessage class MUST have the property definition: 7457
7458
icom_forum:inReplyTo 7459
Description: Another discussion message that a discussion message is 7460 replying to. 7461
Required: False 7462
Inherited: True 7463
Property Type: icom_forum:DiscussionMessage 7464
Cardinality: Single 7465
Updatability: Read Write 7466
7467
The DiscussionMessage class MAY include additional property definitions which are implementation-7468 defined. 7469
7470
4.10.4 TopicContainer 7471
4.10.4.1 Description 7472
A topic container contains topics. 7473
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 220 of 244
4.10.4.2 Class Definition 7474
The TopicContainer class is a mixin class which defines the characteristics of folders that contain Topics. 7475
The TopicContainer class has attribute values: 7476
7477
localNamespace 7478
Value: icom_forum 7479
7480
localName 7481
Value: TopicContainer 7482
7483
extendsFrom 7484
Value: icom_core:Container 7485
7486
stereotype 7487
Value: mixin 7488
7489
description 7490
Value: TopicContainer is a mixin class that defines the characteristics of folders that contain 7491 topics. 7492
7493
propertyDefinitions 7494
The values for this attribute are defined in Section 4.10.4.3. 7495
4.10.4.3 Property Definitions 7496
The TopicContainer class inherits property definitions from super classes. 7497
The TopicContainer class MUST have the property definitions: 7498
7499
icom_core:element 7500
Description: Elements of a topic container. 7501
Required: False 7502
Inherited: True 7503
Property Type: icom_forum:Topic 7504
Cardinality: Multi 7505
Updatability: Read Only 7506
7507
The TopicContainer class MAY include additional property definitions which are implementation-defined. 7508
7509
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 221 of 244
7510
Figure 42: Forum Class Diagram. 7511
7512
4.10.5 Forum 7513
4.10.5.1 Description 7514
A forum contains sub-forums, topics, and announcements. 7515
4.10.5.2 Class Definition 7516
The Forum class has attribute values: 7517
7518
localNamespace 7519
Value: icom_forum 7520
7521
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 222 of 244
localName 7522
Value: Forum 7523
7524
extendsFrom 7525
Value: icom_core:Folder, icom_forum:TopicContainer 7526
7527
stereotype 7528
Value: primary 7529
7530
description 7531
Value: A forum contains sub-forums, topics, and announcements. 7532
7533
propertyDefinitions 7534
The values for this attribute are defined in Section 4.10.5.3. 7535
4.10.5.3 Property Definitions 7536
The Forum class inherits property definitions from super classes. 7537
The Forum class MUST have the property definitions: 7538
7539
icom_forum:lastPost 7540
Description: The last posted discussion in a forum. 7541
Required: False 7542
Inherited: False 7543
Property Type: icom_forum:Discussion 7544
Cardinality: Single 7545
Updatability: Read Only 7546
7547
icom_forum:forum 7548
Description: Sub-forums of a forum. 7549
Required: False 7550
Inherited: False 7551
Property Type: icom_forum:Forum 7552
Cardinality: Multi 7553
Updatability: Read Only 7554
7555
icom_forum:topic 7556
Description: Topics of a forum. 7557
Required: False 7558
Inherited: False 7559
Property Type: icom_forum:Topic 7560
Cardinality: Multi 7561
Updatability: Read Only 7562
7563
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 223 of 244
icom_forum:announcement 7564
Description: Announcements of a forum. 7565
Required: False 7566
Inherited: False 7567
Property Type: icom_forum:Announcement 7568
Cardinality: Multi 7569
Updatability: Read Only 7570
7571
The Forum class MAY include additional property definitions which are implementation-defined. 7572
7573
4.10.6 Topic 7574
4.10.6.1 Description 7575
A topic contains conversations among forum participants. The discussions in a topic may be sorted in 7576 chronological order or threaded by reply. 7577
4.10.6.2 Class Definition 7578
The Topic class has attribute values: 7579
7580
localNamespace 7581
Value: icom_forum 7582
7583
localName 7584
Value: Topic 7585
7586
extendsFrom 7587
Value: icom_core:Folder, icom_forum:DiscussionContainer 7588
7589
stereotype 7590
Value: primary 7591
7592
description 7593
Value: A topic contains discussion threads. 7594
7595
propertyDefinitions 7596
The values for this attribute are defined in Section 4.10.6.3. 7597
4.10.6.3 Property Definitions 7598
The Topic class inherits property definitions from super classes. 7599
The Topic class MUST have the property definitions: 7600
7601
icom_core:element 7602
Description: Elements of a topic. 7603
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 224 of 244
Required: False 7604
Inherited: True 7605
Property Type: icom_forum:Discussion 7606
Cardinality: Multi 7607
Updatability: Read Only 7608
7609
icom_forum:firstPost 7610
Description: The first posted discussion in a topic. 7611
Required: False 7612
Inherited: False 7613
Property Type: icom_forum:Discussion 7614
Cardinality: Single 7615
Updatability: Read Only 7616
7617
icom_forum:lastPost 7618
Description: The last posted discussion in a topic. 7619
Required: False 7620
Inherited: False 7621
Property Type: icom_forum:Discussion 7622
Cardinality: Single 7623
Updatability: Read Only 7624
7625
The Topic class MAY include additional property definitions which are implementation-defined. 7626
7627
4.10.7 Announcement 7628
4.10.7.1 Description 7629
An announcement contains time-sensitive discussion posts that are valid for a specified period of time, 7630 depending on activation and expiration times. 7631
4.10.7.2 Class Definition 7632
The Announcement class has attribute values: 7633
7634
localNamespace 7635
Value: icom_forum 7636
7637
localName 7638
Value: Announcement 7639
7640
extendsFrom 7641
Value: icom_forum:Topic 7642
7643
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 225 of 244
stereotype 7644
Value: primary 7645
7646
description 7647
Value: An announcement contains discussion items that are valid for a specified period of time. 7648
7649
propertyDefinitions 7650
The values for this attribute are defined in Section 4.10.7.3. 7651
4.10.7.3 Property Definitions 7652
The Announcement class inherits property definitions from super classes. 7653
The Announcement class MUST have the property definitions: 7654
7655
icom_forum:activationDate 7656
Description: Date and time when an announcement becomes active. 7657
Required: False 7658
Inherited: False 7659
Property Type: DateTime 7660
Cardinality: Single 7661
Updatability: Read Write 7662
7663
icom_forum:expirationDate 7664
Description: Date and time when an announcement expires. 7665
Required: False 7666
Inherited: False 7667
Property Type: DateTime 7668
Cardinality: Single 7669
Updatability: Read Write 7670
7671
icom_forum:announcementStatus 7672
Description: Status of an announcement. 7673
Required: True 7674
Inherited: False 7675
Property Type: icom_forum:AnnouncementStatus 7676
Cardinality: Single 7677
Updatability: Read Write 7678
7679
The Announcement class MAY include additional property definitions which are implementation-defined. 7680
7681
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 226 of 244
4.10.8 AnnouncementStatus 7682
4.10.8.1 Description 7683
An announcement status is status of an announcement. 7684
4.10.8.2 Class Definition 7685
The AnnouncementStatus class is a mixin class which defines status of an announcement. 7686
The AnnouncementStatus class has attribute values: 7687
7688
localNamespace 7689
Value: icom_forum 7690
7691
localName 7692
Value: AnnouncementStatus 7693
7694
extendsFrom 7695
Value: 7696
7697
stereotype 7698
Value: mixin 7699
7700
description 7701
Value: AnnouncementStatus is a mixin class which defines status of an announcement. 7702
7703
propertyDefinitions 7704
The values for this attribute are defined in Section 4.10.8.3. 7705
4.10.8.3 Property Definitions 7706
The AnnouncementStatus class MAY include additional property definitions which are implementation-7707 defined. 7708
7709
4.10.9 AnnouncementStatusEnum 7710
The AnnouncementStatusEnum class is an enum class that enumerates the instances each of which 7711 expresses a status of announcement. 7712
The AnnouncementStatusEnum class has attribute values: 7713
7714
localNamespace 7715
Value: icom_forum 7716 7717
localName 7718
Value: AnnouncementStatusEnum 7719
7720
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 227 of 244
extendsFrom 7721
Value: icom_forum:AnnouncementStatus 7722
7723
stereotype 7724
Value: primary 7725
7726
isEnumeration 7727
Value: TRUE 7728
7729
description 7730
Value: Status of announcement. 7731
7732
instances 7733
Value: <icom_forum:Pending, icom_forum:Active, icom_forum:Expired> 7734
7735
ICOM defines three announcement status: 7736
icom_forum:Pending an announcement is pending. 7737
icom_forum:Active an announcement is active. 7738
icom_forum:Expired an announcement is expired. 7739
7740
4.11 Conference Module 7741
4.11.1 Conference 7742
4.11.1.1 Description 7743
A conference is a container that represents a durable context for conference sessions. 7744
It contains conference metadata, settings, and transcripts. 7745
4.11.1.2 Class Definition 7746
The Conference class has attribute values: 7747
7748
localNamespace 7749
Value: icom_conf 7750
7751
localName 7752
Value: Conference 7753
7754
extendsFrom 7755
Value: icom_core:Folder 7756
7757
stereotype 7758
Value: primary 7759
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 228 of 244
7760
description 7761
Value: A conference represents a durable context for online conference sessions. 7762
7763
propertyDefinitions 7764
The values for this attribute are defined in Section 4.11.1.3. 7765
4.11.1.3 Property Definitions 7766
The Conference class inherits property definitions from super classes. 7767
The Conference class MUST have the property definitions: 7768
7769
icom_core:organizer 7770
Description: Organizer of a conference. 7771
Required: False 7772
Inherited: False 7773
Property Type: icom_core:Participant 7774
Cardinality: Single 7775
Updatability: On Create 7776
7777
icom_conf:conferenceType 7778
Description: Type of a conference. 7779
Required: False 7780
Inherited: False 7781
Property Type: icom_conf:ConferenceType 7782
Cardinality: Single 7783
Updatability: Read Write 7784
7785
icom_conf:conferenceStatus 7786
Description: Status of a conference. 7787
Required: False 7788
Inherited: False 7789
Property Type: icom_conf:ConferenceStatus 7790
Cardinality: Single 7791
Updatability: Read Only 7792
7793
icom_conf:runningSession 7794
Description: Current session of a conference. 7795
Required: False 7796
Inherited: False 7797
Property Type: icom_conf:ConferenceSession 7798
Cardinality: Single 7799
Updatability: Read Only 7800
7801
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 229 of 244
icom_conf:conferenceSetting 7802
Description: Configurable settings of a conference. 7803
Required: False 7804
Inherited: False 7805
Property Type: icom_conf:ConferenceSetting 7806
Cardinality: Single 7807
Updatability: Read Only 7808
7809
icom_conf:transcript 7810
Description: Transcripts from ended sessions of a conference. 7811
Required: False 7812
Inherited: False 7813
Property Type: icom_doc:Document 7814
Cardinality: Multi 7815
Updatability: Read Write 7816
7817
icom_conf:scheduledStartDate 7818
Description: Scheduled start date and time of a conference session. 7819
Required: False 7820
Inherited: False 7821
Property Type: DateTime 7822
Cardinality: Single 7823
Updatability: Read Write 7824
7825
icom_conf:scheduledEndDate 7826
Description: Scheduled end date and time of a conference session. 7827
Required: False 7828
Inherited: False 7829
Property Type: DateTime 7830
Cardinality: Single 7831
Updatability: Read Write 7832
7833
The Conference class MAY include additional property definitions which are implementation-defined. 7834
7835
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 230 of 244
7836
Figure 43: Conference Class Diagram. 7837
7838
4.11.2 ConferenceType 7839
4.11.2.1 Description 7840
A conference type represents a category of conferences. 7841
4.11.2.2 Class Definition 7842
The ConferenceType class is a mixin class which defines a type of conference. 7843
The ConferenceType class has attribute values: 7844
7845
localNamespace 7846
Value: icom_conf 7847
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 231 of 244
7848
localName 7849
Value: ConferenceType 7850
7851
extendsFrom 7852
Value: 7853
7854
stereotype 7855
Value: mixin 7856
7857
description 7858
Value: ConferenceType is a mixin class which defines type of conference. 7859
7860
propertyDefinitions 7861
The values for this attribute are defined in Section 4.11.2.3. 7862
4.11.2.3 Property Definitions 7863
The ConferenceType class MAY include additional property definitions which are implementation-defined. 7864
7865
4.11.3 ConferenceTypeEnum 7866
The ConferenceTypeEnum class is an enum class that enumerates the instances each of which 7867 expresses a type of a conference. 7868
The ConferenceTypeEnum class has attribute values: 7869
7870
localNamespace 7871
Value: icom_conf 7872 7873
localName 7874
Value: ConferenceTypeEnum 7875
7876
extendsFrom 7877
Value: icom_conf:ConferenceType 7878
7879
stereotype 7880
Value: primary 7881
7882
isEnumeration 7883
Value: TRUE 7884
7885
description 7886
Value: A type of a conference. 7887
7888
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 232 of 244
instances 7889
Value: <icom_conf:Impromptu, icom_conf:Scheduled, icom_conf:ChatRoom, 7890 icom_conf:OtherConferenceType> 7891
7892
ICOM defines four conference types: 7893
icom_conf:Impromptu a conference session is started impromptu. 7894
icom_conf:Scheduled a conference session is scheduled. 7895
icom_conf:ChatRoom a conference is used for a chat room. 7896
icom_conf:OtherConferenceType a conference is of other type. 7897
7898
4.11.4 ConferenceStatus 7899
4.11.4.1 Description 7900
A conference status is status of an online conference. 7901
4.11.4.2 Class Definition 7902
The ConferenceStatus class is a mixin class which defines status of an online conference. 7903
The ConferenceStatus class has attribute values: 7904
7905
localNamespace 7906
Value: icom_conf 7907
7908
localName 7909
Value: ConferenceStatus 7910
7911
extendsFrom 7912
Value: 7913
7914
stereotype 7915
Value: mixin 7916
7917
description 7918
Value: ConferenceStatus is a mixin class which defines status of an online conference. 7919
7920
propertyDefinitions 7921
The values for this attribute are defined in Section 4.11.4.3. 7922
4.11.4.3 Property Definitions 7923
The ConferenceStatus class MAY include additional property definitions which are implementation-7924 defined. 7925
7926
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 233 of 244
4.11.5 ConferenceStatusEnum 7927
The ConferenceStatusEnum class is an enum class that enumerates the instances each of which 7928 expresses a status of a conference. 7929
The ConferenceStateEnum class has attribute values: 7930
7931
localNamespace 7932
Value: icom_conf 7933 7934
localName 7935
Value: ConferenceStatusEnum 7936
7937
extendsFrom 7938
Value: icom_conf:ConferenceStatus 7939
7940
stereotype 7941
Value: primary 7942
7943
isEnumeration 7944
Value: TRUE 7945
7946
description 7947
Value: Status of a conference. 7948
7949
instances 7950
Value: <icom_conf:NotStarted, icom_conf:WaitingForHost, icom_conf:Running, 7951 icom_conf:Hibernating, icom_conf:Ended> 7952
7953
ICOM defines five conference status: 7954
icom_conf:NotStarted a conference session is not started . 7955
icom_conf:WaitingForHost a conference session is waiting for a host. 7956
icom_conf:Running a conference session is running. 7957
icom_conf:Hibernating a conference session is hibernating. 7958
icom_conf:Ended a conference session is ended. 7959
7960
4.11.6 ConferenceSession 7961
4.11.6.1 Description 7962
A conference session represents the metadata for a session of a conference. 7963
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 234 of 244
4.11.6.2 Class Definition 7964
The ConferenceSession class has attribute values: 7965
7966
localNamespace 7967
Value: icom_conf 7968
7969
localName 7970
Value: ConferenceSession 7971
7972
extendsFrom 7973
Value: icom_core:Identifiable 7974
7975
stereotype 7976
Value: primary 7977
7978
description 7979
Value: A conference session represents the metadata for a session of a conference. 7980
7981
propertyDefinitions 7982
The values for this attribute are defined in Section 4.11.6.3. 7983
4.11.6.3 Property Definitions 7984
The ConferenceSession class inherits property definitions from super classes. 7985
The ConferenceSession class MUST have the property definitions: 7986
7987
icom_core:description 7988
Description: Description of a conference session. 7989
Required: False 7990
Inherited: False 7991
Property Type: String 7992
Cardinality: Single 7993
Updatability: Read Write 7994
7995
icom_core:startDate 7996
Description: Start date and time of a conference session. 7997
Required: False 7998
Inherited: False 7999
Property Type: DateTime 8000
Cardinality: Single 8001
Updatability: Read Only 8002
8003
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 235 of 244
icom_core:endDate 8004
Description: End date and time of a conference session. 8005
Required: False 8006
Inherited: False 8007
Property Type: DateTime 8008
Cardinality: Single 8009
Updatability: Read Only 8010
8011
icom_conf:comment 8012
Description: Comment on a conference session. 8013
Required: False 8014
Inherited: False 8015
Property Type: String 8016
Cardinality: Single 8017
Updatability: Read Write 8018
8019
icom_conf:rating 8020
Description: Rating of a conference session. 8021
Required: False 8022
Inherited: False 8023
Property Type: String 8024
Cardinality: Single 8025
Updatability: Read Write 8026
8027
icom_conf:serverAddress 8028
Description: Address of a server that hosts a conference session. 8029
Required: False 8030
Inherited: False 8031
Property Type: String 8032
Cardinality: Single 8033
Updatability: Read Only 8034
8035
icom_conf:endingReason 8036
Description: Reason for ending a conference session. 8037
Required: False 8038
Inherited: False 8039
Property Type: icom_conf:ConferenceSessionEndingReason 8040
Cardinality: Single 8041
Updatability: Read Only 8042
8043
The ConferenceSession class MAY include additional property definitions which are implementation-8044 defined. 8045
8046
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 236 of 244
4.11.7 ConferenceSessionEndingReason 8047
4.11.7.1 Description 8048
A conference session ending reason is an indication of how a conference session ended. 8049
4.11.7.2 Class Definition 8050
The ConferenceSessionEndingReason class is a mixin class which defines an indication of how a 8051 conference session ended. 8052
The ConferenceSessionEndingReason class has attribute values: 8053
8054
localNamespace 8055
Value: icom_conf 8056
8057
localName 8058
Value: ConferenceSessionEndingReason 8059
8060
extendsFrom 8061
Value: 8062
8063
stereotype 8064
Value: mixin 8065
8066
description 8067
Value: ConferenceSessionEndingReason is a mixin class which defines an indication of how a 8068 conference session ended. 8069
8070
propertyDefinitions 8071
The values for this attribute are defined in Section 4.11.7.3. 8072
4.11.7.3 Property Definitions 8073
The ConferenceSessionEndingReason class MAY include additional property definitions which are 8074 implementation-defined. 8075
8076
4.11.8 ConferenceSessionEndingReasonEnum 8077
The ConferenceSessionEndingReasonEnum class is an enum class that enumerates the instances each 8078 of which expresses a reason for ending a conference session. 8079
The ConferenceSessionEndingReasonEnum class has attribute values: 8080
8081
localNamespace 8082
Value: icom_conf 8083 8084
localName 8085
Value: ConferenceSessionEndingReasonEnum 8086
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 237 of 244
8087
extendsFrom 8088
Value: icom_conf:ConferenceSessionEndingReason 8089
8090
stereotype 8091
Value: primary 8092
8093
isEnumeration 8094
Value: TRUE 8095
8096
description 8097
Value: Reason for ending a conference session. 8098
8099
instances 8100
Value: <icom_conf:HostLeft, icom_conf:HostAborted, icom_conf:NoHost, icom_conf:Hibernating> 8101
8102
ICOM defines four conference session states: 8103
icom_conf:HostLeft a conference session ended after the host left. 8104
icom_conf:HostAborted a conference session ended after the host aborted it. 8105
icom_conf:NoHost a conference session ended due to no one hosting. 8106
icom_conf:Hibernating a conference session is hibernating. 8107
8108
4.11.9 ConferenceSetting 8109
4.11.9.1 Description 8110
A conference setting represents configuration settings for sessions of a conference. 8111
4.11.9.2 Class Definition 8112
The ConferenceSetting class has attribute values: 8113
8114
localNamespace 8115
Value: icom_conf 8116
8117
localName 8118
Value: ConferenceSetting 8119
8120
extendsFrom 8121
Value: 8122
8123
stereotype 8124
Value: primary 8125
8126
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 238 of 244
description 8127
Value: A conference setting represents configuration settings for sessions of a conference. 8128
8129
propertyDefinitions 8130
The values for this attribute are defined in Section 4.11.9.3. 8131
4.11.9.3 Property Definitions 8132
The ConferenceSetting class inherits property definitions from super classes. 8133
The ConferenceSetting class MUST have the property definitions: 8134
8135
icom_meta:property 8136
Description: Configurable properties for a conference. 8137
Required: False 8138
Inherited: False 8139
Property Type: icom_meta:property 8140
Cardinality: Multi 8141
Updatability: Read Write 8142
8143
icom_conf:participantRole 8144
Description: Role settings for conference participants. 8145
Required: False 8146
Inherited: False 8147
Property Type: icom_conf:ConferenceParticipantRole 8148
Cardinality: Multi 8149
Updatability: Read Write 8150
8151
The ConferenceSetting class MAY include additional property definitions which are implementation-8152 defined. 8153
8154
4.11.10 ConferenceParticipantRole 8155
4.11.10.1 Description 8156
A conference participant role defines roles settings for a conference participant. 8157
4.11.10.2 Class Definition 8158
The ConferenceParticipantRole class has attribute values: 8159
8160
localNamespace 8161
Value: icom_conf 8162
8163
localName 8164
Value: ConferenceParticipantRole 8165
8166
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 239 of 244
extendsFrom 8167
Value: 8168
8169
stereotype 8170
Value: primary 8171
8172
description 8173
Value: A conference participant role contains roles settings for a conference. 8174
8175
propertyDefinitions 8176
The values for this attribute are defined in Section 4.11.10.3. 8177
4.11.10.3 Property Definitions 8178
The ConferenceParticipantRole class MUST have the property definitions: 8179
8180
icom_core:name 8181
Description: Name of a role setting in a conference. 8182
Required: False 8183
Inherited: False 8184
Property Type: String 8185
Cardinality: Single 8186
Updatability: Read Write 8187
8188
icom_core:participant 8189
Description: One or more participants in a role setting. 8190
Required: False 8191
Inherited: False 8192
Property Type: icom_core:Participant 8193
Cardinality: Multi 8194
Updatability: Read Write 8195
8196
icom_meta:property 8197
Description: Configurable properties for a role setting. 8198
Required: False 8199
Inherited: False 8200
Property Type: icom_meta:Property 8201
Cardinality: Multi 8202
Updatability: Read Write 8203
8204
icom_conf:key 8205
Description: One or more sign on keys to activate a role setting. 8206
Required: False 8207
Inherited: False 8208
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 240 of 244
Property Type: String 8209
Cardinality: Multi 8210
Updatability: Read Write 8211
8212
icom_conf:keyword 8213
Description: One or more key words to activate a role setting. 8214
Required: False 8215
Inherited: False 8216
Property Type: String 8217
Cardinality: Multi 8218
Updatability: Read Write 8219
8220
The ConferenceParticipantRole class MAY include additional property definitions which are 8221 implementation-defined. 8222
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 241 of 244
5 Conformance 8223
5.1 Software Architecture or Framework Dependence 8224
The ICOM specification does not presume a particular software architecture or framework for use of the 8225 ICOM model. 8226
Fulfillment of ICOM use case roles and accompanying responsibilities is implementation dependent. 8227
8228
5.2 Platform Provider Conformance 8229
5.2.1 Platform Provider Conformance – No Extension Modules 8230
An ICOM platform provider with no extension modules (Section 4): 8231
a. SHALL conform to all mandatory statements and 8232
b. MAY conform to optional statements 8233
of the core ICOM model as defined in Section 3 of this standard. 8234
8235
5.2.2 Platform Provider Conformance – One or More Extension Modules 8236
An ICOM platform provider with extension modules (Section 4): 8237
a. SHALL conform to Section 5.2.1 and 8238
b. SHALL conform to all mandatory statements and 8239
c. MAY conform to optional statements 8240
as defined in Section 4 for each extension module. 8241
8242
5.3 Service Provider Conformance 8243
5.3.1 ICOM Service Provider – No Extension Modules 8244
An ICOM service provider may provide one or more services defined in Section 3. For each such service 8245 provided, an ICOM service provider: 8246
a. SHALL conform to all mandatory statements and 8247
b. MAY conform to optional statements 8248
for the classes, super classes, and related classes defined in Section 3 of this standard. 8249
8250
5.3.2 ICOM Service Provider – One or More Extension Modules 8251
An ICOM service provider MAY support one or more extension modules as defined in Section 4 of this 8252 standard. For each service provided, an ICOM service provider: 8253
a. SHALL conform to Section 5.3.1 (if an offered service is defined in Section 3) and 8254
b. SHALL conform to all mandatory statements and 8255
c. MAY conform to optional statements 8256
as defined in Section 4 for that extension module. 8257
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 242 of 244
8258
5.4 ICOM Producer Conformance 8259
5.4.1 ICOM Producer Conformance – No Extension Modules 8260
An ICOM producer that produces no objects of a class conforming to Section 4: 8261
a. SHALL conform to all mandatory statements and 8262
b. MAY conform to optional statements 8263
for the class and super classes thereof in Section 3 of this standard, for any object produced. 8264
8265
5.4.2 ICOM Producer Conformance – One or More Extension Modules 8266
An ICOM producer that produces objects of a class conforming to Section 4: 8267
a. SHALL conform to Section 5.4.1 and 8268
b. SHALL conform to all mandatory statements and 8269
c. MAY conform to optional statements 8270
as defined in Section 4 for that extension module. 8271
8272
5.5 ICOM Consumer Conformance 8273
5.5.1 ICOM Consumer Conformance – No Extension Modules 8274
An ICOM consumer that consumes no objects of a class conforming to Section 4: 8275
a. SHALL conform to all mandatory statements and 8276
b. MAY conform to optional statements 8277
for the class and super classes thereof in Section 3 of this standard, for any object consumed. 8278
8279
5.5.2 ICOM Consumer Conformance – Extension Modules 8280
An ICOM consumer that consumes objects of a class conforming to Section 4: 8281
a. SHALL conform to Section 5.5.1 and 8282
b. SHALL conform to all mandatory statements and 8283
c. MAY conform to optional statements 8284
as defined in Section 4 for that extension module. 8285
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 243 of 244
Appendix A. Acknowledgements 8286
The following individuals have participated in the creation of this specification and are gratefully 8287 acknowledged: 8288
Participants: 8289 Rafiul Ahad, Oracle Corporation 8290 Kenneth P. Baclawski, Northeastern University 8291 Eric S. Chan, Oracle Corporation 8292 Martin Chapman, Oracle Corporation 8293 Scott Conroy, Individual 8294 Stefan Decker, Digital Enterprise Research Institute (DERI) 8295 Laura Dragan, Digital Enterprise Research Institute (DERI) 8296 Patrick Durusau, Individual 8297 Siegfried Handschuh, Digital Enterprise Research Institute (DERI) 8298 Deirdre Lee, Digital Enterprise Research Institute (DERI) 8299 Marc Pallot, ESoCE-NET 8300 Chancellor Pascale, Johns Hopkins University Applied Physics Laboratory 8301 Vassilios Peristeras, Digital Enterprise Research Institute (DERI) 8302 Peter Saint-Andre, Cisco Systems, Inc. 8303 Ramesh Vasudevan, Oracle Corporation 8304 Peter Yim, Individual 8305
8306
icom-ics-v1.0-cs01 31 January 2013 Standards Track Work Product Copyright © OASIS Open 2013. All Rights Reserved. Page 244 of 244
Appendix B. Revision History 8307
8308
Revision Date Editor Changes Made
CSPRD 01 March 16, 2011 Eric S. Chan
Patrick Durusau
Committee Specification Draft for Public Review
CSPRD 02 November 8, 2011
Eric S. Chan
Patrick Durusau
Changes in response to public review comments.
CSPRD 03 March 20, 2012 Eric S. Chan
Patrick Durusau
Laura Dragan
Changes in response to TC members review comments.
CSPRD 04 June 26, 2012 Ken Baclawski Add 4 additional attributes from grammar to PropertyDefinition metadata model, corrected spelling of Cardinality, renamed the address property of Addressable to entityAddress to avoid clashing with the address properties of EntityAddress and Participant, and specified the omitted namespaces of the superCategories of some of the enumerations.
CSPRD 05 October 15, 2012 Ken Baclawski
Eric S. Chan
Patrick Durusau
Change InstantMessage isAbstract to false, change PropertyType to optional in PropertyDefinition, change cardinality of superCategory property in Category to multi, add ClassDefinition, StereoType, StereoTypeEnum in icom_meta, add Figure 18 ClassDefinition UML diagram, remove EntityDefinition in icom_core.
Updated the conformance clauses in Section 5.
8309
8310
8311