The OASIS Information Model specifies the logical structures of an OASIS Registry/Repository in terms of an Entity-Attribute-Relationship data model. The XML definitions specified herein, and the semantic rules associated with them, are defined in terms of the entities and attributes of that data model.
These ELEMENT's and DTD's are intended to be the basis of communication between a Submitting Organization and an OASIS conformant registry/repository, or between two conforming registry/repositories. The slightly different versions of each element provide an appropriate structure for each purpose.
There are at most three versions of each important entity, one for use in a submission of that entity from a submitting organization to a registry, one for representation of that entity in a nested XML document for registry-to-registry exchange, and one for representation of a set of entities in a flat file. The flat file representations generally require identifiers for each entity and pointers among entities to represent their relationships, whereas the submission and nested forms represent the relationships in the structured nesting of elements.
The XML Elements defined in this section correspond to the Entities of the Entity-Attribute-Relationship model defined by Section X.6, "Entity Semantics", of the OASIS Information Model. The attributes of those Entities are represented either as XML elements or as XML attributes, whichever seems most appropriate.
NOTE: The authors of this document do not feel confident about when it is best to represent something as an XML element and when it is better to represent it as an XML attribute. It will be straight-forward to do the right thing after some good discussions.
To define or represent a registry item instance.
<!ELEMENT
RegistryItemSubmit
(CommonName
, Description , Comment? )>
<!ATTLIST RegistryItemSubmit
Version CDATA #IMPLIED
ObjectLocation CDATA #REQUIRED
DefnSource (%defnSourceList;) #REQUIRED
PrimaryClass (%primaryClassList;) #REQUIRED
SubClass (%subClassList;) #IMPLIED
RelatedType (%relatedTypeList;) #IMPLIED
MimeType CDATA "text/xml"
Stability (%stabilityList;) #REQUIRED
PayStatus (%payStatusList;) "free"
ExpiryDate CDATA #IMPLIED
ResponsibleOrg CDATA #IMPLIED
ItemId ID #IMPLIED >
<!ELEMENT CommonName (#PCDATA
)>
<!ELEMENT Description (#PCDATA
)>
<!ELEMENT Comment (#PCDATA
)>
<!ELEMENT
RegistryItemInstance
(CommonName
, Description , Comment? )>
<!ATTLIST
RegItemInstance
ItemId ID #REQUIRED
AssignedURN CDATA #REQUIRED
Version CDATA #IMPLIED
ObjectLocation CDATA #IMPLIED
DefnSource (%defnSourceList;) #REQUIRED
PrimaryClass (%primaryClassList;) #REQUIRED
SubClass (%subClassList;) #IMPLIED
RelatedType (%relatedTypeList;) #IMPLIED
MimeType CDATA #REQUIRED
RegStatus (%regStatusList;) #REQUIRED
StatusChg CDATA #REQUIRED
Stability (%stabilityList;) #REQUIRED
PayStatus (%payStatusList;) #REQUIRED
ExpiryDate CDATA #REQUIRED
SubmittingOrg CDATA #REQUIRED
ResponsibleOrg CDATA #REQUIRED >
1. A submission of a proposed new registry item from a Submitting Organization (SO) to a Registry uses the RegistryItemSubmit element. An exchange or representation of an existing registry item uses the RegistryItemInstance element.
2. The ExpiryDate attribute in RegistryItemSubmit is only a suggestion by the SO. The RegistrationAuthority decides the ExpiryDate based on Registry policy.
3. The ObjectLocation attribute in RegistryItemSubmit may be a URL or FTP reference to a freely available (i.e. no password required) file, or it may be a local file reference to a file provided with the same submission.
4. Depending on the value of the PrimaryClass, the SubClass may sometimes be required. See the Semantic Rules for the RegistryItem entity in the information model.
5. If the registry item describes a registered object that has been withdrawn, then the ObjectLocation is not required in the RegistryItemInstance element. In all other cases, ObjectLocation is required.
6. The Comment element is intended for inclusion in the PublicComment attribute of the information model. Processing comments intended to be seen only by the RA may be included as normal XML comments; they will not be included in the PublicComment.
7. The ResponsibleOrg attribute in RegistryItemSubmit is a URN that identifies an organization known to the RA.
8. The SubmittingOrg and ResponsibleOrg attributes in RegistryItemInstance may each be either a URN that identifies an organization instance, or an IDREF that identifies an Organization element in the same XML document.
9. The ItemId attribute corresponds to the RAitemId attribute of the information model. It need be unique only within a given XML document.
To define or represent an association instance.
<!ELEMENT Association
(AssociatedItem,
Comment? )>
<!ATTLIST Association
GivenItemRole (%assocTypeList;) #REQUIRED >
<!ELEMENT
AssociatedItem (AssocItemURN | AssocItemId )>
<!ELEMENT AssocItemURN EMPTY>
<!ATTLIST
AssocItemURN
ItemURN CDATA #REQUIRED
ItemId IDREF #IMPLIED
>
<!ELEMENT AssocItemId EMPTY>
<!ATTLIST
AssocItemId
ItemId IDREF #REQUIRED
ItemURN CDATA #IMPLIED
>
<!ELEMENT
AssociationFlat
(AssociatedItem,
Comment? )>
<!ATTLIST
AssociationFlat
GivenItemId IDREF #REQUIRED
GivenItemURN CDATA #IMPLIED
GivenItemRole (%assocTypeList;) #REQUIRED >
1. A submission of a proposed new association instance from a Submitting Organization (SO) to a Registry uses the Association element. An exchange or representation of an existing association instance in a nested format, where the given item instance is known, uses the Association element. An exchange or representation of an existing association instance as a flat file uses the Association Flat element.
2. The ItemId attribute corresponds to the AssocItemId attribute of the information model. If present, it must identify a registry item element in the same XML document.
To define or represent a related data instance.
<!ELEMENT RelatedData (DataName
, Comment? )>
<!ATTLIST RelatedData
RelatedType (%relatedTypeList;) #REQUIRED
DataLocation
CDATA #REQUIRED
MimeType CDATA #REQUIRED >
<!ELEMENT DataName (#PCDATA
)>
<!ELEMENT
RelatedDataFlat (DataName
, Comment? )>
<!ATTLIST
RelatedDataFlat
RegItemId IDREF #REQUIRED
RegItemURN CDATA #IMPLIED
RelatedType (%relatedTypeList;) #REQUIRED
DataLocation
CDATA #REQUIRED
MimeType CDATA #REQUIRED >
1. A submission of a proposed new related data instance from a Submitting Organization (SO) to a Registry uses the RelatedData element. An exchange or representation of an existing related data instance in a nested format, where the given item instance is known, uses the RelatedData element. An exchange or representation of an existing association instance as a flat file uses the RelatedDataFlat element.
2. The RegItemId attribute corresponds to the implicit RAitemId attribute of the RelatedData entity in the information model. It must identify a RegistryItem element in the containing XML document.
3. The RegItemURN attribute, if present, must match the AssignedURN of the registry item identified by RegItemId.
4. A DataName element must have at least 1 visible character, and must uniquely identify that element within its containing XML document.
To define or represent a classification instance, or to define or represent a complete classification involving multiple classification instances.
<!ELEMENT Classification (
ClassifSimple | ClassifNested )>
<!ELEMENT ClassifSimple ( Comment?
)>
<!ATTLIST
ClassifSimple
SchemeURN CDATA #REQUIRED
ItemValue CDATA #REQUIRED
ItemName CDATA #IMPLIED
LevelCode CDATA #FIXED "leaf" >
<!ELEMENT ClassifNested (
LevelItemValue+ )>
<!ATTLIST
ClassifNested
SchemeURN CDATA #REQUIRED
SchemeName CDATA #IMPLIED >
<!ELEMENT
LevelItemValue ( Comment?
)>
<!ATTLIST
LevelItemValue
LevelCode CDATA "leaf"
ItemValue CDATA #REQUIRED
LevelNbr CDATA #IMPLIED
ItemName CDATA #IMPLIED >
<!ELEMENT
ClassificationFlat ( Comment?
)>
<!ATTLIST
ClassificationFlat
RegItemId IDREF #REQUIRED
RegItemURN CDATA #IMPLIED
SchemeURN CDATA #REQUIRED
SchemeId IDREF #IMPLIED
LevelCode CDATA #REQUIRED
ItemValue CDATA #REQUIRED
LevelNbr CDATA #IMPLIED
ItemName CDATA #IMPLIED >
1. A submission of a proposed new classification from a Submitting Organization (SO) to a Registry uses the Classification element. An exchange or representation of an existing classification in a nested format, where the given item instance is known, uses the Classification element. An exchange or representation of an existing classification instance as a flat file uses the ClassificationFlat element.
2. The SchemeName attribute, if present, must match the CommonName attribute of the registry item identified by SchemeURN.
3. The LevelNbr attribute, if present, must match the LevelNbr of the level identified by LevelCode.
4. The ItemName attribute, if present, must match the ItemName of the item identified by ItemValue.
5. The RegItemId attribute corresponds to the RAitemId attribute of the Classification entity in the information model. It must identify a RegistryItem element in the same XML document.
6. The RegItemURN attribute, if present, must match the AssignedURN of the registry item identified by RegItemId.
To define or represent an organization instance.
<!ELEMENT
OrganizationSubmit ( Comment?
)>
<!ATTLIST
OrganizationSubmit
OrgFullName CDATA #REQUIRED
OrgCommonName
CDATA #IMPLIED
OrgURL CDATA #IMPLIED
ParentOrgURN CDATA #IMPLIED
AddrLine1 CDATA #IMPLIED
AddrLine2 CDATA #IMPLIED
AddrLine3 CDATA #IMPLIED
City CDATA #IMPLIED
CityParent CDATA #IMPLIED
PostalCode CDATA #IMPLIED
Country CDATA #REQUIRED
Email CDATA #IMPLIED
Telephone CDATA #IMPLIED
Fax CDATA #IMPLIED >
<!ELEMENT
OrganizationInstance ( Comment?
)>
<!ATTLIST
OrganizationInstance
OrgId ID #REQUIRED
OrgURN CDATA #REQUIRED
OrgFullName CDATA #REQUIRED
OrgCommonName
CDATA #IMPLIED
OrgURL CDATA #IMPLIED
ParentOrgURN CDATA #IMPLIED
ParentOrgId IDREF #REQUIRED
AddrLine1 CDATA #IMPLIED
AddrLine2 CDATA #IMPLIED
AddrLine3 CDATA #IMPLIED
City CDATA #IMPLIED
CityParent CDATA #IMPLIED
PostalCode CDATA #IMPLIED
Country CDATA #REQUIRED
Email CDATA #IMPLIED
Telephone CDATA #IMPLIED
Fax CDATA #IMPLIED >
1. A submission for certification of an organization as a Submitting Organization (SO) to a Registry uses the OrganizationSubmit element. An exchange or representation of an organization already recognized by the Registration Authority (RA) uses the OrganizationInstance element.
2. The ParentOrgURN attribute of the OrganizationSubmit element, if present, must identify the OrgURN of an organization already known to the RA.
3. The ParentOrgId attribute of the OrganizationInstance element corresponds to the ParentOrg attribute of the Organization entity in the information model. It must identify an OrgInstance element in the containing XML document.
4. The ParentOrgURN attribute of the OrganizationInstance element, if present, must match the OrgURN of an organization element in the same XML document.
5. The OrgId attribute corresponds to the OrgId attribute of the Organization entity in the information model. It need be unique only within a given XML document.
To define or represent a contact instance.
<!ELEMENT Contact (Comment? )>
<!ATTLIST Contact
ContactName CDATA #REQUIRED
Email CDATA #REQUIRED
Telephone CDATA #IMPLIED
Fax CDATA #IMPLIED
OrgURN CDATA #IMPLIED
OrgRole (%orgRoleList;) "SO"
Availability
(%contactAvailList;) "public"
ContactRole (%contactRoleList;) "all" >
<!ELEMENT ContactNested (Comment?
)>
<!ATTLIST
ContactNested
ContactName CDATA #REQUIRED
OrgURN CDATA #REQUIRED
OrgRole (%orgRoleList;) #REQUIRED
SubmitId IDREF #IMPLIED
RequestNbr CDATA #IMPLIED
Availability
(%contactAvailList;) #REQUIRED
ContactRole (%contactRoleList;) #REQUIRED
Email CDATA #REQUIRED
Telephone CDATA #IMPLIED
Fax CDATA #IMPLIED
>
<!ELEMENT
ContactInstance (Comment?
)>
<!ATTLIST
ContactInstance
ContactId ID #REQUIRED
ContactName CDATA #REQUIRED
OrgId IDREF #REQUIRED
OrgURN CDATA #IMPLIED
OrgRole (%orgRoleList;) #REQUIRED
SubmitId IDREF #IMPLIED
RequestNbr CDATA #IMPLIED
Availability
(%contactAvailList;) #REQUIRED
ContactRole (%contactRoleList;) #REQUIRED
Email CDATA #REQUIRED
Telephone CDATA
#IMPLIED
Fax CDATA #IMPLIED >
1. A submission of a proposed new contact instance from a Submitting Organization (SO) to a Registry uses the Contact element. An exchange or representation of an existing contact instance in a nested format, where some parent item instance is known, uses the ContactNested element. An exchange or representation of an existing contact instance as a flat file uses the ContactInstance element.
2. The OrgURN attribute corresponds to the OrgId attribute of the Contact entity in the information model. If present, it is a URN that identifies an organization known to the RA.
3. The ContactId attribute corresponds to the ContactId attribute of the Contact entity in the information model. It need be unique only within a given XML document.
4. The SubmitId attribute corresponds to the implicit SubmitId attribute of the Submission entity in the information model. If present, it must identify a SubmissionInstance element in the containing XML document.
5. The RequestNbr attribute corresponds to the RequestNbr attribute of the Request entity in the information model. If present, it must identify a Request element in the containing XML document.
To define or represent an alternate name instance.
<!ELEMENT AlternateName
(
AltName, Comment? )>
<!ATTLIST AlternateName
Context (%nameContextList;) #REQUIRED
Language CDATA #IMPLIED
Encoding CDATA #IMPLIED
>
<!ELEMENT AltName (#PCDATA
)>
<!ELEMENT
AlternateNameFlat
(
AltName, Comment? )>
<!ATTLIST
AlternateNameFlat
RegItemId IDREF #REQUIRED
RegItemURN CDATA #IMPLIED
Context (%nameContextList;) #REQUIRED
Language CDATA #IMPLIED
Encoding CDATA #IMPLIED >
1. A submission of a proposed new alternate name instance from a Submitting Organization (SO) to a Registry uses the AlternateName element. An exchange or representation of an existing alternate name instance in a nested format, where some parent item instance is known, uses the AlternateName element. An exchange or representation of an existing alternate name instance as a flat file uses the AlternateNameFlat element.
2. The RegItemId attribute corresponds to the RAitemId attribute of the AlternateName entity in the information model. It must identify a RegistryItem element in the same XML document.
3. The RegItemURN attribute, if present, must match the AssignedURN of the registry item identified by RegItemId.
4. The AltName attribute must contain at least 1 visible character.
To define or represent an alternate description instance.
<!ELEMENT
AlternateDescription ( Description
)>
<!ATTLIST
AlternateDescription
Language CDATA #REQUIRED
Encoding CDATA #REQUIRED
>
<!ELEMENT AltDescriptionFlat (
Description )>
<!ATTLIST
AltDescriptionFlat
RegItemId IDREF #REQUIRED
RegItemURN CDATA #IMPLIED
Language CDATA #REQUIRED
Encoding CDATA #REQUIRED >
1. A submission of a proposed new alternate name instance from a Submitting Organization (SO) to a Registry uses the AlternateDescription element. An exchange or representation of an existing alternate name instance in a nested format, where some parent item instance is known, uses the AlternateDescription element. An exchange or representation of an existing alternate name instance as a flat file uses the AltDescriptionFlat element.
2. The RegItemId attribute corresponds to the RAitemId attribute of the AlternateName entity in the information model. It must identify a RegistryItem element in the same XML document.
3. The RegItemURN attribute, if present, must match the AssignedURN of the registry item identified by RegItemId.
4. The Description element must contain at least 1 visible character.
To represent a submission instance. It does not include the requests that make up the content of a submission.
<!ELEMENT
SubmissionInstance ( Comment?
)>
<!ATTLIST SubmissionInstance
SubmitId ID #REQUIRED
SubmitTime CDATA #REQUIRED
SubmitOrgId IDREF #IMPLIED
SubmitOrgURN CDATA #REQUIRED
>
1. The SubmissionInstance element is intended for use by Registration Authorities (RA) for Registry information representation and exchange. It should not be used by a Submitting Organization to specify a submission. Instead, the Submission DTD should be used.
2. The SubmitId attribute corresponds to the implicit SubmitId attribute of the Submission entity in the information model. It need be unique only within a given XML document.
3. The SubmitOrgId attribute corresponds to the SubmitOrg attribute of the Submission entity in the information model. If present, it must identify an Organization element in the containing XML document.
4. The SubmitOrgURN attribute corresponds to the SubmitOrg attribute of the Submission entity in the information model. It must identify an organization known to the RA.
To represent a request instance.
<!ELEMENT
RequestNested ( Comment? )
<!ATTLIST RequestNested
RequestCode (%requestCodeList;) #REQUIRED
ContentXML CDATA #IMPLIED >
<!ELEMENT RequestFlat ( Comment?
)
<!ATTLIST RequestFlat
SubmitId IDREF #REQUIRED
RequestNbr CDATA #REQUIRED
RequestCode (%requestCodeList;) #REQUIRED
ContentXML CDATA #IMPLIED >
1. The RequestInstance element is intended for use by Registration Authorities for Registry information representation and exchange. It should not be used by a Submitting Organization to specify a request as part of a submission. Instead, the Request element should be used.
2. The SubmitId attribute corresponds to the SubmitId attribute of the Submission entity in the information model. It must reference a SubmissionInstance element in the containing XML document.
3. The RequestNbr attribute corresponds to the RequestNbr attribute of the Request entity in the information model. If present, it must identify a Request element in the containing XML document.
To represent an impact instance.
<!ELEMENT Impact ( Comment?
)
<!ATTLIST Impact
RegItemId IDREF #IMPLIED
RegItemURN CDATA #REQUIRED
SubmitId IDREF #IMPLIED
RequestNbr CDATA #IMPLIED
ImpactCode (%impactCodeList;) #REQUIRED
1. The Impact element is intended for use by Registration Authorities for Registry information representation and exchange. It is completely determined by the Registration Authority and should not be used by a Submitting Organization as any part of a submission.
2. The RegItemId attribute corresponds to the RAitemId attribute of the Impact entity in the information model. If present, it must identify a RegistryItem element in the same XML document.
3. The RegItemURN attribute must match the AssignedURN of the registry item identified by RegItemId.
4. The (SubmitId, RequestNbr) pair, if present, must identify a Request element in the containing XML document.
To represent a classification scheme instance. It does not include the levels or items of the classification scheme.
<!ELEMENT
ClassifSchemeInstance ( Comment?
)
<!ATTLIST
ClassifSchemeInstance
SchemeURN CDATA #REQUIRED
CommonName CDATA #IMPLIED
SchemeId IDREF #IMPLIED >
1. The ClassifSchemeInstance element is intended for use by Registration Authorities for Registry information representation and exchange. It cannnot be used by a Submitting Organization to define a classification scheme as part of a submission request. Instead, the DefineClassificationScheme element must be used.
2. The SchemeURN attribute corresponds to the SchemeURN attribute of the ClassificationScheme entity in the information model. It must be equal to the AssignedURN of a registry item in the Registry.
3. The CommonName attribute, if present, must be equal to the CommonName of the registry item identified by the SchemeURN.
4. The SchemeId attribute corresponds to the implicit RAitemId attribute of the ClassificationScheme entity in the information model. If present, it must match the ItemId of a RegistryItem element in the containing XML document.
To define, identify, or exchange a
classification level instance. It does not include the item values defined for
that level.
<!ELEMENT
ClassificationLevel ( Comment?
)>
<!ATTLIST
ClassificationLevel
LevelCode CDATA #REQUIRED
LevelName CDATA #IMPLIED
LevelNbr CDATA #IMPLIED
>
<!ELEMENT
ClassificationLevelFlat ( Comment?
)>
<!ATTLIST
ClassificationLevelFlat
SchemeURN CDATA #REQUIRED
SchemeId IDREF #IMPLIED
LevelCode CDATA #REQUIRED
LevelName CDATA #IMPLIED
LevelNbr CDATA #IMPLIED >
1. A submission of a proposed new classification level instance from a Submitting Organization (SO) to a Registry uses the ClassificationLevel element. An exchange or representation of an existing classification level instance in a nested format, where the parent classification scheme is known, uses the ClassificationLevel element. An exchange or representation of an existing classification level instance as a flat file uses the ClassificationLevelFlat element.
2. If a ClassificationLevel element is part of a DefineClassificationScheme element, then the LevelCode and LevelName attributes define a level code and a level name for the indicated level of the classification scheme, and the LevelNbr, if present, specifies an explicit level number to represent that level.
3. If a ClassificationLevel element is not part of a DefineClassificationScheme element, then the LevelName attribute, if present, must be the LevelName of the level identified by the LevelCode.
4. If a ClassificationLevel element is not part of a DefineClassificationScheme element, then the LevelNbr attribute, if present, must be the LevelNbr of the level identified by the LevelCode.
5. The SchemeURN attribute corresponds to the SchemeURN attribute of the ClassificationScheme entity in the information model. It must be equal to the AssignedURN of a registry item in the Registry.
6. The SchemeId attribute corresponds to the RAitemId attribute of the ClassificationScheme entity in the information model. If present, it must match the ItemId of some RegistryItem element in the containing XML document.
To define, identify, or represent a classification item instance.
<!ELEMENT
ClassificationItem ( Comment?
)>
<!ATTLIST
ClassificationItem
ItemValue CDATA #REQUIRED
ItemName CDATA #IMPLIED
LevelNbr CDATA #IMPLIED
LevelCode CDATA #IMPLIED
>
<!ELEMENT ClassificationItemFlat ( Comment?
)>
<!ATTLIST
ClassificationItemFlat
SchemeURN CDATA #REQUIRED
SchemeId IDREF #IMPLIED
ItemId ID #REQUIRED
ItemValue CDATA #REQUIRED
ParentId IDREF #REQUIRED
ItemName CDATA #IMPLIED
LevelNbr CDATA #IMPLIED
LevelCode CDATA #IMPLIED
>
1. A submission of a proposed new classification item instance from a Submitting Organization (SO) to a Registry uses the ClassificationItem element. An exchange or representation of an existing classification item instance in a nested format, where the parent classification scheme is known, uses the ClassificationItem element. An exchange or representation of an existing classification item instance in a flat file uses the ClassificationItemFlat element.
2. If a ClassificationItem element is part of a DefineClassificationScheme element, then the ItemValue and ItemName attributes define an item value and an item name for the parent classification scheme.
3. If a ClassificationItem element is not part of a DefineClassificationScheme element, then the ItemName must match the ItemName for the classification item determined by the ItemValue.
4. The LevelCode and LevelNbr attributes, if present in a ClassificationItem element, must identify the level of the classification item in the parent classification scheme.
5. The LevelCode and LevelNbr attributes, if present in a ClassificationItemFlat element, must identify the level of the classification item in the classification scheme identified by the SchemeURN.
6. The ItemName attribute, if present, must match the ItemName of the classification item identified by ItemValue.
7. The RegItemId attribute, if present, corresponds to the RAitemId attribute of the Classification entity in the information model. It must identify a RegistryItem element in the same XML document.
8. The RegItemURN attribute must match the AssignedURN of the registry item identified by RegItemId.
To define or represent the public metadata, in a nested format, for a single registry item.
<!ELEMENT
RegistryMetadataSubmit
( RegistryItemSubmit ,
Association* ,
Classification* ,
RelatedData* ,
AlternateName* ,
AlternateDescription* )>
<!ELEMENT
RegistryMetadataInstance
( RegistryItemInstance ,
Association* ,
Classification* ,
RelatedData* ,
AlternateName* ,
AlternateDescription* )>
1. The association instances represented by the Association elements are all related to the registry item instance represented by the RegistryItemSubmit or the RegistryItemInstance element.
2. The classification instances represented by the Classification elements are all related to the registry item instance represented by the RegistryItemSubmit or the RegistryItemInstance element.
3. The related data instances represented by the RelatedData elements are all related to the registry item instance represented by the RegIistrytemSubmit or the RegistryItemInstance element.
4. The alternate name instances represented by the AlternateName elements are all related to the registry item instance represented by the RegistryItemSubmit or the RegistryItemInstance element.
5. The alternate description instances represented by the AlternateDescription elements are all related to the registry item instance represented by the RegistryItemSubmit or the RegistryItemInstance element.
To define or exchange a repository instance.
[NOT COMPLETE]
1. [NOT COMPLETE]
2. [NOT COMPLETE]
To submit a collection of one or more requests to a Registry, to identify one or more contacts able to address issues related to that submission, and optionally, to identify one or more specific contacts for each request.
<!ELEMENT Submission ( Request+,
Contact+ )>
<!ATTLIST Submission
SubmitOrgURL CDATA
#REQUIRED >
<!ELEMENT Request
( (
AddAlternateDescription
| AddAlternateName
| AddAssociation
| AddClassification
| AddRelatedData
|
CertifySubmittingOrg
|
DefineClassificationScheme
| DefinePackage
|
DeleteAlternateDescription
|
DeleteAlternateName
|
DeleteAssociation
|
DeleteClassification
| DeleteRelatedData
|
ModifyClassificationScheme
| ModifyPackage
| ModifyRegistryItem
| RegisterObject
|
ReplaceRegisteredObject
|
SupersedeRegisteredObject
|
WithdrawRegisteredObject ),
Contact*,
Comment? )>
1. [NOT COMPLETE]
2. [NOT COMPLETE]
To propose a query to a Registry/Repository, with the expectation of receiving back a query response.
<!ELEMENT Query [NOT COMPLETE] >
1. [NOT COMPLETE]
2. [NOT COMPLETE]
To define or represent a complete classification scheme as a hierarchy of nodes.
<!ELEMENT
ClassificationScheme
( Comment?,
ClassificationNode+
)>
<!ATTLIST
ClassificationScheme
SchemeName CDATA
#IMPLIED >
<!ELEMENT
ClassificationNode
( ClassificationItem, ClassificationNode* )>
1. The nested hierarchy of levels and nodes determines the hierarchical structure of a complete classification scheme.
2. The SchemeName, if present, identifies the CommonName of the classification scheme.
3. [NOT COMPLETE]
<!--
A simple named and coded
classification
scheme for Student Status
in a University
FR Freshman
SO Sophomore
JR Junior
SR Senior
SP Special
Subclassification of
Special student
D Degree seeking
N Non-Degree seeking
-->
<ClassificationScheme
SchemeName="StudentStatus">
<Comment>
A named and coded
classification scheme for student status.
With Special student
status further subclassified.
</Comment>
<ClassificationLevel
LevelNbr="1" LevelCode="Primary"/>
<ClassificationLevel
LevelNbr="2" LevelCode="Secondary"/>
<ClassificationNode>
<ClassificationItem
ItemValue="FR" ItemName="Freshman"/>
</ClassificationNode>
<ClassificationNode>
<ClassificationItem
ItemValue="SO" ItemName="Sophomore"/>
</ClassificationNode>
<ClassificationNode>
<ClassificationItem
ItemValue="JR" ItemName="Junior"/>
</ClassificationNode>
<ClassificationNode>
<ClassificationItem
ItemValue="SR" ItemName="Senior"/>
</ClassificationNode>
<ClassificationNode>
<ClassificationItem
ItemValue="SP" ItemName="Special"/>
<ClassificationNode>
<ClassificationItem ItemValue="D"
ItemName="Degree"/>
</ClassificationNode>
<ClassificationNode>
<ClassificationItem ItemValue="N"
ItemName="Non-Degree"/>
</ClassificationNode>
</ClassificationNode>
</ClassificationScheme>
<Classification>
<ClassifNested SchemeURN="StudentStatus">
<LevelItemValue
LevelCode="Primary" ItemValue="SP"/>
<LevelItemValue
LevelCode="Secondary" ItemValue="N"/>
</ClassifNested>
</Classification>
To represent a complete and consistent subset of a Registry as a collection of flat tables.
<!ELEMENT
RegistryContentFlat
(
RegistryItemInstance* ,
AssociationFlat* ,
RelatedDataFlat* ,
AlternateNameFlat* ,
AltDescriptionFlat* ,
ClassifSchemeInstance* ,
ClassificationLevelFlat* ,
ClassificationItemFlat* ,
ClassificationFlat* ,
OrganizationInstance* ,
ContactInstance* ,
SubmissionInstance* ,
RequestFlat* ,
Impact* )>
<!ATTLIST
RegistryContentFlat
RegistryURN CDATA #REQUIRED >
1. [NOT COMPLETE]
2. [NOT COMPLETE]
To represent a complete and consistent subset of a Registry as a collection of hierarchically structured elements.
<!ELEMENT
RegistryContentNested
(
RegistryMetadataInstance* ,
OrganizationAndContacts* ,
ClassificationScheme* ,
SubmissionHistory*,
Impact* )>
<!ATTLIST
RegistryContentNested
RegistryURN CDATA #REQUIRED >
<!ELEMENT
OrganizationandContacts
(
OrganizationInstance, ContactNested+ )>
<!ELEMENT
SubmissionHistory
( SubmissionInstance, ContactNested+, RequestSummary+ )>
<!ELEMENT
RequestSummary
( RequestNested, ContactNested* )>
1. [NOT COMPLETE]
2. [NOT COMPLETE]
To add one or more new alternate descriptions for an existing registry item.
<!ELEMENT
AddAlternateDescription (
AlternateDescription+ )>
<!ATTLIST AddAlternateDescription
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To add one or more new alternate names for an existing registry item.
<!ELEMENT
AddAlternateName (
AlternateName+ )>
<!ATTLIST
AddAlternateName
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To add one or more new associations for an existing registry item.
<!ELEMENT
AddAssociation (
Association+ )>
<!ATTLIST
AddAssociation
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To add one or more new classifications for an existing registry item.
<!ELEMENT
AddClassification (
Classification+ )>
<!ATTLIST
AddClassification
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To add one or more new related data items to an existing registry item.
<!ELEMENT
AddRelatedData (
RelatedData+ )>
<!ATTLIST
AddRelatedData
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To request certification from a Registration Authority to be a Submitting Organization for a Registry managed by that Registration Authority.
<!ELEMENT
CertifySubmittingOrg
( OrganizationSubmit, Contact+ )>
1. First Rule
2. Second Rule
To define and register one or more new classification schemes.
<!ELEMENT
DefineClassificationScheme
( RegistryMetadataSubmit, ClassificationScheme )>
1. First Rule
2. Second Rule
To define and register one or more new packages of registered objects.
<!ELEMENT DefinePackage ( RegistryMetadataSubmit,
Package )>
<!ELEMENT Package (
PackageItem* )>
<!ELEMENT PackageItem
( AssignedURN | PkgItemRef | RegistryMetadataSubmit )>
<!ELEMENT AssignedURN
(#PCDATA)>
<!ELEMENT PkgItemRef EMPTY >
<!ATTLIST ItemRef
ItemId IDREF #REQUIRED >
1. First Rule
2. Second Rule
To delete one or more alternate descriptions from the metadata for an existing registry item.
<!ELEMENT
DeleteAlternateDescription ( Language*
)>
<!ATTLIST
DeleteAlternateDescription
AssignedURN CDATA #REQUIRED>
<!ELEMENT Language (#PCDATA)>
1. First Rule
2. Second Rule
To delete one or more alternate names from the metadata for an existing registry item.
<!ELEMENT
DeleteAlternateName ( (AltName,
Context)* )>
<!ATTLIST
DeleteAlternateName
AssignedURN CDATA #REQUIRED>
<!ELEMENT Context (#PCDATA)>
1. First Rule
2. Second Rule
To delete one or more associations from the metadata for an existing registry item.
<!ELEMENT
DeleteAssociation
(
(GivenItemRole, AssociatedItemURN)* )>
<!ATTLIST
DeleteAssociation
AssignedURN CDATA #REQUIRED>
<!ELEMENT GivenItemRole (#PCDATA)>
<!ELEMENT AssociatedItemURN (#PCDATA)>
1. First Rule
2. Second Rule
To delete one or more classifications from the metadata for an existing registry item.
<!ELEMENT
DeleteClassification (
SchemeURN* )>
<!ATTLIST DeleteClassification
AssignedURN CDATA #REQUIRED>
<!ELEMENT SchemeURN (#PCDATA)>
1. First Rule
2. Second Rule
To delete one or more related data items from the metadata for an existing registry item.
<!ELEMENT
DeleteRelatedData ( DataName*
)>
<!ATTLIST
DeleteRelatedData
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To modify the definition of an existing classification scheme.
<!ELEMENT
ModifyClassificationScheme
( ( AddLevels | AddNodes | DeleteLevels | DeleteNodes)+ )>
<!ATTLIST
ModifyClassificationScheme
AssignedURN CDATA #REQUIRED>
<!ELEMENT AddLevels (
ClassificationLevel+ )>
<!ELEMENT AddNodes (
ClassificationNode+ )>
<!ELEMENT DeleteLevels ( LevelRef
)>
<!ELEMENT DeleteNodes ( (
LevelRef, ItemRef)+ )>
<!ELEMENT LevelRef EMPTY >
<!ATTLIST LevelRef
LevelCode CDATA "leaf" >
<!ELEMENT ItemRef EMPTY >
<!ATTLIST ItemRef
ItemValue CDATA #REQUIRED >
1. First Rule
2. Second Rule
To modify the contents of an existing package.
<!ELEMENT ModifyPackage ( ( AddItem
| DeleteItem )+ )>
<!ATTLIST ModifyPackage
AssignedURN CDATA #REQUIRED>
<!ELEMENT AddItem (
PackageItem+ )>
<!ELEMENT DeleteItem ( AssignedURN+ )>
1. First Rule
2. Second Rule
To modify the attributes of an existing registry item.
<!ELEMENT
ModifyRegistryItem (
RegistryItemSubmit )>
<!ATTLIST
ModifyRegistryItem
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To provide all of the necessary metadata to register a new object in a Registry. The object itself may or may not be included, depending on whether the Registry is also acting as a Repository for that object.
<!ELEMENT
RegisterObject (
RegistryMetadataSubmit, ObjectFile? )>
<!ELEMENT ObjectFile ANY >
<!ATTLIST ObjectFile
MimeType CDATA #IMPLIED >
1. First Rule
2. Second Rule
To replace an existing registered object with a new object having new metadata, leaving a modified version of the metadata for the old object in the Registry.
<!ELEMENT
ReplaceRegisteredObject
(
RegistryMetadataSubmit, ObjectFile? )>
<!ATTLIST
ReplaceRegisteredObject
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To supersede an existing registered object with a new object having new metadata, leaving the old object in its Repository, and a modified version of the metadata for the old object in the Registry.
<!ELEMENT
SupersedeRegisteredObject (
RegistryMetadataSubmit )>
<!ATTLIST
SupersedeRegisteredObject
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
To withdraw a registered object, leaving a modified version of its metadata in the Registry.
<!ELEMENT
WithdrawRegisteredObject EMPTY>
<!ATTLIST
WithdrawRegisteredObject
AssignedURN CDATA #REQUIRED>
1. First Rule
2. Second Rule
<!ENTITY %
assocTypeList
"uses
| supersedes | contains | related"
>
Source |
Code |
Name |
Description |
OASIS |
contains |
Contains |
Given
item is a package that contains the associated item. |
OASIS |
related |
Related |
Given
item is related to associated item and provides supplemental information for
the associated item. |
OASIS |
supersedes |
Supersedes |
Given
item supersedes associated item. |
OASIS |
uses |
Uses |
Given
item uses associated item. |
<!ENTITY %
contactAvailList
"public | priv | prot " >
Source |
Code |
Name |
Description |
OASIS |
priv |
Private |
Contact
available only to SO and RA. |
OASIS |
prot |
Protected |
Contact
available only to RA's. |
OASIS |
public |
Public |
Contact
available to all users of registry. |
<!ENTITY %
contactRoleList
"admin | all | tech" >
Source |
Code |
Name |
Description |
OASIS |
admin |
Administrative |
Contact
addresses only administrative issues. |
OASIS |
all |
All
Issues |
Contact
addresses all issues. |
OASIS |
tech |
Technical |
Contact
addresses only technical issues. |
<!ENTITY %
defnSourceList
"
OASIS | IMS | IEEE_LOM | EBXML " >
SourceCode |
SourceName |
Description |
EBXML |
|
Author of the EBXML Registry/Repository specification. |
IEEE_LOM |
IEEE Learning Technology - Learning Object Model |
Author of the IEEE LOM Registry specification. |
IMS |
|
Author of the IMS Registry specification. |
OASIS |
Organization for the Advancement of Structured Information Standards |
Author of the OASIS Registry/Repository specification. |
<!ENTITY %
impactCodeList
"
DAD | DAN | DAS | DCF | DCT | DRD | DRI |
IAD | IAN | IAS | ICF | ICT | IRD | IRI |
UAD | UAN | UAS | UCF | UCT | URD | URI
" >
Source |
Code |
Name |
Description |
OASIS |
DAD |
Delete
Alternate Description |
|
OASIS |
DAN |
Delete
Alternate Name |
|
OASIS |
DAS |
Delete
Association |
|
OASIS |
DCF |
Delete
Classification |
|
OASIS |
DCT |
Delete
Contact |
|
OASIS |
DRD |
Delete
Related Data |
|
OASIS |
DRI |
Delete
Registry Item |
|
OASIS |
IAD |
Insert
Alternate Description |
|
OASIS |
IAN |
Insert
Alternate Name |
|
OASIS |
IAS |
Insert
Association |
|
OASIS |
ICF |
Insert
Classification |
|
OASIS |
ICT |
Insert
Contact |
|
OASIS |
IRD |
Insert
Related Data |
|
OASIS |
IRI |
Insert
Registry Item |
|
OASIS |
UAD |
Update
Alternate Description |
|
OASIS |
UAN |
Update
Alternate Name |
|
OASIS |
UAS |
Update
Association |
|
OASIS |
UCF |
Update
Classification |
|
OASIS |
UCT |
Update
Contact |
|
OASIS |
URD |
Update
Related Data |
|
OASIS |
URI |
Update
Registry Item |
|
<!ENTITY %
nameContextList
"c++
| code | java | lang | long | short | sql | urn" >
Source |
Code |
Name |
Description |
OASIS |
c++ |
C++
Name |
For
C++ usage |
OASIS |
code |
Code
Name |
Without
spaces |
OASIS |
java |
Java
Name |
For
Java usage |
OASIS |
lang |
Language
Name |
In
a human language |
OASIS |
long |
Long
Name |
1
to 150 characters |
OASIS |
short |
Short
Name |
1
to 50 characters |
OASIS |
sql |
SQL
Name |
For
SQL usage |
OASIS |
urn |
Uniform
Resource Name |
Globally
unique |
<!ENTITY % orgRoleList
"
SO | RO | RA " >
Source |
Code |
Name |
Description |
OASIS |
RA |
Registration
Authority |
|
OASIS |
RO |
Responsible
Organization |
|
OASIS |
SO |
Submitting
Organization |
|
<!ENTITY %
payStatusList
"debit |
free | password" >
Source |
Code |
Name |
Description |
OASIS |
debit |
Debit |
The
registered object is available on-line, but requires payment of a fee before
access is granted. |
OASIS |
free |
Free |
The
registered object is freely available with no password or payment required. |
OASIS |
pswd |
Password |
The
registered object is free, but password is required for retrieval. |
<!ENTITY %
primaryClassList
"defn
| inst | pkg | other" >
Source |
Code |
Name |
Description |
OASIS |
defn |
Definition |
An XSGML definition document. |
OASIS |
inst |
Instance |
An XSGML instance document. |
OASIS |
pkg |
Package |
A package of OASIS registered items. |
OASIS |
other |
Other |
A document related to a registered item. |
<!ENTITY %
regStatusList
"exp
| reg | rep | sub | sup | wth" >
Source |
Code |
Name |
Description |
OASIS |
exp |
Expired |
|
OASIS |
reg |
Registered |
|
OASIS |
rep |
Replaced |
|
OASIS |
sub |
Submitted |
|
OASIS |
sup |
Superseded |
|
OASIS |
wth |
Withdrawn |
|
<!ENTITY %
relatedTypeList
"changeLog | cvrLetter | faq |
whitePaper | userGuide " >
Source |
Code |
Name |
Description |
OASIS |
Changelog |
changelog |
|
OASIS |
CvrLetter |
cover-letter |
|
OASIS |
DistribHP |
distribution-home-page |
|
OASIS |
DocSet |
documentation-set |
|
OASIS |
DocSetInfo |
documentation-set-information |
|
OASIS |
DSSLSS |
dssl-style-sheet |
|
OASIS |
DSSLSSinfo |
dssl-style-sheet-information |
|
OASIS |
EmailInfo |
email-discussion-list-information |
|
OASIS |
Example |
example |
|
OASIS |
ExpSet |
example-set |
|
OASIS |
ExpSetInfo |
example-set-information |
|
OASIS |
FAQ |
faq |
|
OASIS |
Other |
other |
|
OASIS |
PublicText |
public-text |
|
OASIS |
ReadMe |
readme |
|
OASIS |
RefMan |
reference-manual |
|
OASIS |
RegInfo |
registration-information |
|
OASIS |
RelDataGrp |
related-data-group |
|
OASIS |
SchemaHP |
schema-home-page |
|
OASIS |
SGMLdeclar |
sgml-declaration |
|
OASIS |
SGMLopnCat |
sgml-open-catalogue |
|
OASIS |
StyleSinfo |
style-sheet-information |
|
OASIS |
ToolInfo |
tool-information |
|
OASIS |
UserGuide |
user-guide |
|
OASIS |
WhitePaper |
white-paper |
|
OASIS |
XSLSS |
xsl-style-sheet |
|
OASIS |
XSLSSinfo |
xsl-style-sheet-information |
|
<!ENTITY %
requestCodeList
" addAltDesc | addAltName |
addAssoc | addClassif |
addRelData | certSO | defClassif | defPkg |
delAssoc | delAltDesc | delAltName |
delClassif |
delRelData | modClassif | modPkg |
modReg |
regObj | repReg | supReg |
wdrReg " >
Source |
Code |
Name |
Description |
OASIS |
addAltDesc |
Add
Alternate Description |
|
OASIS |
addAltName |
Add
Alternate Name |
|
OASIS |
addAssoc |
Add
Association |
|
OASIS |
addClassif |
Add
Classification |
|
OASIS |
addRelData |
Add
Related Data |
|
OASIS |
certSO |
Certify
Submitting Org |
|
OASIS |
defClassif |
Define
Classification Scheme |
|
OASIS |
defPkg |
Define
Package |
|
OASIS |
delAssoc |
Delete
Association |
|
OASIS |
delAltDesc |
Delete
Alternate Description |
|
OASIS |
delAltName |
Delete
Alternate Name |
|
OASIS |
delClassif |
Delete
Classification |
|
OASIS |
delRelData |
Delete
Related Data |
|
OASIS |
modClassif |
Modify
Classification Scheme |
|
OASIS |
modPkg |
Modify
Package |
|
OASIS |
modReg |
Modify
Registration |
|
OASIS |
regObj |
Register
Object |
|
OASIS |
repReg |
Replace
Registered Object |
|
OASIS |
supReg |
Supersede
Registered Object |
|
OASIS |
wdrReg |
Withdraw
Registered Object |
|
OASIS |
x
etc. |
Other |
|
<!ENTITY % subClassList
" xmlDTD | sgmlDTD | xmlSchema | xdrSchema |
soxSchema | rdfSchema | sgmlElement |
xmlElement | sgmlAttrib | xmlAttrib |
sgmlAttSet | xmlAttSet | sgmlAttVal |
xmlAttVal | sgmlParm | xmlParm |
charEntSet" >
Source |
Code |
Name |
Description |
OASIS |
charEntSet |
character-entity-set |
|
OASIS |
rdfSchema |
rdf-schema |
|
OASIS |
sgmlAttrib |
sgml-attribute |
|
OASIS |
sgmlAttSet |
sgml-enumerated-attribute-set |
|
OASIS |
sgmlAttVal |
sgml-enumerated-attribute-value |
|
OASIS |
sgmlDTD |
sgml-dtd |
|
OASIS |
sgmlElem |
sgml-element |
|
OASIS |
sgmlParm |
sgml-parameter-entity |
|
OASIS |
soxSchema |
sox-schema |
|
OASIS |
xdrSchema |
xdr-schema |
|
OASIS |
xmlAttrib |
xml-attribute |
|
OASIS |
xmlAttSet |
xml-enumerated-attribute-set |
|
OASIS |
xmlAttVal |
xml-enumerated-attribute-value |
|
OASIS |
xmlDTD |
xml-dtd |
|
OASIS |
xmlElem |
xml-element |
|
OASIS |
xmlParm |
xml-parameter-entity |
|
OASIS |
xmlSchema |
xml-schema |
|
<!ENTITY %
stabilityList
"comp
| dynm | stat">
Source |
Code |
Name |
Description |
OASIS |
comp |
Compatible |
Registered
object may be replaced only by an upward compatible object. |
OASIS |
dynm |
Dynamic |
Registered
object may change at any time. |
OASIS |
stat |
Static |
Registered
object will not change before expiration. |
AddAlternateDescription, 34
AddAlternateName, 35
AddAssociation, 36
AddClassification, 37
AddItem, 48
AddLevels, 47
AddNodes, 47
AddRelatedData, 38
AltDescriptionFlat, 17
AlternateDescription, 17
AlternateName, 16
AlternateNameFlat, 16
AltName, 16
AssociatedItem, 8
AssociatedItemURN, 44
Association, 8
AssociationFlat, 8
AssocItemId, 8
AssocItemURN, 8
assocTypeList, 54
CertifySubmittingOrg, 39
Classification, 10
ClassificationFlat, 10
ClassificationItem, 24
ClassificationItemFlat, 24
ClassificationLevel, 22
ClassificationLevelFlat, 22
ClassificationNode, 30
ClassificationScheme, 30
ClassifNested, 10
ClassifSchemeInstance, 21
ClassifSimple, 10
Comment, 6
CommonName, 6
Contact, 14
contactAvailList, 54
ContactInstance, 14
ContactNested, 14
contactRoleList, 54
DataName, 9
DefineClassificationScheme, 40
DefinePackage, 41
defnSourceList, 55
DeleteAlternateDescription, 42
DeleteAlternateName, 43
DeleteAssociation, 44
DeleteClassification, 45
DeleteItem, 48
DeleteLevels, 47
DeleteNodes, 47
DeleteRelatedData, 46
Description, 6
GivenItemRole, 44
Impact, 20
impactCodeList, 56
ItemRef, 47
LevelItemValue, 10
LevelRef, 47
ModifyClassificationScheme, 47
ModifyPackage, 48
ModifyRegistryItem, 49
nameContextList, 56
ObjectFile, 50
OrganizationandContacts, 33
OrganizationInstance, 12
OrganizationSubmit, 12
orgRoleList, 57
Package, 41
PackageItem, 41
payStatusList, 57
PkgItemRef, 41
primaryClassList, 58
Query, 29
RegisterObject, 50
RegistryContentFlat, 32
RegistryContentNested, 33
RegistryItemInstance, 6
RegistryItemSubmit, 6
RegistryMetadataInstance, 26
RegistryMetadataSubmit, 26
regStatusList, 58
RelatedData, 9
RelatedDataFlat, 9
relatedTypeList, 58
ReplaceRegisteredObject, 51
Request, 28
requestCodeList, 60
RequestFlat, 19
RequestNested, 19
RequestSummary, 33
stabilityList, 61
subClassList, 60
Submission, 28
SubmissionHistory, 33
SubmissionInstance, 18
SupersedeRegisteredObject, 52
WithdrawRegisteredObject, 53