RegistryPackage | Java Web Services in a Nutshell

RegistryObject

javax.xml.registry.infomodel

JAXR 1.0; JWSDP 1.0, J2EE 1.4

 public interface RegistryObject extends ExtensibleObject {  // Property Accessor Methods (by property name)  public abstract Collection getAssociatedObjects(  )        throws javax.xml.registry.JAXRException;  //L1  public abstract Collection getAssociations(  )        throws javax.xml.registry.JAXRException;  //L0  public abstract void setAssociations(Collection   associations   )        throws javax.xml.registry.JAXRException;  //L0  public abstract Collection getAuditTrail(  )        throws javax.xml.registry.JAXRException;  //L1  public abstract Collection getClassifications(  )        throws javax.xml.registry.JAXRException;  //L0  public abstract void setClassifications(Collection   classifications   )        throws javax.xml.registry.JAXRException;  //L0  public abstract InternationalString getDescription(  )        throws javax.xml.registry.JAXRException;  //L0  public abstract void setDescription(InternationalString   description   )        throws javax.xml.registry.JAXRException;  //L0  public abstract Collection getExternalIdentifiers(  )        throws javax.xml.registry.JAXRException;  //L0  public abstract void setExternalIdentifiers(Collection   externalIdentifiers   )        throws javax.xml.registry.JAXRException;  //L0  public abstract Collection getExternalLinks(  )        throws javax.xml.registry.JAXRException;  //L0  public abstract void setExternalLinks(Collection   externalLinks   )        throws javax.xml.registry.JAXRException;  //L0  public abstract javax.xml.registry.infomodel.Key getKey(  )        throws javax.xml.registry.JAXRException;  //L0  public abstract void setKey(javax.xml.registry.infomodel.Key   key   )        throws javax.xml.registry.JAXRException;  //L0  public abstract javax.xml.registry.LifeCycleManager getLifeCycleManager(  )         throws javax.xml.registry.JAXRException;  //L0  public abstract InternationalString getName(  )        throws javax.xml.registry.JAXRException;  //L0  public abstract void setName(InternationalString   name   )        throws javax.xml.registry.JAXRException;  //L0  public abstract Concept getObjectType(  )        throws javax.xml.registry.JAXRException;  //L1  public abstract Collection getRegistryPackages(  )        throws javax.xml.registry.JAXRException;  //L1  public abstract Organization getSubmittingOrganization(  )        throws javax.xml.registry.JAXRException;  // Public Instance Methods  public abstract void addAssociation(Association   association   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void addAssociations(Collection   associations   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void addClassification(Classification   classification   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void addClassifications(Collection   classifications   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void addExternalIdentifier(ExternalIdentifier   externalIdentifier   )             throws javax.xml.registry.JAXRException;  //L0  public abstract void addExternalIdentifiers(Collection   externalIdentifiers   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void addExternalLink(ExternalLink   externalLink   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void addExternalLinks(Collection   externalLinks   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void removeAssociation(Association   association   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void removeAssociations(Collection   associations   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void removeClassification(Classification   classification   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void removeClassifications(Collection   classifications   )        throws javax.xml.registry.JAXRException;  //L0  public abstract void removeExternalIdentifier(ExternalIdentifier   externalIdentifier   )         throws javax.xml.registry.JAXRException;  //L0  public abstract void removeExternalIdentifiers(Collection   externalIdentifiers   )         throws javax.xml.registry.JAXRException;  //L0  public abstract void removeExternalLink(ExternalLink   externalLink   )        throws javax.xml.registry.JAXRException;  //L0  Collection   externalLinks   )        throws javax.xml.registry.JAXRException;      public abstract String toXML(  )        throws javax.xml.registry.JAXRException;  //L0  }

With the exception of a very small number of helper classes, every object that can be stored in the registry and accessed using the JAXR API is derived from the RegistryObject interface. RegistryObject provides very little functionality of its owninstead, it is composed mainly of accessor and mutator methods that allow JAXR clients to work with the attributes of a RegistryObject . The following paragraphs provide an overview of each of these attributes; for more detailed information, refer to the appropriate reference section in this chapter.

Name: A human-readable name for the object. This value, along with the description, is typically used to represent the object in a user interface and is of type InternationalString so that it can be presented in the appropriate way for the locale of the viewing client. This attribute is accessed using the getName( ) and setName( ) methods.
Description: A free-form description of the object, which can be accessed using the getDescription and setDescription( ) methods. Like the Name attribute, this is intended for human consumption and is therefore of type InternationalString .
Key: A value that identifies the object in the registry. The Key contains a unique identifier that is usually a 128-bit DCE UUID. To guarantee uniqueness, this value is generally allocated by the registry when the object is created, but ebXML registries allow clients to select the identifier for objects that they create.
LifeCycleManager: A reference to the LifeCycleManager that was used to create this instance of the object. This refers to the instance of the object currently being used by the JAXR client, rather than the instance used to initially create the registry's version of the object.
Object Type: A Concept that describes the type of the registry object. The JAXR specification defines an enumeration of object types called "ObjectType" from which these values are taken. Refer to Chapter 7 for the list of valid object types. This attribute can be read using the getObjectType( ) method, which is available only with a level 1 JAXR provider.
Submitting Organization: A reference to the Organization object for the organization that created the object. This attribute can be retrieved using the getSubmittingOrganization( ) method.
Audit Trail: A set of AuditableEvent objects that record changes to the object made by authorized users. Audit trails are maintained only by level 1 registries, The complete set of audited events for an object can be obtained from the getAuditTrail( ) method.
Associations: A RegistryObject can be associated with other objects in order to express some kind of relationship between them, such as "Uses" or "Supersedes." Methods are provided to add and remove associations, and to list the set of associations that involve the object on which they are invoked. See the reference section for the Assocation interface, earlier in this chapter, for further details.
Associated Objects: The getAssociatedObjects( ) method returns the Collection of RegistryObject s that are related to this object via an Association . This is a level 1 method.
Classifications: A set of Classification objects that allow a RegistryObject to be categorized according to one or more classification schemes such as NAICS, which describes the industry to which an object relates , or ISO-3166, which indicates a geographical location. Refer to the reference sections for Classification and ClassificationScheme , earlier in this chapter, for more information.
External Identifiers: A RegistryObject can have any number of associated ExternalIdentifier objects that represent an identifier from an external numbering or tagging scheme such as D-U-N-S. See the reference section for the ExternalIdentifier interface, earlier in this chapter, for more details.
External Links: An ExternalLink object provides the means to link a RegistryObject to information that resides outside the registry via a URI. Refer to the description of the ExternalLink interface, earlier in this chapter, for further information.

The toXML( ) method is provided to allow a registry to return its native XML representation of the RegistryObject to allow access to attributes that are not exposed via the JAXR API. Although this is a level 0 method, JAXR providers are not required to support it and may throw an UnsupportedCapabilityException if they do not.

Implementations

Association , AuditableEvent , Classification , Concept , ExternalIdentifier , ExternalLink , Organization , RegistryEntry , ServiceBinding , SpecificationLink , User

Passed To

javax.xml.registry.LifeCycleManager.{createAssociation( ) , createConcept( )} , Association.{setSourceObject( ) , setTargetObject( )} , Classification.setClassifiedObject( ) , RegistryPackage.{addRegistryObject( ) , removeRegistryObject( )} , SpecificationLink.setSpecificationObject( )

Returned By

javax.xml.registry.QueryManager.getRegistryObject( ) , Association.{getSourceObject( ) , getTargetObject( )} , AuditableEvent.getRegistryObject( ) , Classification.getClassifiedObject( ) , Concept.getParent( ) , ExternalIdentifier.getRegistryObject( ) , SpecificationLink.getSpecificationObject( )