org.kuali.rice.ksb.api.registry

Class ServiceDescriptor.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, Versioned, ModelBuilder, ServiceDescriptorContract

Enclosing class:

ServiceDescriptor

public static final class ServiceDescriptor.Builder
extends Object
implements Serializable, ModelBuilder, ServiceDescriptorContract

A builder which can be used to construct ServiceDescriptor instances. Enforces the constraints of the ServiceDescriptorContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ServiceDescriptor	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static ServiceDescriptor.Builder	create()
static ServiceDescriptor.Builder	create(ServiceDescriptorContract contract)
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.
void	setDescriptor(String descriptor)
void	setId(String id)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ServiceDescriptor.Builder create()

create

public static ServiceDescriptor.Builder create(ServiceDescriptorContract contract)

build

public ServiceDescriptor build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null

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

setId

public void setId(String id)

setDescriptor

public void setDescriptor(String descriptor)

setVersionNumber

public void setVersionNumber(Long versionNumber)