javax.emb
Interface MetaDataEntityLocalHome

All Superinterfaces:

EJBLocalHome (src)

public interface MetaDataEntityLocalHome

extends EJBLocalHome (src)

This interface defines the local home interface of metadata entity EJBs and therefore services relevant for local, persistent and mutable metadata objects. It extends javax.ejb.EJBLocalHome and defines additional methods with a semantic requiring the persistence of such metadata

create

public MetaDataEntityLocal (src)  create()
                           throws CreateException (src) ,
                                  MediaException (src) 

Creates a new metadata entity EJB with a generated identity key, null XML content and default values for the other properties. Please note many of the Metadata Entity EJB methods will throw exceptions until the XML content is set.

Returns:

metadata entity.

Throws:

CreateException (src) - if a problem related to EJB creation occurs.

MediaException (src)

findByPrimaryKey

public MetaDataEntityLocal (src)  findByPrimaryKey(java.lang.String identity)
                                     throws FinderException (src) 

Returns the metadata entity with the given identity.

Returns:

metadata entity.

Throws:

java.lang.NullPointerException - if the value passed is null.

FinderException (src) - if no matching metadata entity is found.

query

public java.util.Collection query(java.lang.String query,
                                  java.lang.String queryLanguage,
                                  java.util.Map options)
                           throws FinderException (src) ,
                                  MediaException (src) 

Returns the metadata entities that match the given query. The query semantics are defined by the given query language in association with the optionally given query options. Note that the set of query languages and options supported is up to the implementation. Valid keys for the options map can be derived by calling retrieveSupportedOptions(). In case unsupported options are passed, implementations should ignore them.

Parameters:

query -

queryLanguage -

options -

Returns:

collection.

Throws:

java.lang.NullPointerException - if the query or query language passed is null.

java.lang.NullPointerException - if the query or query language passed is null.

MalformedQueryException (src) - if the query statement does not match the syntax defined by the given query language.

UnsupportedQueryLanguageException (src) - if the specified query language is not supported by the implementation.

IllegalOptionException (src) - if the given options are not formatted properly and cannot be read or if one of the options is unsupported and cannot be processed.

MalformedQueryException (src) - if the query statement does not match the syntax defined by the given query language.

UnsupportedQueryLanguageException (src) - if the specified query language is not supported by the implementation.

IllegalOptionException (src) - if the given options are not formatted properly and cannot be read or if one of the options is unsupported and cannot be processed.

FinderException (src)

MediaException (src)

retrieveSupportedOptions

public java.lang.String[] retrieveSupportedOptions(java.lang.String queryLanguage)
                                            throws MediaException (src) 

Returns an array containing the names of supported options for the given query language. If no query options are supported then an empty array is returned.

Parameters:

queryLanguage -

Returns:

@throws java.lang.NullPointerException if the value passed is null.

Throws:

UnsupportedQueryLanguageException (src) - if the name of the query language passed is not supported by the implementation.

MediaException (src)

retrieveSupportedQueryLanguages

public java.lang.String[] retrieveSupportedQueryLanguages()
                                                   throws MediaException (src) 

Returns an array containing the names of supported query languages. If no query languages are supported then an empty array is returned.

Returns:

@throws MediaException

Throws:

MediaException (src)