Package org.sakaiproject.api.common.type

Interface TypeManager

public interface TypeManager

Author:

Lance Speelmon

Method Summary

Modifier and Type	Method	Description
Type	createType(String authority, String domain, String keyword, String displayName, String description)	Create a new Type.
void	deleteType(Type type)	Remove the persistent state of passed Type.
Type	getType(String uuid)	Retrieve Type by uuid.
Type	getType(String authority, String domain, String keyword)	Retrieve a Type by the "tuple".
void	saveType(Type type)	Update persistent state of passed Type.

Method Detail

createType

Type createType(String authority,
                String domain,
                String keyword,
                String displayName,
                String description)

Create a new Type.

Parameters:

authority -

domain -

keyword -

displayName -

description -

Returns:

getType

Type getType(String uuid)

Retrieve Type by uuid.

Parameters:

uuid -

Returns:

getType

Type getType(String authority,
             String domain,
             String keyword)

Retrieve a Type by the "tuple".

Parameters:

authority -

domain -

keyword -

Returns:

saveType

void saveType(Type type)

Update persistent state of passed Type.

Parameters:

type -

deleteType

void deleteType(Type type)
         throws UnsupportedOperationException

Remove the persistent state of passed Type.

Parameters:

type -

Throws:

UnsupportedOperationException - Some (many) implementations will not support deleting Types. Callers need to handle this condition gracefully.