OmeroBlitz API

omero::api::ITypes

Overview

[ "ami", "amd" ] interface ITypes extends ServiceInterface

Access to reflective type information. Also provides simplified access to special types like enumerations.

Operation Index

createEnumeration

getEnumeration

Lookup an enumeration value.

allEnumerations

updateEnumeration

Updates enumeration value specified by object.

updateEnumerations

Updates enumeration value specified by object.

deleteEnumeration

Deletes enumeration value specified by object.

getEnumerationTypes

Gets all metadata classes which are IEnum type.

getAnnotationTypes

Returns a list of classes which implement ome::model::IAnnotated.

getEnumerationsWithEntries

Gets all metadata classes which are IEnum type with contained objects.

getOriginalEnumerations

Gets all original values.

resetEnumerations

Operations

model::IObject createEnumeration(model::IObject newEnum) throws ServerError

model::IObject getEnumeration(string type, string value) throws ServerError

Lookup an enumeration value. As with the get-methods of IQuery queries returning no results will through an exception.

Parameters

type

An enumeration class which should be searched.

value

The value for which an enumeration should be found.

Return Value

A managed enumeration. Never null.

Exceptions

ApiUsageException

if ome::model::IEnum is not found.

IObjectList allEnumerations(string type) throws ServerError

model::IObject updateEnumeration(model::IObject oldEnum) throws ServerError

Updates enumeration value specified by object.

Parameters

oldEnum

An enumeration object which should be searched.

Return Value

A managed enumeration. Never null.

void updateEnumerations(IObjectList oldEnums) throws ServerError

Updates enumeration value specified by object.

Parameters

oldEnums

An enumeration collection of objects which should be searched.

void deleteEnumeration(model::IObject oldEnum) throws ServerError

Deletes enumeration value specified by object.

Parameters

oldEnum

An enumeration object which should be searched.

StringSet getEnumerationTypes() throws ServerError

Gets all metadata classes which are IEnum type.

Return Value

set of classes that extend IEnum

Exceptions

RuntimeException

if Class not found.

StringSet getAnnotationTypes() throws ServerError

Returns a list of classes which implement ome::model::IAnnotated. These can be used in combination with Search.

Return Value

a java::util::Set of ome::model::IAnnotated implementations

IObjectListMap getEnumerationsWithEntries() throws ServerError

Gets all metadata classes which are IEnum type with contained objects.

Return Value

map of classes that extend IEnum

Exceptions

RuntimeException

if xml parsing failure.

IObjectList getOriginalEnumerations() throws ServerError

Gets all original values.

Return Value

A list of managed enumerations.

Exceptions

RuntimeException

if xml parsing failure.

void resetEnumerations(string enumClass) throws ServerError