javax.xml.registry.infomodel
Interface RegistryObject

All Superinterfaces:

ExtensibleObject, java.io.Serializable

All Known Subinterfaces:

Association, AuditableEvent, Classification, ClassificationScheme, Concept, ExternalIdentifier, ExternalLink, ExtrinsicObject, Organization, RegistryEntry, RegistryPackage, Service, ServiceBinding, SpecificationLink, User

public interface RegistryObject

extends ExtensibleObject, java.io.Serializable

The RegistryObject class is an abstract base class used by most classes in the model. It provides minimal metadata for registry objects. It also provides methods for accessing related objects that provide additional dynamic metadata for the registry object.

See Also:

RegistryEntry

Method Summary

void	addAssociation(Association association) Adds specified Association to use this object as source.
void	addAssociations(java.util.Collection associations) Adds specified Associations to use this object as source Silently replaces the sourceObject in Associations with reference to this object.
void	addClassification(Classification classification) Adds specified Classification to this object.
void	addClassifications(java.util.Collection classifications) Adds specified Classifications to this object.
void	addExternalIdentifier(ExternalIdentifier externalIdentifier) Adds specified ExternalIdentifier as an external identifier to this object.
void	addExternalIdentifiers(java.util.Collection externalIdentifiers) Adds specified ExternalIdentifiers as an external identifiers to this object.
void	addExternalLink(ExternalLink externalLink) Adds specified ExternalLink to this object.
void	addExternalLinks(java.util.Collection externalLinks) Adds specified ExternalLinks to this object.
java.util.Collection	getAssociatedObjects() Returns the collection of Objects associated with this object.
java.util.Collection	getAssociations() Gets all Associations where this object is source.
java.util.Collection	getAuditTrail() Returns the complete audit trail of all requests that effected a state change in this object as an ordered Collection of AuditableEvent objects.
java.util.Collection	getClassifications() Gets the Classification that classify this object.
Connection	getConnection() Returns the Connection associated with this object.
InternationalString	getDescription() Gets the textual description for this object.
java.util.Collection	getExternalIdentifiers() Returns the ExternalIdentifiers associated with this object that are external identifiers for this object.
java.util.Collection	getExternalLinks() Returns the ExternalLinks associated with this object.
Key	getKey() Gets the key representing the universally unique ID (UUID) for this object.
InternationalString	getName() Gets user friendly name of this object.
Concept	getObjectType() Gets the pre-defined object type that best describes the RegistryObject.
Organization	getOrganization() Gets the Organization that submitted this RegistryObject.
java.util.Collection	getPackages() Returns the Package associated with this object.
void	removeAssociation(Association association) Removes specified Association from this object.
void	removeAssociations(java.util.Collection associations) Removes specified Associations from this object.
void	removeClassification(Classification classification) Removes specified Classification from this object.
void	removeClassifications(java.util.Collection classifications) Removes specified Classifications from this object.
void	removeExternalIdentifier(ExternalIdentifier externalIdentifier) Removes specified ExternalIdentifier as an external identifier from this object.
void	removeExternalIdentifiers(java.util.Collection externalIdentifiers) Removes specified ExternalIdentifiers as an external identifiers from this object.
void	removeExternalLink(ExternalLink externalLink) Removes specified ExternalLink from this object.
void	removeExternalLinks(java.util.Collection externalLinks) Removes specified ExternalLinks from this object.
void	setAssociations(java.util.Collection associations) Replaces all previous Associations from this object with specified Associations.
void	setClassifications(java.util.Collection classifications) Replaces all previous Classifications with specified Classififications.
void	setDescription(InternationalString description) Sets the context independent textual description for this object.
void	setExternalIdentifiers(java.util.Collection externalIdentifiers) Replaces all previous external identifiers with specified Collection of ExternalIdentifiers as an external identifiers.
void	setExternalLinks(java.util.Collection externalLinks) Replaces all previous ExternalLinks with specified Classififications.
void	setKey(Key key) Sets the key representing the universally unique ID (UUID) for this object.
void	setName(InternationalString name) Sets user friendly name of object in repository.
java.lang.String	toXML() Returns a registry provider specific XML representation of this Object.

Methods inherited from interface javax.xml.registry.infomodel.ExtensibleObject

addSlot, addSlots, getSlot, getSlotAt, getSlots, removeSlot, removeSlots

Method Detail

getKey

public Key getKey()
           throws JAXRException

Gets the key representing the universally unique ID (UUID) for this object.

Capability Level: 0

getDescription

public InternationalString getDescription()
                                   throws JAXRException

Gets the textual description for this object.

Capability Level: 0

Returns:

InternationalString which must not be null.

setDescription

public void setDescription(InternationalString description)
                    throws JAXRException

Sets the context independent textual description for this object.

Capability Level: 0

getName

public InternationalString getName()
                            throws JAXRException

Gets user friendly name of this object.

Capability Level: 0

Returns:

InternationalString which must not be null.

setName

public void setName(InternationalString name)
             throws JAXRException

Sets user friendly name of object in repository.

Capability Level: 0

setKey

public void setKey(Key key)
            throws JAXRException

Sets the key representing the universally unique ID (UUID) for this object.

Capability Level: 1

toXML

public java.lang.String toXML()
                       throws JAXRException

Returns a registry provider specific XML representation of this Object. This may be used as a last resort back door way to get to a provider specific information element that is not accessible via the API. Implementation may choose to throw a UnsupportedCapabilityException.

Capability Level: 0

addClassification

public void addClassification(Classification classification)
                       throws JAXRException

Adds specified Classification to this object. Silently replaces the classifiedObject in Classification with reference to this object.

Capability Level: 0

addClassifications

public void addClassifications(java.util.Collection classifications)
                        throws JAXRException

Adds specified Classifications to this object. Silently replaces the classifiedObject in Classifications with reference to this object.

Capability Level: 0

removeClassification

public void removeClassification(Classification classification)
                          throws JAXRException

Removes specified Classification from this object.

Capability Level: 0

removeClassifications

public void removeClassifications(java.util.Collection classifications)
                           throws JAXRException

Removes specified Classifications from this object.

Capability Level: 0

setClassifications

public void setClassifications(java.util.Collection classifications)
                        throws JAXRException

Replaces all previous Classifications with specified Classififications.

Capability Level: 0

getClassifications

public java.util.Collection getClassifications()
                                        throws JAXRException

Gets the Classification that classify this object.

Capability Level: 0

See Also:

Classification

getAuditTrail

public java.util.Collection getAuditTrail()
                                   throws JAXRException

Returns the complete audit trail of all requests that effected a state change in this object as an ordered Collection of AuditableEvent objects.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

See Also:

AuditableEvent

addAssociation

public void addAssociation(Association association)
                    throws JAXRException

Adds specified Association to use this object as source. Silently replaces the sourceObject in Association with reference to this object.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

addAssociations

public void addAssociations(java.util.Collection associations)
                     throws JAXRException

Adds specified Associations to use this object as source Silently replaces the sourceObject in Associations with reference to this object.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

removeAssociation

public void removeAssociation(Association association)
                       throws JAXRException

Removes specified Association from this object.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

removeAssociations

public void removeAssociations(java.util.Collection associations)
                        throws JAXRException

Removes specified Associations from this object.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

setAssociations

public void setAssociations(java.util.Collection associations)
                     throws JAXRException

Replaces all previous Associations from this object with specified Associations.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

getAssociations

public java.util.Collection getAssociations()
                                     throws JAXRException

Gets all Associations where this object is source.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

getAssociatedObjects

public java.util.Collection getAssociatedObjects()
                                          throws JAXRException

Returns the collection of Objects associated with this object.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

addExternalIdentifier

public void addExternalIdentifier(ExternalIdentifier externalIdentifier)
                           throws JAXRException

Adds specified ExternalIdentifier as an external identifier to this object. Silently replaces the registryObject in ExternalIdentifier with reference to this object.

Capability Level: 0

addExternalIdentifiers

public void addExternalIdentifiers(java.util.Collection externalIdentifiers)
                            throws JAXRException

Adds specified ExternalIdentifiers as an external identifiers to this object. Silently replaces the registryObject in ExternalIdentifiers with reference to this object.

Capability Level: 0

removeExternalIdentifier

public void removeExternalIdentifier(ExternalIdentifier externalIdentifier)
                              throws JAXRException

Removes specified ExternalIdentifier as an external identifier from this object.

Capability Level: 0

removeExternalIdentifiers

public void removeExternalIdentifiers(java.util.Collection externalIdentifiers)
                               throws JAXRException

Removes specified ExternalIdentifiers as an external identifiers from this object.

Capability Level: 0

setExternalIdentifiers

public void setExternalIdentifiers(java.util.Collection externalIdentifiers)
                            throws JAXRException

Replaces all previous external identifiers with specified Collection of ExternalIdentifiers as an external identifiers.

Capability Level: 0

getExternalIdentifiers

public java.util.Collection getExternalIdentifiers()
                                            throws JAXRException

Returns the ExternalIdentifiers associated with this object that are external identifiers for this object.

Capability Level: 0

addExternalLink

public void addExternalLink(ExternalLink externalLink)
                     throws JAXRException

Adds specified ExternalLink to this object.

Capability Level: 0

addExternalLinks

public void addExternalLinks(java.util.Collection externalLinks)
                      throws JAXRException

Adds specified ExternalLinks to this object.

Capability Level: 0

removeExternalLink

public void removeExternalLink(ExternalLink externalLink)
                        throws JAXRException

Removes specified ExternalLink from this object.

Capability Level: 0

removeExternalLinks

public void removeExternalLinks(java.util.Collection externalLinks)
                         throws JAXRException

Removes specified ExternalLinks from this object.

Capability Level: 0

setExternalLinks

public void setExternalLinks(java.util.Collection externalLinks)
                      throws JAXRException

Replaces all previous ExternalLinks with specified Classififications.

Capability Level: 0

getExternalLinks

public java.util.Collection getExternalLinks()
                                      throws JAXRException

Returns the ExternalLinks associated with this object.

Capability Level: 0

getObjectType

public Concept getObjectType()
                      throws JAXRException

Gets the pre-defined object type that best describes the RegistryObject.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

getOrganization

public Organization getOrganization()
                             throws JAXRException

Gets the Organization that submitted this RegistryObject.

getPackages

public java.util.Collection getPackages()
                                 throws JAXRException

Returns the Package associated with this object.

Capability Level: 1

This method may throw UnsupportedCapabilityException in lower capability levels.

getConnection

public Connection getConnection()
                         throws JAXRException

Returns the Connection associated with this object.

Capability Level: 0