org.kuali.rice.kew.api.repository.type

Interface KewTypeRepositoryService

public interface KewTypeRepositoryService

Method Summary

Modifier and Type	Method and Description
KewTypeDefinition	createKewType(KewTypeDefinition kewType) This will create a KewTypeDefinition exactly like the parameter passed in.
void	createKewTypeAttribute(KewTypeAttribute kewTypeAttribute) This will create a KewTypeAttribute exactly like the parameter passed in.
List<KewTypeDefinition>	findAllTypes() Returns all KEW types
List<KewTypeDefinition>	findAllTypesByNamespace(String namespace) Returns all KEW types that for a given namespace.
KewTypeDefinition	getTypeById(String id) Lookup a kew type based on the given id.
KewTypeDefinition	getTypeByNameAndNamespace(String name, String namespace) Get a kew type object based on name and namespace
void	updateKewType(KewTypeDefinition kewType) This will update an existing KewTypeDefinition
void	updateKewTypeAttribute(KewTypeAttribute kewTypeAttribute) This will update an existing KewTypeAttribute

Method Detail

createKewType

KewTypeDefinition createKewType(KewTypeDefinition kewType)
                         throws RiceIllegalArgumentException,
                                RiceIllegalStateException

This will create a KewTypeDefinition exactly like the parameter passed in.

Parameters:

kewType - - KewType

Throws:

IllegalArgumentException - if the kewType is null

IllegalStateException - if the kewType already exists in the system

RiceIllegalArgumentException

RiceIllegalStateException

updateKewType

void updateKewType(KewTypeDefinition kewType)
            throws RiceIllegalArgumentException,
                   RiceIllegalStateException

This will update an existing KewTypeDefinition

Parameters:

kewType - - KewType

Throws:

IllegalArgumentException - if the kewType is null

IllegalStateException - if the KewType does not exist in the system

RiceIllegalArgumentException

RiceIllegalStateException

getTypeById

KewTypeDefinition getTypeById(String id)
                       throws RiceIllegalArgumentException

Lookup a kew type based on the given id.

Parameters:

id - the given kew type id

Returns:

a KewType object with the given id. A null reference is returned if an invalid or non-existant id is supplied.

Throws:

RiceIllegalArgumentException

getTypeByNameAndNamespace

KewTypeDefinition getTypeByNameAndNamespace(String name,
                                            String namespace)
                                     throws RiceIllegalArgumentException,
                                            RiceIllegalStateException

Get a kew type object based on name and namespace

Parameters:

name - the given type name

namespace - the given type namespace

Returns:

A kew type object with the given namespace and name if one with that name and namespace exists. Otherwise, null is returned.

Throws:

IllegalStateException - if multiple kew types exist with the same name and namespace

RiceIllegalArgumentException

RiceIllegalStateException

findAllTypesByNamespace

List<KewTypeDefinition> findAllTypesByNamespace(String namespace)
                                         throws RiceIllegalArgumentException

Returns all KEW types that for a given namespace.

Returns:

all KEW types for a namespace

Throws:

RiceIllegalArgumentException

findAllTypes

List<KewTypeDefinition> findAllTypes()

Returns all KEW types

Returns:

all KEW types

createKewTypeAttribute

void createKewTypeAttribute(KewTypeAttribute kewTypeAttribute)
                     throws RiceIllegalArgumentException,
                            RiceIllegalStateException

This will create a KewTypeAttribute exactly like the parameter passed in.

Parameters:

kewTypeAttribute - - KewTypeAttribute

Throws:

IllegalArgumentException - if the kewTypeAttribute is null

IllegalStateException - if the KewTypeAttribute already exists in the system

RiceIllegalArgumentException

RiceIllegalStateException

updateKewTypeAttribute

void updateKewTypeAttribute(KewTypeAttribute kewTypeAttribute)
                     throws RiceIllegalArgumentException,
                            RiceIllegalStateException

This will update an existing KewTypeAttribute

Parameters:

kewTypeAttribute - - KewTypeAttribute

Throws:

IllegalArgumentException - if the kewTypeAttribute is null

IllegalStateException - if the KewTypeAttribute does not exist in the system

RiceIllegalArgumentException

RiceIllegalStateException