RegistryObject (Java EE 5 SDK)

javax.xml.registry.infomodel Interface RegistryObject

所有父接口:

ExtensibleObject

所有已知子接口:

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

public interface RegistryObject

extends ExtensibleObject

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.

作者:

Farrukh S. Najmi

另请参见:

RegistryEntry

getKey

Key getKey()
           throws JAXRException

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

Capability Level: 0

返回:

the Key for this object

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getDescription

InternationalString getDescription()
                                   throws JAXRException

Gets the textual description for this object.

Capability Level: 0

返回:

the description for this object which must not be null

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

setDescription

void setDescription(InternationalString description)
                    throws JAXRException

Sets the context independent textual description for this object.

Capability Level: 0

参数:

description - the description for this object

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getName

InternationalString getName()
                            throws JAXRException

Gets the user-friendly name of this object.

Capability Level: 0

返回:

the name for this object which must not be null.

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

setName

void setName(InternationalString name)
             throws JAXRException

Sets user-friendly name of object in repository.

Capability Level: 0

参数:

name - the name for this object

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

setKey

void setKey(Key key)
            throws JAXRException

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

Capability Level: 0

参数:

key - the key for this object

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

toXML

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

返回:

the String containing the XML representation for this object

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

addClassification

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

参数:

classification - the Classification being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

addClassifications

void addClassifications(Collection classifications)
                        throws JAXRException

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

Capability Level: 0

参数:

classifications - the Collection of Classifications being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeClassification

void removeClassification(Classification classification)
                          throws JAXRException

Removes specified Classification from this object.

Capability Level: 0

参数:

classification - the Classification being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeClassifications

void removeClassifications(Collection classifications)
                           throws JAXRException

Removes specified Classifications from this object.

Capability Level: 0

参数:

classifications - the Collection of Classifications being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

setClassifications

void setClassifications(Collection classifications)
                        throws JAXRException

Replaces all previous Classifications with specified Classifications.

Capability Level: 0

参数:

classifications - the Collection of Classifications being set

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getClassifications

Collection getClassifications()
                              throws JAXRException

Gets the Classification instances that classify this object.

Capability Level: 0

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

另请参见:

Classification

getAuditTrail

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 must throw UnsupportedCapabilityException in lower capability levels.

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

另请参见:

AuditableEvent

addAssociation

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

参数:

association - the Association being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

addAssociations

void addAssociations(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: 0

参数:

associations - the Collection of Associations being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeAssociation

void removeAssociation(Association association)
                       throws JAXRException

Removes specified Association from this object.

Capability Level: 0

参数:

association - the Association being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeAssociations

void removeAssociations(Collection associations)
                        throws JAXRException

Removes specified Associations from this object.

Capability Level: 0

参数:

associations - the Collection of Associations being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

setAssociations

void setAssociations(Collection associations)
                     throws JAXRException

Replaces all previous Associations from this object with specified Associations.

Capability Level: 0

参数:

associations - the Collection of Associations being set

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getAssociations

Collection getAssociations()
                           throws JAXRException

Gets all Associations where this object is source.

Capability Level: 0

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

另请参见:

Association

getAssociatedObjects

Collection 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.

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

另请参见:

RegistryObject

addExternalIdentifier

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

参数:

externalIdentifier - the ExternalIdentifier being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

addExternalIdentifiers

void addExternalIdentifiers(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

参数:

externalIdentifiers - the Collection of ExternalIdentifiers being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeExternalIdentifier

void removeExternalIdentifier(ExternalIdentifier externalIdentifier)
                              throws JAXRException

Removes specified ExternalIdentifier as an external identifier from this object.

Capability Level: 0

参数:

externalIdentifier - the ExternalIdentifier being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeExternalIdentifiers

void removeExternalIdentifiers(Collection externalIdentifiers)
                               throws JAXRException

Removes specified ExternalIdentifiers as an external identifiers from this object.

Capability Level: 0

参数:

externalIdentifiers - the Collection of ExternalIdentifiers being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

setExternalIdentifiers

void setExternalIdentifiers(Collection externalIdentifiers)
                            throws JAXRException

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

Capability Level: 0

参数:

externalIdentifiers - the Collection of ExternalIdentifiers being set

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getExternalIdentifiers

Collection getExternalIdentifiers()
                                  throws JAXRException

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

Capability Level: 0

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

另请参见:

ExternalIdentifier

addExternalLink

void addExternalLink(ExternalLink externalLink)
                     throws JAXRException

Adds specified ExternalLink to this object.

Capability Level: 0

参数:

externalLinks - the ExternalLink being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

addExternalLinks

void addExternalLinks(Collection externalLinks)
                      throws JAXRException

Adds specified ExternalLinks to this object.

Capability Level: 0

参数:

externalLinks - the Collection of ExternalLinks being added

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeExternalLink

void removeExternalLink(ExternalLink externalLink)
                        throws JAXRException

Removes specified ExternalLink from this object.

Capability Level: 0

参数:

externalLink - the ExternalLink being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

removeExternalLinks

void removeExternalLinks(Collection externalLinks)
                         throws JAXRException

Removes specified ExternalLinks from this object.

Capability Level: 0

参数:

externalLinks - the Collection of ExternalLinks being removed

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

setExternalLinks

void setExternalLinks(Collection externalLinks)
                      throws JAXRException

Replaces all previous ExternalLinks with specified ExternalLinks.

Capability Level: 0

参数:

externalLink - the Collection of ExternalLinks being set

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getExternalLinks

Collection getExternalLinks()
                            throws JAXRException

Returns the ExternalLinks associated with this object.

Capability Level: 0

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

另请参见:

ExternalLink

getObjectType

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.

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getSubmittingOrganization

Organization getSubmittingOrganization()
                                       throws JAXRException

Gets the Organization that submitted this RegistryObject.

返回:

the Organization that submitted this object to the registry

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

getRegistry软件包

Collection getRegistry软件包()
                               throws JAXRException

Returns the Package associated with this object.

Capability Level: 1

This method must throw UnsupportedCapabilityException in lower capability levels.

返回:

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

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

另请参见:

RegistryPackage

getLifeCycleManager

LifeCycleManager getLifeCycleManager()
                                     throws JAXRException

Returns the LifeCycleManager that created this object.

Capability Level: 0

返回:

the LifeCycleManager objet that created this object

抛出异常:

JAXRException - If the JAXR provider encounters an internal error

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.