javax.xml.registry
Interface LifeCycleManager

All Known Subinterfaces:

BusinessLifeCycleManager

public interface LifeCycleManager

This is the main interface in the API for managing life cycle operations on objects defined by the information model.

The factory methods of this interface must throws UnsupportedCapabilityException if the client attempts to create an instance of an infomodel interface that is not supported by the capability level of the JAXR provider.

Field Summary

static java.lang.String	ASSOCIATION
static java.lang.String	AUDITABLE_EVENT
static java.lang.String	CLASSIFICATION
static java.lang.String	CLASSIFICATION_SCHEME
static java.lang.String	CONCEPT
static java.lang.String	EMAIL_ADDRESS
static java.lang.String	EXTENSIBLE_OBJECT
static java.lang.String	EXTERNAL_IDENTIFIER
static java.lang.String	EXTERNAL_LINK
static java.lang.String	EXTRINSIC_OBJECT
static java.lang.String	INTERNATIONAL_STRING
static java.lang.String	KEY
static java.lang.String	LOCALIZED_STRING
static java.lang.String	ORGANIZATION
static java.lang.String	PERSON_NAME
static java.lang.String	POSTAL_ADDRESS
static java.lang.String	REGISTRY_ENTRY
static java.lang.String	REGISTRY_PACKAGE
static java.lang.String	SERVICE
static java.lang.String	SERVICE_BINDING
static java.lang.String	SLOT
static java.lang.String	SPECIFICATION_LINK
static java.lang.String	TELEPHONE_NUMBER
static java.lang.String	USER
static java.lang.String	VERSIONABLE

Method Summary

Association	createAssociation(RegistryObject targetObjet, Concept associationType) Create an Association instance using the specified parameters.
Classification	createClassification(ClassificationScheme scheme, java.lang.String name, java.lang.String value) Create a Classification instance for an external Classification using the specified name and value that identifies a taxonomy element within specified ClassificationScheme.
Classification	createClassification(Concept concept) Create a Classification instance for an internal Classification using the specified Concept which identifies a taxonomy element within an internal ClassificationScheme.
ClassificationScheme	createClassificationScheme(Concept concept) Creates a ClassificationScheme from a Concept that has no ClassificationScheme or parent Concept.
ClassificationScheme	createClassificationScheme(java.lang.String name, java.lang.String description) Create a scheme given specified parameters.
Concept	createConcept(RegistryObject parent, java.lang.String name, java.lang.String value) Create a Concept instance using the specified parameters.
void	createConceptEquivalence(Concept concept1, Concept concept2) Create a semantic equivalence between the two specified Concepts.
EmailAddress	createEmailAddress(java.lang.String address) Create an EmailAddress instance using the specified parameters.
EmailAddress	createEmailAddress(java.lang.String address, java.lang.String type) Create an EmailAddress instance using the specified parameters.
ExternalIdentifier	createExternalIdentifier(ClassificationScheme identificationScheme, java.lang.String name, java.lang.String value) Create an ExternalIdentifier instance using the specified parameters.
ExternalLink	createExternalLink(java.lang.String externalURI, java.lang.String description) Create an ExternalLink instance using the specified parameters.
ExtrinsicObject	createExtrinsicObject() Create an ExtrinsicObject instance using the specified parameters.
InternationalString	createInternationalString() Create a InternationalString instance using the specified parameters.
InternationalString	createInternationalString(java.util.Locale l, java.lang.String s) Create a InternationalString instance using the specified parameters.
InternationalString	createInternationalString(java.lang.String s) Create a InternationalString instance using the specified parameters.
Key	createKey(java.lang.String id) Create a Key instance using the specified parameters.
LocalizedString	createLocalizedString(java.util.Locale l, java.lang.String s) Create a LocalizedString instance using the specified parameters.
java.lang.Object	createObject(java.lang.String className) Factory method for creating instances of information model interfaces.
Organization	createOrganization(java.lang.String name) Create an Organization instance using the specified parameters.
PersonName	createPersonName(java.lang.String fullName) Create a PersonName instance using the specified parameters.
PersonName	createPersonName(java.lang.String firstName, java.lang.String middleName, java.lang.String lastName) Create a PersonName instance using the specified parameters.
PostalAddress	createPostalAddress(java.lang.String streetNumber, java.lang.String street, java.lang.String city, java.lang.String stateOrProvince, java.lang.String country, java.lang.String postalCode, java.lang.String type) Create a PostalAddress instance using the specified parameters.
RegistryPackage	createRegistryPackage(java.lang.String name) Create a RegistryPackage instance using the specified parameters.
Service	createService(java.lang.String name) Create an Service instance using the specified parameters.
ServiceBinding	createServiceBinding() Create an ServiceBinding instance using the specified parameters.
Slot	createSlot(java.lang.String name, java.util.Collection values, java.lang.String slotType) Create a Slot instance using the specified parameters.
Slot	createSlot(java.lang.String name, java.lang.String value, java.lang.String slotType) Create a Slot instance using the specified parameters.
SpecificationLink	createSpecificationLink() Create a SpecificationLink instance using the specified parameters.
TelephoneNumber	createTelephoneNumber() Create a TelephoneNumber instance using the specified parameters.
User	createUser() Create a User instance using the specified parameters.
void	deleteConceptEquivalence(Concept concept1, Concept concept2) Removes the semantic equivalence, if any, between the specified two Concepts.
BulkResponse	deleteObjects(java.util.Collection keys) Deletes one or more previously submitted objects from the registry.
BulkResponse	deprecateObjects(java.util.Collection keys) Deprecates one or more previously submitted objects.
BulkResponse	saveObjects(java.util.Collection objects) Saves one or more Objects to the registry.
BulkResponse	unDeprecateObjects(java.util.Collection keys) Undeprecates one or more previously deprecated objects.

Field Detail

ASSOCIATION

public static final java.lang.String ASSOCIATION

AUDITABLE_EVENT

public static final java.lang.String AUDITABLE_EVENT

CLASSIFICATION

public static final java.lang.String CLASSIFICATION

CLASSIFICATION_SCHEME

public static final java.lang.String CLASSIFICATION_SCHEME

CONCEPT

public static final java.lang.String CONCEPT

EMAIL_ADDRESS

public static final java.lang.String EMAIL_ADDRESS

EXTENSIBLE_OBJECT

public static final java.lang.String EXTENSIBLE_OBJECT

EXTERNAL_IDENTIFIER

public static final java.lang.String EXTERNAL_IDENTIFIER

EXTERNAL_LINK

public static final java.lang.String EXTERNAL_LINK

EXTRINSIC_OBJECT

public static final java.lang.String EXTRINSIC_OBJECT

INTERNATIONAL_STRING

public static final java.lang.String INTERNATIONAL_STRING

KEY

public static final java.lang.String KEY

LOCALIZED_STRING

public static final java.lang.String LOCALIZED_STRING

ORGANIZATION

public static final java.lang.String ORGANIZATION

PERSON_NAME

public static final java.lang.String PERSON_NAME

POSTAL_ADDRESS

public static final java.lang.String POSTAL_ADDRESS

REGISTRY_ENTRY

public static final java.lang.String REGISTRY_ENTRY

REGISTRY_PACKAGE

public static final java.lang.String REGISTRY_PACKAGE

SERVICE

public static final java.lang.String SERVICE

SERVICE_BINDING

public static final java.lang.String SERVICE_BINDING

SLOT

public static final java.lang.String SLOT

SPECIFICATION_LINK

public static final java.lang.String SPECIFICATION_LINK

TELEPHONE_NUMBER

public static final java.lang.String TELEPHONE_NUMBER

USER

public static final java.lang.String USER

VERSIONABLE

public static final java.lang.String VERSIONABLE

Method Detail

createObject

public java.lang.Object createObject(java.lang.String className)
                              throws JAXRException,
                                     InvalidRequestException,
                                     UnsupportedCapabilityException

Factory method for creating instances of information model interfaces. To create an Organization use it as follows:

Organization org = lifeCycleMgr.createObject(LifeCycleManager.Organization);

Capability Level: 0

Parameters:

interfaceName - Is the unqualified name of an interface in the javax.xml.registry.infomodel package

Throws InvalidRequestException if the interface is not an interface in from javax.xml.registry.infomodel package.

Throws UnsupportedCapabilityException if the client attempts to create an instance of an infomodel interface that is not supported by the capability level of the JAXR provider.

createAssociation

public Association createAssociation(RegistryObject targetObjet,
                                     Concept associationType)
                              throws JAXRException

Create an Association instance using the specified parameters. The sourceObject is left null and will be set when the Association is added to a RegistryObject.

Note that for a UDDI provider an Association may only be created between Organizations.

Capability Level: 0

createClassification

public Classification createClassification(ClassificationScheme scheme,
                                           java.lang.String name,
                                           java.lang.String value)
                                    throws JAXRException

Create a Classification instance for an external Classification using the specified name and value that identifies a taxonomy element within specified ClassificationScheme.

Capability Level: 0

createClassification

public Classification createClassification(Concept concept)
                                    throws JAXRException,
                                           InvalidRequestException

Create a Classification instance for an internal Classification using the specified Concept which identifies a taxonomy element within an internal ClassificationScheme.

Throws InvalidRequestException if the Concept is not under a ClassificationScheme.

Capability Level: 0

createClassificationScheme

public ClassificationScheme createClassificationScheme(java.lang.String name,
                                                       java.lang.String description)
                                                throws JAXRException,
                                                       InvalidRequestException

Create a scheme given specified parameters. This is the method to use to create a scheme in most situations.

Capability Level: 0

createClassificationScheme

public ClassificationScheme createClassificationScheme(Concept concept)
                                                throws JAXRException,
                                                       InvalidRequestException

Creates a ClassificationScheme from a Concept that has no ClassificationScheme or parent Concept.

This method is a special case method to do a type safe conversion from Concept to ClassificationScheme.

This method is provided to allow for Concepts returned by the BusinessQueryManager findConcepts call to be safely cast to ClassificationScheme. It is up to the programer to make sure that the Concept is indeed semantically a ClassificationScheme.

This method is necessary because in UDDI a tModel may serve multiple purposes and there is no way to know when a tModel maps to a Concept and when it maps to a ClassificationScheme. UDDI leaves the determination to the programmer and consequently so does this method.

Throws InvalidRequestException if the Concept has a parent Concept or is under a ClassificationScheme.

Capability Level: 0

createConcept

public Concept createConcept(RegistryObject parent,
                             java.lang.String name,
                             java.lang.String value)
                      throws JAXRException

Create a Concept instance using the specified parameters.

Capability Level: 0

Parameters:

parent - Is either a reference to a parent ClassificationScheme or Concept

createEmailAddress

public EmailAddress createEmailAddress(java.lang.String address)
                                throws JAXRException

Create an EmailAddress instance using the specified parameters.

Capability Level: 0

createEmailAddress

public EmailAddress createEmailAddress(java.lang.String address,
                                       java.lang.String type)
                                throws JAXRException

Create an EmailAddress instance using the specified parameters.

Capability Level: 0

createExternalIdentifier

public ExternalIdentifier createExternalIdentifier(ClassificationScheme identificationScheme,
                                                   java.lang.String name,
                                                   java.lang.String value)
                                            throws JAXRException

Create an ExternalIdentifier instance using the specified parameters.

Capability Level: 0

createExternalLink

public ExternalLink createExternalLink(java.lang.String externalURI,
                                       java.lang.String description)
                                throws JAXRException

Create an ExternalLink instance using the specified parameters.

Capability Level: 0

createExtrinsicObject

public ExtrinsicObject createExtrinsicObject()
                                      throws JAXRException

Create an ExtrinsicObject instance using the specified parameters.

Capability Level: 1

createInternationalString

public InternationalString createInternationalString()
                                              throws JAXRException

Create a InternationalString instance using the specified parameters.

Capability Level: 0

createInternationalString

public InternationalString createInternationalString(java.lang.String s)
                                              throws JAXRException

Create a InternationalString instance using the specified parameters.

Capability Level: 0

createInternationalString

public InternationalString createInternationalString(java.util.Locale l,
                                                     java.lang.String s)
                                              throws JAXRException

Create a InternationalString instance using the specified parameters.

Capability Level: 0

createKey

public Key createKey(java.lang.String id)
              throws JAXRException

Create a Key instance using the specified parameters.

Capability Level: 1

createLocalizedString

public LocalizedString createLocalizedString(java.util.Locale l,
                                             java.lang.String s)
                                      throws JAXRException

Create a LocalizedString instance using the specified parameters.

Capability Level: 0

createOrganization

public Organization createOrganization(java.lang.String name)
                                throws JAXRException

Create an Organization instance using the specified parameters.

Capability Level: 0

createPersonName

public PersonName createPersonName(java.lang.String firstName,
                                   java.lang.String middleName,
                                   java.lang.String lastName)
                            throws JAXRException

Create a PersonName instance using the specified parameters.

Capability Level: 1

createPersonName

public PersonName createPersonName(java.lang.String fullName)
                            throws JAXRException

Create a PersonName instance using the specified parameters.

Capability Level: 0

createPostalAddress

public PostalAddress createPostalAddress(java.lang.String streetNumber,
                                         java.lang.String street,
                                         java.lang.String city,
                                         java.lang.String stateOrProvince,
                                         java.lang.String country,
                                         java.lang.String postalCode,
                                         java.lang.String type)
                                  throws JAXRException

Create a PostalAddress instance using the specified parameters.

Capability Level: 0

createRegistryPackage

public RegistryPackage createRegistryPackage(java.lang.String name)
                                      throws JAXRException

Create a RegistryPackage instance using the specified parameters.

Capability Level: 1

createService

public Service createService(java.lang.String name)
                      throws JAXRException

Create an Service instance using the specified parameters.

Capability Level: 0

createServiceBinding

public ServiceBinding createServiceBinding()
                                    throws JAXRException

Create an ServiceBinding instance using the specified parameters.

Capability Level: 0

createSlot

public Slot createSlot(java.lang.String name,
                       java.lang.String value,
                       java.lang.String slotType)
                throws JAXRException

Create a Slot instance using the specified parameters.

Capability Level: 0

createSlot

public Slot createSlot(java.lang.String name,
                       java.util.Collection values,
                       java.lang.String slotType)
                throws JAXRException

Create a Slot instance using the specified parameters.

Capability Level: 0

createSpecificationLink

public SpecificationLink createSpecificationLink()
                                          throws JAXRException

Create a SpecificationLink instance using the specified parameters.

Capability Level: 0

createTelephoneNumber

public TelephoneNumber createTelephoneNumber()
                                      throws JAXRException

Create a TelephoneNumber instance using the specified parameters.

Capability Level: 0

createUser

public User createUser()
                throws JAXRException

Create a User instance using the specified parameters.

Capability Level: 0

saveObjects

public BulkResponse saveObjects(java.util.Collection objects)
                         throws JAXRException

Saves one or more Objects to the registry. An object may be a RegistryObject sub-class or a CataloguedObject. If an object is not in the registry, then it is created in the registry. If it already exists in the registry and has been modified, then its state is updated (replaced) in the registry.

Capability Level: 0

Returns:

BulkResponse containing the Collection of keys for those objects that were saved successfully and any SaveException that was encountered in case of partial commit.

deprecateObjects

public BulkResponse deprecateObjects(java.util.Collection keys)
                              throws JAXRException

Deprecates one or more previously submitted objects. Deprecation marks an object as "soon "

Capability Level: 1

Returns:

BulkResponse containing the Collection of keys for those objects that were deprecated successfully and any JAXRException that was encountered in case of partial commit.

unDeprecateObjects

public BulkResponse unDeprecateObjects(java.util.Collection keys)
                                throws JAXRException

Undeprecates one or more previously deprecated objects. If an object is not deprecated the benign error must be silently ignored.

Capability Level: 1

Returns:

BulkResponse containing the Collection of keys for those objects that were deprecated successfully and any JAXRException that was encountered in case of partial commit.

deleteObjects

public BulkResponse deleteObjects(java.util.Collection keys)
                           throws JAXRException

Deletes one or more previously submitted objects from the registry.

Capability Level: 0

Returns:

BulkResponse containing the Collection of keys for those objects that were deleted successfully and any DeleteException that was encountered in case of partial commit.

createConceptEquivalence

public void createConceptEquivalence(Concept concept1,
                                     Concept concept2)
                              throws JAXRException

Create a semantic equivalence between the two specified Concepts. This is a convenience method to create an Association with sourceObject as concept1 and targetObject as concept2 and associationType as EquivalentTo.

Capability Level: 0

deleteConceptEquivalence

public void deleteConceptEquivalence(Concept concept1,
                                     Concept concept2)
                              throws JAXRException

Removes the semantic equivalence, if any, between the specified two Concepts. This is a convenience method to to delete any Association sourceObject as concept1 and targetObject as concept2 and associationType as EquivalentTo.

Capability Level: 0