MetaDataEntityLocal

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.emb
Interface MetaDataEntityLocal

All Superinterfaces:: EJBLocalObject (src)

public interface MetaDataEntityLocal
extends EJBLocalObject (src)

This basic interface defines behavior common to all kinds of metadata objects that are persistent and can be altered. It also extends EJBLocalObject and therefore represents the local interface of a Metadata Entity EJB.

MetaDataEntity EJBs consist of the two basic alterable properties:

The xml property models the XML content of a Meta Data Entity EJB. XML content may be implicitly processed for the creation of persistent indexing information to allow efficient content search. The default for this property is null.

The name property models a file name that is used as a default in case the xml content has to be exported to a file. The default value for this property is null.

Method Summary
`void`	`addChild(MetaDataEntityLocal (src) child)` Adds the given Metadata Entity EJB to the receiver's set of children.
`void`	`addMediaEntity(MediaEntityLocal (src) mediaEntity)` Adds the given Media Entity EJB to the receiver's set of associated Media Entity EJBs that are described by the receiver.
`MetaDataEntityLocal (src) []`	`getChildren()` Returns the receiver's children as an array of Media Entity EJBs.
`long`	`getLastModified()` Returns a timestamp stating when the receiver's persistent state was last modified.
`MediaEntityLocal (src) []`	`getMediaEntities()` Returns the Media Entity EJBs associated with the receiver.
`MediaEntityLocal (src) []`	`getMediaEntities(MediaFormat (src) mediaFormat, boolean searchCildren)` This method locates all Media Entity EJBs associated with the receiver that have the specified media format.
`MediaEntityLocal (src) []`	`getMediaEntities(java.lang.String mimeType, boolean searchCildren)` This method locates all Media Entity EJBs associated with the receiver that have the given mime type.
`java.lang.String`	`getName()` Returns the receiver's non-unique name as a String.
`MetaDataEntityLocal (src)`	`getNextVersion()` Returns the succeeding version edition of the receiver, which allows querying and a history chain of metadata objects that represent the same thing.
`MetaDataEntityLocal (src) []`	`getParents()` Returns the receiver's parents as an array of Metadata Entity EJBs.
`MetaDataEntityLocal (src)`	`getPreviousVersion()` Returns the previous version of the receiver, which allows querying a history of metadata objects that represent the same logical thing.
`java.lang.String`	`getXML()` This method returns the receiver's content as an XML string.
`void`	`removeChild(MetaDataEntityLocal (src) child)` Removes the given Metadata Entity EJB from the receiver's set of children.
`void`	`removeMediaEntity(MediaEntityLocal (src) mediaEntity)` Removes the given Media Entity EJB from the receiver's set of associated Media Entity EJBs that are described by the receiver.
`void`	`setName(java.lang.String name)` Sets the receiver's non-unique name as a String.
`void`	`setPreviousVersion(MetaDataEntityLocal (src) metadata)` Defines the given metadata entity to be the previous version of the receiver, which allows querying a history chain of metadata objects that represent the same logical thing.
`void`	`setXML(java.lang.String xmlContent, boolean validate)` If the given XML content is well formed, it replaces the receiver's current metadata content.

Methods inherited from interface javax.ejb.EJBLocalObject (src)

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

addChild

public void addChild(MetaDataEntityLocal (src)  child)
              throws MediaException (src)

Adds the given Metadata Entity EJB to the receiver's set of children. If the given MetaDataEntity EJB is already part of the receiver's list of children no action is performed.

Parameters:: child -
Throws:: java.lang.NullPointerException - if the value passed is null.; MediaException (src)

addMediaEntity

public void addMediaEntity(MediaEntityLocal (src)  mediaEntity)
                    throws MediaException (src)

Adds the given Media Entity EJB to the receiver's set of associated Media Entity EJBs that are described by the receiver. If the given Media Entity EJB is already part of the receiver's list no action is performed.

Parameters:: mediaEntity -
Throws:: java.lang.NullPointerException - if the value passed is null.; MediaException (src)

getChildren

public MetaDataEntityLocal (src) [] getChildren()
                                  throws MediaException (src)

Returns the receiver's children as an array of Media Entity EJBs. The array is empty if no children are related.

Throws:: MediaException (src)

getLastModified

public long getLastModified()
                     throws MediaException (src)

Returns a timestamp stating when the receiver's persistent state was last modified.

Returns:: @throws MediaException
Throws:: MediaException (src)

getMediaEntities

public MediaEntityLocal (src) [] getMediaEntities()
                                    throws MediaException (src)

Returns the Media Entity EJBs associated with the receiver. The array is empty if no media entity EJBs are related.

Returns:: @throws MediaException
Throws:: MediaException (src)

getMediaEntities

public MediaEntityLocal (src) [] getMediaEntities(MediaFormat (src)  mediaFormat,
                                           boolean searchCildren)
                                    throws MediaException (src)

This method locates all Media Entity EJBs associated with the receiver that have the specified media format. If the given recursion flag is true, the search is extended to all Media Entity EJBs that relate to the receiver or one of its recursive children.

Returns:: MediaEntityLocal array.
Throws:: java.lang.NullPointerException - if the media format passed is null.; MediaException (src)

getMediaEntities

public MediaEntityLocal (src) [] getMediaEntities(java.lang.String mimeType,
                                           boolean searchCildren)
                                    throws MediaException (src)

This method locates all Media Entity EJBs associated with the receiver that have the given mime type. If the given recursion flag is true, the search is extended to all Media Entity EJBs that relate to the receiver or one of its recursive children.

Returns:: MediaEntityLocal array.
Throws:: java.lang.NullPointerException - if the mime type passed is null.; MediaException (src)

getName

public java.lang.String getName()
                         throws MediaException (src)

Returns the receiver's non-unique name as a String. The name is used as a file name hint in case the metadata XML content is to be stored in a file system and therefore may only contain characters that are valid in file names. Also, it should contain a file extension that represents the receiver's format. Note that as opposed to media entity EJBs, the name property is not required to contain a file extension registered with the MediaFormatRegistry.

Returns:: name.
Throws:: MediaException (src)

getNextVersion

public MetaDataEntityLocal (src)  getNextVersion()
                                   throws MediaException (src)

Returns the succeeding version edition of the receiver, which allows querying and a history chain of metadata objects that represent the same thing. The value null is returned if no next version exists.

Returns:: media entity.
Throws:: MediaException (src)

getParents

public MetaDataEntityLocal (src) [] getParents()
                                 throws MediaException (src)

Returns the receiver's parents as an array of Metadata Entity EJBs. The array is empty if no parents are related.

Returns:: MediaEntityLocal array.
Throws:: MediaException (src)

getPreviousVersion

public MetaDataEntityLocal (src)  getPreviousVersion()
                                       throws MediaException (src)

Returns the previous version of the receiver, which allows querying a history of metadata objects that represent the same logical thing. The value null is returned if no previous version exists.

Returns:: media entity.
Throws:: MediaException (src)

getXML

public java.lang.String getXML()
                        throws MediaException (src)

This method returns the receiver's content as an XML string.

Returns:: content as an XML string.
Throws:: ContentAccessException (src) - if the value passed is null.; MediaException (src)

removeChild

public void removeChild(MetaDataEntityLocal (src)  child)
                 throws MediaException (src)

Removes the given Metadata Entity EJB from the receiver's set of children. If the given MetaDataEntity EJB is not part of the receiver's list of children, no action is performed.

Parameters:: child -
Throws:: java.lang.NullPointerException - if the value passed is null.; MediaException (src)

removeMediaEntity

public void removeMediaEntity(MediaEntityLocal (src)  mediaEntity)
                       throws MediaException (src)

Removes the given Media Entity EJB from the receiver's set of associated Media Entity EJBs that are described by the receiver. If the given Media Entity EJB is not part of the receiver's list no action is performed.

Parameters:: mediaEntity -
Throws:: java.lang.NullPointerException - if the value passed is null.; MediaException (src)

setName

public void setName(java.lang.String name)
             throws MediaException (src)

Sets the receiver's non-unique name as a String. The name is used as a file name hint in case the media content is to be stored or published in a file system and therefore may only contain characters that are valid in file names. Also, it should contain a file extension that represents the receiver's media format. Note that as opposed media entity EJBs the name property is not required to contain a file extension registered with the MediaFormatRegistry.

Parameters:: name -
Throws:: java.lang.NullPointerException - if the value passed is null.; MediaException (src)

setPreviousVersion

public void setPreviousVersion(MetaDataEntityLocal (src)  metadata)
                        throws MediaException (src)

Defines the given metadata entity to be the previous version of the receiver, which allows querying a history chain of metadata objects that represent the same logical thing. In return, the operation causes the receiver to be the given metadata entity's successor. Passing the value null causes the receiver not to have a predecessor anymore. The operation is only allowed if version chain integrity is preserved:

If the given metadata entity EJB is the receiver itself: A javax.emb.VersionChainIntegrityException is thrown.
If the given metadata entity EJB is already the previous version of the receiver: No action is performed.
If the given metadata entity EJB is null: A javax.emb.VersionChainIntegrityException is thrown if the receiver has a successor.
Otherwise: A javax.emb.VersionChainIntegrityException is thrown if the given metadata entity EJB has a successor, or if the receiver has a predecessor, a successor, or both.

Parameters:: metadata -
Throws:: MediaException (src)

setXML

public void setXML(java.lang.String xmlContent,
                   boolean validate)
            throws MediaException (src)

If the given XML content is well formed, it replaces the receiver's current metadata content. If the given validation flag is true, the content is additionally strictly validated before the operation is performed.

Parameters:: xmlContent -; validate -
Throws:: java.lang.NullPointerException - if the content passed is null.; MetaDataValidationException (src) - if the validate flag is true and the content validation fails.; MetaDataSyntaxException (src) - if the XML content is not well formed, regardless of the validate flag.; MediaException (src)