Showing:

Annotations
Attributes
Diagrams
Facets
Properties

Table of Contents

Group by:

http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0

Resource hierarchy:

Main schema ebcore-au-v1.0.xsd
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This XML Schema relates to the OASIS ebCore Agreement Update Specification, see:

http://docs.oasis-open.org/ebcore/ebcore-au/v1.0/.

Properties
attribute form default unqualified
element form default qualified
[ top ]
Element au:AgreementUpdateRequest
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This element is an XML document root element that defines a request to update an existing agreement. It references a current agreement using its identifier and proposes a new indentifier to be used for an updated version of the agreement. That updated agreement is to be created by taking the content of the current agreement and applying one or several updates to it.

The configuration data of the current agreement is not exchanged in the message. It is assumed that this data is known and shared by the communication partners. Partners are not required to use the same storage mechanism or syntax to store the configuration information. The update requests define the semantics of the requested update which both partners are to apply.

An agreement update request can succeed or fail. The result of processing an update request is communicated using an AgreementUpdateResponse or an AgreementUpdateException . An agreement update is atomic, meaning either all requests have been applied or none.

Diagram
Diagram au.tmp#ID au.tmp#CreatedAt au.tmp#RespondBy au.tmp#ActivateBy au.tmp#ExpireBy au.tmp#CurrentAgreementIdentifier au.tmp#UpdatedAgreementIdentifier au.tmp#Reason au.tmp#UpdateRequest
Properties
content complex
Children au:ActivateBy, au:CreatedAt, au:CurrentAgreementIdentifier, au:ExpireBy, au:ID, au:Reason, au:RespondBy, au:UpdateRequest, au:UpdatedAgreementIdentifier
[ top ]
Element au:ID
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

Provides an identifier for the document. The identifier SHOULD be globally unique. It MUST be unique for the parties involved in the agreement.

Diagram
Diagram
Type xs:token
Properties
content simple
[ top ]
Element au:CreatedAt
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

The date and time at which the document was created.
Diagram
Diagram
Type xs:dateTime
Properties
content simple
[ top ]
Element au:RespondBy
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This element defines the date and time before which the responder MUST respond to the agreement update request.

Diagram
Diagram
Type xs:dateTime
Properties
content simple
[ top ]
Element au:ActivateBy
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

In a request, this optional element MAY be used to defines the date and time at which the initiator wishes to activitate the new agreement. If absent, the initiator MUST have deployed the new agreement before sending an update request to the communication partner, and the partner MAY start using the new agreement immediately.

Diagram
Diagram
Type xs:dateTime
Properties
content simple
[ top ]
Element au:ExpireBy
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This optional element defines the date and time at which the agreement will expire. If absent, no explicit expiration date is set for the agreement.

Diagram
Diagram
Type xs:dateTime
Properties
content simple
[ top ]
Element au:CurrentAgreementIdentifier
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

The identifier of a current agreement, to which an update is, or multiple updates are, being requested.

Diagram
Diagram au.tmp#non-empty-string au.tmp#AgreementIdentifierType_type au.tmp#AgreementIdentifierType
Type au:AgreementIdentifierType
Type hierarchy
Properties
content complex
Attributes
QName Type Use Annotation
type xs:anyURI optional
This attribute support messaging protocols that specify an attribute that indicates how the parties sending and receiving the message will interpret the agreement value. There is no restriction on the value of the type attribute; this choice is left to profiles of this specification or depends on the messaging protocol used for the agreement.
[ top ]
Element au:UpdatedAgreementIdentifier
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

The identifier of an agreement to be created by copying the current agreement configuration, applying all requested updates and then changing the agreement identifier to the indicated value.

Diagram
Diagram au.tmp#non-empty-string au.tmp#AgreementIdentifierType_type au.tmp#AgreementIdentifierType
Type au:AgreementIdentifierType
Type hierarchy
Properties
content complex
Attributes
QName Type Use Annotation
type xs:anyURI optional
This attribute support messaging protocols that specify an attribute that indicates how the parties sending and receiving the message will interpret the agreement value. There is no restriction on the value of the type attribute; this choice is left to profiles of this specification or depends on the messaging protocol used for the agreement.
[ top ]
Element au:Reason
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

A description, in natural language, of the reason for the request, or other free form textual information potentially useful for processing the request.

Diagram
Diagram au.tmp#non-empty-string
Type extension of au:non-empty-string
Type hierarchy
Properties
content complex
Attributes
QName Type Use Annotation
xml:lang xs:language required
In due course, we should install the relevant ISO 2- and 3-letter codes as the enumerated possible values . . .
[ top ]
Element au:UpdateRequest
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This element identifies a single update to be applied to an agreement. It is an abstract element that can be sub-classed for specific types of updates using the XML schema substitution mechanism.

Diagram
Diagram au.tmp#UpdateRequestType_id au.tmp#UpdateRequestType
Type au:UpdateRequestType
Properties
content complex
abstract true
Attributes
QName Type Use Annotation
id xs:ID required

Provides an identifier to the UpdateRequest, allowing errors in an AgreementUpdateException to reference a specific request they relate to.

[ top ]
Element au:AgreementUpdateResponse
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This is the root element of the positive response to an update request.

The values for CurrentAgreementIdentifier and UpdatedAgreementIdentifier MUST be identical to the corresponding values in the AgreementUpdateRequest.

Diagram
Diagram au.tmp#ID au.tmp#ReferenceID au.tmp#CreatedAt au.tmp#CurrentAgreementIdentifier au.tmp#UpdatedAgreementIdentifier
Properties
content complex
Children au:CreatedAt, au:CurrentAgreementIdentifier, au:ID, au:ReferenceID, au:UpdatedAgreementIdentifier
[ top ]
Element au:ReferenceID
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This element is used in AgreementUpdateResponse and AgreementUpdateException document. It MUST be set to the ID of the AgreementUpdateRequest document that these documents relate to.

Diagram
Diagram
Type xs:token
Properties
content simple
[ top ]
Element au:AgreementUpdateException
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This is the root element of the negative response to an update request.

The values for CurrentAgreementIdentifier and UpdatedAgreementIdentifier MUST be identical to the corresponding values in the request.

Diagram
Diagram au.tmp#ID au.tmp#ReferenceID au.tmp#CreatedAt au.tmp#CurrentAgreementIdentifier au.tmp#UpdatedAgreementIdentifier au.tmp#Error
Properties
content complex
Children au:CreatedAt, au:CurrentAgreementIdentifier, au:Error, au:ID, au:ReferenceID, au:UpdatedAgreementIdentifier
[ top ]
Element au:Error
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This element reports an error.
Diagram
Diagram au.tmp#Error_errorCode au.tmp#Error_severity au.tmp#Error_shortDescription au.tmp#Error_refToUpdateInError au.tmp#Description au.tmp#ErrorDetail
Properties
content complex
Children au:Description, au:ErrorDetail
Attributes
QName Type Use Annotation
errorCode xs:token required
A code for the error.
refToUpdateInError xs:token optional
References a specific UpdateRequest using its id.
severity xs:token required
The severity of the error. Values include Failure and Warning.
shortDescription xs:token optional
A short description for the error.
[ top ]
Element au:Description
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

A description of the error in natural language.
Diagram
Diagram au.tmp#non-empty-string
Type extension of au:non-empty-string
Type hierarchy
Properties
content complex
Attributes
QName Type Use Annotation
xml:lang xs:language required
In due course, we should install the relevant ISO 2- and 3-letter codes as the enumerated possible values . . .
[ top ]
Element au:ErrorDetail
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This element allows more detailed explanation of errors.
Diagram
Diagram au.tmp#non-empty-string
Type au:non-empty-string
Properties
content simple
Facets
minLength 1
[ top ]
Element au:AgreementTerminationRequest
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This element is an XML document root element that defines a request to terminate an existing agreement. It references a current agreement using its identifier. The reason for the request can be communicated using the Reason element.

An agreement termination request can succeed or fail. The result of processing an update request is communicated using an AgreementTerminationResponse or an AgreementTerminationException.

Diagram
Diagram au.tmp#ID au.tmp#CreatedAt au.tmp#RespondBy au.tmp#TerminateBy au.tmp#CurrentAgreementIdentifier au.tmp#Reason
Properties
content complex
Children au:CreatedAt, au:CurrentAgreementIdentifier, au:ID, au:Reason, au:RespondBy, au:TerminateBy
[ top ]
Element au:TerminateBy
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

In a request, this optional element MAY be used to defines the date and time at which the initiator wishes to terminate the agreement. If absent, the responder MUST terminate the agreement as soon as possible.

Diagram
Diagram
Type xs:dateTime
Properties
content simple
[ top ]
Element au:AgreementTerminationResponse
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This is the root element of the positive response to a termination request.

The value for CurrentAgreementIdentifier MUST be identical to the corresponding value in the AgreementTerminationRequest.

Diagram
Diagram au.tmp#ID au.tmp#ReferenceID au.tmp#CreatedAt au.tmp#TerminateBy au.tmp#CurrentAgreementIdentifier
Properties
content complex
Children au:CreatedAt, au:CurrentAgreementIdentifier, au:ID, au:ReferenceID, au:TerminateBy
[ top ]
Element au:AgreementTerminationException
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

This is the root element of the negative response to a termination request.

The value for CurrentAgreementIdentifier MUST be identical to the corresponding value in the AgreementTerminationRequest.

Diagram
Diagram au.tmp#ID au.tmp#ReferenceID au.tmp#CreatedAt au.tmp#TerminateBy au.tmp#CurrentAgreementIdentifier au.tmp#Error
Properties
content complex
Children au:CreatedAt, au:CurrentAgreementIdentifier, au:Error, au:ID, au:ReferenceID, au:TerminateBy
[ top ]
Complex Type au:AgreementIdentifierType
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

An agreement identifier is a non-empty-string value, possibly qualified using a type attribute. If the type attribute is not present, some protocols require that the string content of the agreement identifier element MUST be a URI.

Diagram
Diagram au.tmp#non-empty-string au.tmp#AgreementIdentifierType_type
Type extension of au:non-empty-string
Type hierarchy
Attributes
QName Type Use Annotation
type xs:anyURI optional
This attribute support messaging protocols that specify an attribute that indicates how the parties sending and receiving the message will interpret the agreement value. There is no restriction on the value of the type attribute; this choice is left to profiles of this specification or depends on the messaging protocol used for the agreement.
[ top ]
Simple Type au:non-empty-string
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Diagram
Diagram
Type restriction of xs:string
Facets
minLength 1
[ top ]
Complex Type au:UpdateRequestType
Namespace http://docs.oasis-open.org/ebcore/ns/AgreementUpdate/v1.0
Annotations

An abstract update request type. It is to be subclassed for specific update types.
Diagram
Diagram au.tmp#UpdateRequestType_id
Properties
abstract true
Attributes
QName Type Use Annotation
id xs:ID required

Provides an identifier to the UpdateRequest, allowing errors in an AgreementUpdateException to reference a specific request they relate to.

[ top ]
Attribute au:AgreementIdentifierType / @type
Namespace No namespace
Annotations
This attribute support messaging protocols that specify an attribute that indicates how the parties sending and receiving the message will interpret the agreement value. There is no restriction on the value of the type attribute; this choice is left to profiles of this specification or depends on the messaging protocol used for the agreement.
Type xs:anyURI
Properties
use optional
[ top ]
Attribute au:UpdateRequestType / @id
Namespace No namespace
Annotations

Provides an identifier to the UpdateRequest, allowing errors in an AgreementUpdateException to reference a specific request they relate to.

Type xs:ID
Properties
use required
[ top ]
Attribute au:Error / @errorCode
Namespace No namespace
Annotations
A code for the error.
Type xs:token
Properties
use required
[ top ]
Attribute au:Error / @severity
Namespace No namespace
Annotations
The severity of the error. Values include Failure and Warning.
Type xs:token
Properties
use required
[ top ]
Attribute au:Error / @shortDescription
Namespace No namespace
Annotations
A short description for the error.
Type xs:token
Properties
use optional
[ top ]
Attribute au:Error / @refToUpdateInError
Namespace No namespace
Annotations
References a specific UpdateRequest using its id.
Type xs:token
Properties
use optional
[ top ]