A XML document that represents an embeddable fragment of markup. Assigned id to this fragment. Fragment producers don't need to returned this. Informational set of elements based on RFC 2413 - Dublin Core Metadata for Resource Discovery Metadata description of fragment capabilities and resources. Required Cascading Style Sheet file. Required javascript library file. The fragment markup is the actual rendered view for the requested mimeType. Request to retrieve specified fragment and rewrite it into parent fragment. Error description. Server-side update of transient properties. Server-side update of custom properties. Event description. TODO: Add publishedEvents and raisedEvents, both lists of event names Overrides the fragment's title with a dynamically generated one. Must be returned on every call otherwise the title reverts to the static fragment/info/title. A fragment server-side redirect. [Not implemented yet]. The encoded and signed custom properties for the current fragment. The current encoded state that was used to generate the fragment markup. Causes the controller to refresh the fragment by a specified number of seconds. The current compiled and signed Cognos Validation Framework validator, which is used to validate the interaction parameters for the current fragment. new mode (e.g. view, edit, cps:config) new window state new view The name given to the resource, usually by the Creator or Publisher. The topic of the resource. Typically, subject will be expressed as keywords or phrases that describe the subject or content of the resource. A textual description of the content of the resource, including abstracts in the case of document-like objects or content descriptions in the case of visual resources. The category of the resource, such as home page, novel, poem, working paper, technical report, essay, dictionary. Information about a second resource from which the present resource is derived. An identifier of a second resource and its relationship to the present resource. This element is used to express linkages among related resources. The spatial or temporal characteristics of the intellectual content of the resource. Spatial coverage refers to a physical region using place names or coordinates (e.g., longitude and latitude). Temporal coverage refers to what the resource is about rather than when it was created or made available (the latter belonging in the Date element). A date associated with the creation or availability of the resource. Recommended best practice is defined in a profile of ISO 8601. The data format and, optionally, dimensions (e.g., size, duration) of the resource. A string or number used to uniquely identify the resource. The language of the intellectual content of the resource. Recommended best practice is defined in RFC 1766. The person or organization primarily responsible for creating the intellectual content of the resource. The entity responsible for making the resource available in its present form, such as a publishing house, a university department, or a corporate entity. A person or organization not specified in a Creator element who has made significant intellectual contributions to the resource but whose contribution is secondary to any person or organization specified in a Creator element A rights management statement, an identifier that links to a rights management statement, or an identifier that links to a service providing information about rights management for the resource. TODO: move display to meta/preferences Cognos Validation Framework rules that are global to all properties. Supported mimeTypes (e.g. text/html, text/xhtml) Supported modes (e.g. view, edit, cps:config) Supported window states (e.g. normal, maximized, minimized) A concise, human-readable description of the fragment. Intended purpose is for display in any Consumer-generated user interface for administering the Fragment. capabilities required to execute this fragment Description of customization properties, which control the fragment look and feel. Description of transient properties which are used to syncronize fragments Description of navigational properties which are used to pass runtime parameters to fragments This array provides the event names for the events the fragment could generate. While fragments are allowed to generate events that are not described in this array, fragment developers choosing to not declare what events could be generated should carefully consider scenarios involving Controllers where events are only distributed if the page designer (i.e. the application developer) explicitly says to distribute an event generated by one fragment to another set of fragments. The information in non-declared events will not be distributed by such Controllers since the page designer was unaware of them. This array provides the event names the fragments is willing to process. Each name specified is allowed to end with a "*" character to indicate the Portlet is willing to process any event whose name starts with the characters before the "*" character. Controller responsibilities are the same as the publishedEvents field. Description of event which are used to syncronize fragments A multilingual label for rendering properties split by group. This may also be used as a tab label. This is an array of ResourceType, each of which carries the values for a localized resource in various locales. A short, human-readable name for the property. Intended purpose is for display in any Consumer-generated user interface for administering the Fragment. A relatively short description of the property. Intended for display, for example, as a tooltip in any Consumer-generated user interface for editing the property. Type of the property, using a namespace qualified name. We would encourage these to either be from the set of schema-defined types or be explicitly typed in the schema element of an enclosing ModelDescription. Contains the default value for this property as a string. Contains the visual description of the control to be used along with any localised resources. Describes the validation rules for the property using the Cognos Validation Framework parameter syntax. Name of the property being described. The locale for this supplied localized value. The name assigned to this localized string for dereferencing into a ResourceList for values from other locales. When the resourceName is not supplied, there are no values for additional locales available in the ResourceList. The mime type of the returned markup. The mimeType field MUST be specified whenever markup is returned, and if the markupBinary field is used to return the markup, the mime type MUST include the character set for textual mime types using the syntax specified in RFC1522 (e.g. "text/html; charset=UTF-8"). The markup to be used for visualizing the current state of the Portlet. This is a string in order to support non-XML markup (e.g. HTML). The markup to be used for visualizing the current state of the Portlet. The markup to be used for visualizing the current state of the Portlet returned in binary. This is useful if the text is not easily mapped to the string type or an attachment scheme is in use that moves binary types into separate message parts (e.g. DIME). In the case of a static fragment that contains multiple markups, each markup section may be referenced by ID using the frag-markupid parameter. If ID is not specified, the first markup is used. Refers to a ControlGroupType's id. Assending ordering number. Controls the appearance (e.g. "full", "compact", "minimal" or "hidden") Relates this control(C) to an unique item(PI) of another control(P). In other words, brings (C) visually closer to (P)'s (PI) (i.e. sub-control). Resets another control(P) to an item(PI) when an action on this control(C) is invoked. This form control enables free-form data entry. This form control is used to provide the user with the ability to supply information to the system in a manner that makes it difficult for someone, other than the user, who may be observing the process to discern the value that is being supplied. A common use is for password entry. This form control enables free-form data entry and is intended for use in entering multiline content, e.g., the body of an email message. This form control allows selection from a sequential range of values. This form control allows the user to make multiple selections from a set of choices. This form control allows the user to make a single selection from multiple choices. This is an extension point to add new form control XML. The root element and XML namespace must match the qualified property datatype name. Attributes for form elements and items An array of the QNames of events known to be semantically equivalent to this event. While this can provide a hint to the Controller concerning potential items that could be correlated with this event, it remains the Controller's responsibility to do any transformations required to produce the described event. A localized, free form description of the event. Expected use of this field is for display at the Consumer to someone who will choose how this event is mapped to other events. A relatively short description of the event. Intended for display (for example, as a tooltip) in any Consumer-generated user interface for processing/distributing the event. A short, human-readable name for the event. Intended purpose is for display in any Consumergenerated user interface for processing/distributing the event. TBD The extensions field MAY be used to extend this structure. Extension elements MUST be from namespaces other than Fragment. A namespaced name for the event being described. If this event's payload is not carried within the NamedStringArray alternative of the EventPayload structure, this name also becomes the XML element name carrying the payload with the type field defining the type of the element. A reference to a schema-defined payload the event will carry at runtime. If the type is not supplied, the Consumer SHOULD treat this as an opaque event payload. Note that this includes those events which are signals and therefore carry no payload. TBD The wrapper element for the event's data. This is required to come from a namespace other than the Fragment namespace unless it can be carried within the NamedStringArray type (defined as an alternative for convenient serialization/deserialization of this common type). This optional field contains the data for the event. One example of when this field might not be included is when the event is simply a signal and the event's name thereby carries all of the semantics of the event. Its contents MUST conform to the schema referenced by the type field. The extensions field MAY be used to extend this structure. Extension elements MUST be from namespaces other than Fragment. The namespaced name of the event. A reference to a schema-defined type for the event's payload. Metadata description of page capabilities and resources. e.g. caption, margins, noedit, nomaximized, etc. Each member of this array provides the localized values for a resource. Each member of this array provides the value for the resource in a locale. The name of the resource for which this is a list of localized values. The value for this localized string in the declared locale. The locale for this localized value.