org.kuali.rice.ksb.api.registry

Class ServiceDescriptor

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.ksb.api.registry.ServiceDescriptor

All Implemented Interfaces:

Serializable, Versioned, ModelObjectBasic, ModelObjectComplete, ServiceDescriptorContract

public final class ServiceDescriptor
extends AbstractDataTransferObject
implements ServiceDescriptorContract

Immutable implementation of the ServiceDescriptorContract interface. Includes a serialized XML representation of the ServiceConfiguration for the service.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceDescriptor.Builder A builder which can be used to construct ServiceDescriptor instances.

Method Summary

Modifier and Type	Method and Description
String	getDescriptor() Returns an XML value which can be used to materialize the ServiceConfiguration for the service.
String	getId() Returns the id of this service descriptor.
Long	getVersionNumber() Deprecated: Will always return null as service descriptors have no version number column.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public String getId()

Description copied from interface: ServiceDescriptorContract

Returns the id of this service descriptor. This value should be unique across service descriptors. This value is generated when the service is published to the registry, so this value can be null if the service has not yet been published to the registry.

Specified by:

getId in interface ServiceDescriptorContract

Returns:

the id of this service descriptor, or null if the service and it's descriptor has not yet been published to the registry

getDescriptor

public String getDescriptor()

Description copied from interface: ServiceDescriptorContract

Returns an XML value which can be used to materialize the ServiceConfiguration for the service.

Specified by:

getDescriptor in interface ServiceDescriptorContract

Returns:

the XML representation of the ServiceConfiguration for the service, should never return a null or blank value

getVersionNumber

public Long getVersionNumber()

Description copied from interface: ServiceDescriptorContract

Deprecated: Will always return null as service descriptors have no version number column. This was included on the contract interface by mistake during the original implementation.

Specified by:

getVersionNumber in interface Versioned

Specified by:

getVersionNumber in interface ServiceDescriptorContract

Returns:

always returns null