Top Description Methods
javax.xml.registry.infomodel

public Interface RegistryObject

extends ExtensibleObject
Known Direct Subinterfaces
javax.xml.registry.infomodel.ServiceBinding, javax.xml.registry.infomodel.SpecificationLink, javax.xml.registry.infomodel.User, javax.xml.registry.infomodel.Association, javax.xml.registry.infomodel.AuditableEvent, javax.xml.registry.infomodel.Classification, javax.xml.registry.infomodel.Concept, javax.xml.registry.infomodel.ExternalIdentifier, javax.xml.registry.infomodel.ExternalLink, javax.xml.registry.infomodel.Organization, javax.xml.registry.infomodel.RegistryEntry
Imports
java.io.*, java.net.*, javax.xml.registry.*, java.util.*
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.
Author
Farrukh S. Najmi
See Also
RegistryEntry

Method Summary

Modifier and TypeMethod and Description
public void
addAssociation(Association
the Association being added
association)

Adds specified Association to use this object as source.

public void
addAssociations(Collection<E>
the Collection of Associations being added
associations)

Adds specified Associations to use this object as source.

public void
addClassification(Classification
the Classification being added
classification)

Adds specified Classification to this object.

public void
addClassifications(Collection<E>
the Collection of Classifications being added
classifications)

Adds specified Classifications to this object.

public void
addExternalIdentifier(ExternalIdentifier
the ExternalIdentifier being added
externalIdentifier)

Adds specified ExternalIdentifier as an external identifier to this object.

public void
addExternalIdentifiers(Collection<E>
the Collection of ExternalIdentifiers being added
externalIdentifiers)

Adds specified ExternalIdentifiers as an external identifiers to this object.

public Collection<E>

Returns:

Collection of RegistryObject instances. The Collection may be empty but not null.
getAssociatedObjects()

Returns the collection of RegistryObject instances associated with this object.

public Collection<E>

Returns:

Collection of Association instances. The Collection may be empty but not null.
getAssociations()

Gets all Associations where this object is source.

public Collection<E>

Returns:

Collection of AuditableEvent instances. The Collection may be empty but not null.
getAuditTrail()

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

public Collection<E>

Returns:

Collection of Classification instances. The Collection may be empty but not null.
getClassifications()

Gets the Classification instances that classify this object.

public InternationalString

Returns:

the description for this object which must not be null
getDescription()

Gets the textual description for this object.

public Collection<E>

Returns:

Collection of ExternalIdentifier instances. The Collection may be empty but not null.
getExternalIdentifiers()

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

public Key

Returns:

the Key for this object
getKey()

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

public LifeCycleManager

Returns:

the LifeCycleManager objet that created this object
getLifeCycleManager()

Returns the LifeCycleManager that created this object.

public InternationalString

Returns:

the name for this object which must not be null.
getName()

Gets the user-friendly name of this object.

public Concept

Returns:

the object type as a Concept within the pre-defined ClassificationScheme named ObjectType
getObjectType()

Gets the object type that best describes the RegistryObject.

public Collection<E>

Returns:

Collection of RegistryPackage instances. The Collection may be empty but not null.
getRegistryPackages()

Returns the Package associated with this object.

public Organization

Returns:

the Organization that submitted this object to the registry
getSubmittingOrganization()

Gets the Organization that submitted this RegistryObject.

public void
removeAssociation(Association
the Association being removed
association)

Removes specified Association from this object.

public void
removeAssociations(Collection<E>
the Collection of Associations being removed
associations)

Removes specified Associations from this object.

public void
removeClassification(Classification
the Classification being removed
classification)

Removes specified Classification from this object.

public void
removeClassifications(Collection<E>
the Collection of Classifications being removed
classifications)

Removes specified Classifications from this object.

public void
removeExternalIdentifier(ExternalIdentifier
the ExternalIdentifier being removed
externalIdentifier)

Removes specified ExternalIdentifier as an external identifier from this object.

public void
removeExternalIdentifiers(Collection<E>
the Collection of ExternalIdentifiers being removed
externalIdentifiers)

Removes specified ExternalIdentifiers as an external identifiers from this object.

public void
setAssociations(Collection<E>
the Collection of Associations being set
associations)

Replaces all previous Associations from this object with specified Associations.

public void
setClassifications(Collection<E>
the Collection of Classifications being set
classifications)

Replaces all previous Classifications with specified Classifications.

public void
setDescription(InternationalString
the description for this object
description)

Sets the context independent textual description for this object.

public void
setExternalIdentifiers(Collection<E>
the Collection of ExternalIdentifiers being set
externalIdentifiers)

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

public void
setKey(Key
the key for this object
key)

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

public void
setName(InternationalString
the name for this object
name)

Sets user-friendly name of object in repository.

public String

Returns:

the String containing the XML representation for this object
toXML()

Returns a registry provider specific XML representation of this Object.

Inherited from javax.xml.registry.infomodel.ExtensibleObject:
addSlotaddSlotsgetSlotgetSlotsremoveSlotremoveSlots

Method Detail

addAssociationback to summary
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: 0
Parameters
association:Association

the Association being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addAssociationsback to summary
public void addAssociations(Collection<E> 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: 0
Parameters
associations:Collection<E>

the Collection of Associations being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addClassificationback to summary
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
Parameters
classification:Classification

the Classification being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addClassificationsback to summary
public void addClassifications(Collection<E> classifications) throws JAXRException

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

Capability Level: 0
Parameters
classifications:Collection<E>

the Collection of Classifications being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addExternalIdentifierback to summary
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
Parameters
externalIdentifier:ExternalIdentifier

the ExternalIdentifier being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addExternalIdentifiersback to summary
public void addExternalIdentifiers(Collection<E> 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
Parameters
externalIdentifiers:Collection<E>

the Collection of ExternalIdentifiers being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addExternalLinkback to summary
public void addExternalLink(ExternalLink externalLink) throws JAXRException

Adds specified ExternalLink to this object.

Capability Level: 0
Parameters
externalLink:ExternalLink

the ExternalLink being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addExternalLinksback to summary
public void addExternalLinks(Collection<E> externalLinks) throws JAXRException

Adds specified ExternalLinks to this object.

Capability Level: 0
Parameters
externalLinks:Collection<E>

the Collection of ExternalLinks being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getAssociatedObjectsback to summary
public Collection<E> getAssociatedObjects() throws JAXRException

Returns the collection of RegistryObject instances associated with this object.

Capability Level: 1
This method must throw UnsupportedCapabilityException in lower capability levels.
Returns:Collection<E>

Collection of RegistryObject instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.RegistryObject
getAssociationsback to summary
public Collection<E> getAssociations() throws JAXRException

Gets all Associations where this object is source.

Capability Level: 0
Returns:Collection<E>

Collection of Association instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.Association
getAuditTrailback to summary
public Collection<E> 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 must throw UnsupportedCapabilityException in lower capability levels.
Returns:Collection<E>

Collection of AuditableEvent instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.AuditableEvent
getClassificationsback to summary
public Collection<E> getClassifications() throws JAXRException

Gets the Classification instances that classify this object.

Capability Level: 0
Returns:Collection<E>

Collection of Classification instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.Classification
getDescriptionback to summary
public InternationalString getDescription() throws JAXRException

Gets the textual description for this object.

Capability Level: 0
Returns:InternationalString

the description for this object which must not be null

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getExternalIdentifiersback to summary
public Collection<E> getExternalIdentifiers() throws JAXRException

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

Capability Level: 0
Returns:Collection<E>

Collection of ExternalIdentifier instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.ExternalIdentifier
getExternalLinksback to summary
public Collection<E> getExternalLinks() throws JAXRException

Returns the ExternalLinks associated with this object.

Capability Level: 0
Returns:Collection<E>

Collection of ExternalLink instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.ExternalLink
getKeyback to summary
public Key getKey() throws JAXRException

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

Capability Level: 0
Returns:Key

the Key for this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getLifeCycleManagerback to summary
public LifeCycleManager getLifeCycleManager() throws JAXRException

Returns the LifeCycleManager that created this object.

Capability Level: 0
Returns:LifeCycleManager

the LifeCycleManager objet that created this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getNameback to summary
public InternationalString getName() throws JAXRException

Gets the user-friendly name of this object.

Capability Level: 0
Returns:InternationalString

the name for this object which must not be null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getObjectTypeback to summary
public Concept getObjectType() throws JAXRException

Gets the object type that best describes the RegistryObject.

Capability Level: 1
This method must throw UnsupportedCapabilityException in lower capability levels.
Returns:Concept

the object type as a Concept within the pre-defined ClassificationScheme named ObjectType

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getRegistryPackagesback to summary
public Collection<E> getRegistryPackages() throws JAXRException

Returns the Package associated with this object.

Capability Level: 1
This method must throw UnsupportedCapabilityException in lower capability levels.
Returns:Collection<E>

Collection of RegistryPackage instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.RegistryPackage
getSubmittingOrganizationback to summary
public Organization getSubmittingOrganization() throws JAXRException

Gets the Organization that submitted this RegistryObject.

Returns:Organization

the Organization that submitted this object to the registry

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeAssociationback to summary
public void removeAssociation(Association association) throws JAXRException

Removes specified Association from this object.

Capability Level: 0
Parameters
association:Association

the Association being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeAssociationsback to summary
public void removeAssociations(Collection<E> associations) throws JAXRException

Removes specified Associations from this object.

Capability Level: 0
Parameters
associations:Collection<E>

the Collection of Associations being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeClassificationback to summary
public void removeClassification(Classification classification) throws JAXRException

Removes specified Classification from this object.

Capability Level: 0
Parameters
classification:Classification

the Classification being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeClassificationsback to summary
public void removeClassifications(Collection<E> classifications) throws JAXRException

Removes specified Classifications from this object.

Capability Level: 0
Parameters
classifications:Collection<E>

the Collection of Classifications being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeExternalIdentifierback to summary
public void removeExternalIdentifier(ExternalIdentifier externalIdentifier) throws JAXRException

Removes specified ExternalIdentifier as an external identifier from this object.

Capability Level: 0
Parameters
externalIdentifier:ExternalIdentifier

the ExternalIdentifier being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeExternalIdentifiersback to summary
public void removeExternalIdentifiers(Collection<E> externalIdentifiers) throws JAXRException

Removes specified ExternalIdentifiers as an external identifiers from this object.

Capability Level: 0
Parameters
externalIdentifiers:Collection<E>

the Collection of ExternalIdentifiers being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeExternalLinkback to summary
public void removeExternalLink(ExternalLink externalLink) throws JAXRException

Removes specified ExternalLink from this object.

Capability Level: 0
Parameters
externalLink:ExternalLink

the ExternalLink being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeExternalLinksback to summary
public void removeExternalLinks(Collection<E> externalLinks) throws JAXRException

Removes specified ExternalLinks from this object.

Capability Level: 0
Parameters
externalLinks:Collection<E>

the Collection of ExternalLinks being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setAssociationsback to summary
public void setAssociations(Collection<E> associations) throws JAXRException

Replaces all previous Associations from this object with specified Associations.

Capability Level: 0
Parameters
associations:Collection<E>

the Collection of Associations being set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setClassificationsback to summary
public void setClassifications(Collection<E> classifications) throws JAXRException

Replaces all previous Classifications with specified Classifications.

Capability Level: 0
Parameters
classifications:Collection<E>

the Collection of Classifications being set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setDescriptionback to summary
public void setDescription(InternationalString description) throws JAXRException

Sets the context independent textual description for this object.

Capability Level: 0
Parameters
description:InternationalString

the description for this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setExternalIdentifiersback to summary
public void setExternalIdentifiers(Collection<E> externalIdentifiers) throws JAXRException

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

Capability Level: 0
Parameters
externalIdentifiers:Collection<E>

the Collection of ExternalIdentifiers being set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setExternalLinksback to summary
public void setExternalLinks(Collection<E> externalLinks) throws JAXRException

Replaces all previous ExternalLinks with specified ExternalLinks.

Capability Level: 0
Parameters
externalLinks:Collection<E>

the Collection of ExternalLinks being set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setKeyback to summary
public void setKey(Key key) throws JAXRException

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

Capability Level: 0
Parameters
key:Key

the key for this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setNameback to summary
public void setName(InternationalString name) throws JAXRException

Sets user-friendly name of object in repository.

Capability Level: 0
Parameters
name:InternationalString

the name for this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
toXMLback to summary
public 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
Returns:String

the String containing the XML representation for this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error