Skip navigation links

oracle.as.scheduler
Class BaseMetadata<T extends BaseMetadata<T>>

java.lang.Object
oracle.as.scheduler.BaseMetadata<T>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ExclusionsDefinition, Incompatibility, JobDefinition, JobSet, JobType, Schedule, Trigger, WorkAssignment, Workshift

public abstract class BaseMetadata<T extends BaseMetadata<T>>

extends java.lang.Object

implements java.io.Serializable

Since:

release specific (what release of product did this appear in)

Version:

$Header: ess/src/oracle/as/scheduler/BaseMetadata.java /main/12 2010/12/20 14:52:59 dcraft Exp $

Author:

dcraft

See Also:

Serialized Form

Constructor Summary

protected	BaseMetadata(java.lang.String name, java.lang.String displayName, java.lang.String description, MetadataObjectId metadataObjectId)
protected	BaseMetadata(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, MetadataObjectId metadataObjectId, java.lang.String[] resourceBundles)

Method Summary

abstract T	clone(java.lang.String newName)
static <T extends BaseMetadata<T>> T	from(BaseMetadataType<T> type, javax.management.openmbean.CompositeData cd) Create an instance of the model specific class out of an associated CompositeData instance
abstract BaseMetadataType<T>	getBaseMetadataType()
java.lang.String	getDescription() Retrieves the description of this ESS metadata object.
java.lang.String	getDescriptionKey() Retrieves the key to the entry in the associated resource bundle representing the description.
java.lang.String	getDisplayName() Retrieves the user friendly name of this ESS metadata object.
java.lang.String	getDisplayNameKey() Retrieves the key to the entry in the associated resource bundle representing the display name
oracle.as.scheduler.localization.EssMessages	getMessages()
MetadataObjectId	getMetadataObjectId() Retrieves the unique identifier of this object within the metadata repository.
java.lang.String	getName() Retrieves the name of this ESS metadata object.
java.lang.String[]	getResourceBundles() Retrieves the resource bundles assocaited with the translatable strings for this metadata
protected abstract T	getSelf()
int	hashCode()
void	localize(oracle.as.scheduler.translation.TranslationService service, oracle.as.scheduler.translation.TranslationContext context) This method is used internally by MetadataService to localize the metadata translatable field before returning it to the caller.
void	setDescription(java.lang.String description) Sets the description associated with this ESS metadata object.
void	setDescriptionKey(java.lang.String descriptionKey) Sets the key to be used for lookup description in the associated resource bundles.
void	setDisplayName(java.lang.String displayName) Sets the user friendly name associated with this ESS metadata object.
void	setDisplayNameKey(java.lang.String displayNameKey) Sets the key to be used for lookup display name in the associated resource bundles.
void	setResourceBundles(java.lang.String[] resourceBundles) Sets the message bundles to be associated with the translatable strings
abstract javax.management.openmbean.CompositeData	toCompositeData(javax.management.openmbean.CompositeType ct)
protected javax.management.openmbean.CompositeData	toCompositeData(javax.management.openmbean.CompositeType compType, java.lang.String[] itemNames) Convert an instance of this model specific type to a CompositeData.
java.lang.String	toString()
void	validate()
protected abstract void	validateCustom()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseMetadata

protected BaseMetadata(java.lang.String name,
                       java.lang.String displayName,
                       java.lang.String description,
                       MetadataObjectId metadataObjectId)

BaseMetadata

protected BaseMetadata(java.lang.String name,
                       java.lang.String displayNameKey,
                       java.lang.String descriptionKey,
                       MetadataObjectId metadataObjectId,
                       java.lang.String[] resourceBundles)

Method Detail

getBaseMetadataType

public abstract BaseMetadataType<T> getBaseMetadataType()

clone

public abstract T clone(java.lang.String newName)
                                         throws ValidationException

Throws:

ValidationException

toCompositeData

public abstract javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)

validateCustom

protected abstract void validateCustom()
                                throws ValidationException

Throws:

ValidationException

getSelf

protected abstract T getSelf()

getName

public final java.lang.String getName()

Retrieves the name of this ESS metadata object.

Returns:

the name of this ESS metadata object.

getDisplayName

public final java.lang.String getDisplayName()

Retrieves the user friendly name of this ESS metadata object. If this metadats displayName is associated with a key in the resource bundle, then the actual entry from the resource bundle will be located and returned. If the entry is not found in the resource bundle or there is no key associated, then the display name set on this instance is returned.

Returns:

the user friendly name of this ESS metadata object.

getDisplayNameKey

public final java.lang.String getDisplayNameKey()

Retrieves the key to the entry in the associated resource bundle representing the display name

Returns:

the key to the entry in the resource bundle.

getDescription

public final java.lang.String getDescription()

Retrieves the description of this ESS metadata object. If this metadats description is associated with a key in the resource bundle, then the actual entry from the resource bundle will be located and returned. If the entry is not found in the resource bundle or there is no key associated, then the display name set on this instance is returned.

Returns:

the description of this ESS metadata object.

getDescriptionKey

public final java.lang.String getDescriptionKey()

Retrieves the key to the entry in the associated resource bundle representing the description.

Returns:

the key to the entry in the resource bundle.

getResourceBundles

public final java.lang.String[] getResourceBundles()

Retrieves the resource bundles assocaited with the translatable strings for this metadata

Returns:

an array of resource bundles ids

getMetadataObjectId

public final MetadataObjectId getMetadataObjectId()

Retrieves the unique identifier of this object within the metadata repository. This identifier is populated only by the MetadataService when this object is retrieved from the metadata repository. Therefore if an object is newly created to persist into the repository, it will not have the unique identifier set initially.

Returns:

unique identifier associated with this object in the metadata repository. Null if this object is not obtained via the MetadataService.

getMessages

public final oracle.as.scheduler.localization.EssMessages getMessages()

validate

public final void validate()
                    throws ValidationException

Throws:

ValidationException

setDisplayName

public final void setDisplayName(java.lang.String displayName)

Sets the user friendly name associated with this ESS metadata object. This will be the default displayName if the resource bundle lookup is unsuccessful or no resource bundle is associated. A null value is acceptable and it has the effect of deleting existing display name text.

Parameters:

displayName - the user friendly name to be associated with this ESS metadata object.

setDisplayNameKey

public final void setDisplayNameKey(java.lang.String displayNameKey)

Sets the key to be used for lookup display name in the associated resource bundles. A null value is acceptable and it has the effect of deleting existing key set for the displayName

Parameters:

displayNameKey - the key for the resource bundle entry representing the user friendly name to be associated with this ESS metadata object.

setDescription

public final void setDescription(java.lang.String description)

Sets the description associated with this ESS metadata object. This will be the default description if the resource bundle lookup is unsuccessful or no resource bundle is associated. A null value is acceptable and it has the effect of deleting existing description text.

Parameters:

description - description to be associated with this ESS metadata object.

setDescriptionKey

public final void setDescriptionKey(java.lang.String descriptionKey)

Sets the key to be used for lookup description in the associated resource bundles. A null value is acceptable and it has the effect of deleting the existing key.

Parameters:

descriptionKey - the entry to the resourcebundle representing the description to be associated with this ESS metadata object.

setResourceBundles

public final void setResourceBundles(java.lang.String[] resourceBundles)

Sets the message bundles to be associated with the translatable strings

Parameters:

resourceBundles - an array of resource bundle ids

localize

public void localize(oracle.as.scheduler.translation.TranslationService service,
                     oracle.as.scheduler.translation.TranslationContext context)

This method is used internally by MetadataService to localize the metadata translatable field before returning it to the caller.

Parameters:

service - the TranslationService to use for locating translations

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toCompositeData

protected final javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType compType,
                                                                         java.lang.String[] itemNames)

Convert an instance of this model specific type to a CompositeData. This ensure that clients that do not have access to the model specific class can still use the MBean. The MXBean framework can perform this conversion automatically. However MXBeans are part of JDK 6.0 and AS11g is required to support JDK 5.0 param ct This parameter is there only for future compatibility reasons with JDK 6.0. It can be ignored at this point.

from

public static <T extends BaseMetadata<T>> T from(BaseMetadataType<T> type,
                                                 javax.management.openmbean.CompositeData cd)
                                      throws java.lang.IllegalArgumentException

Create an instance of the model specific class out of an associated CompositeData instance

Throws:

java.lang.IllegalArgumentException

Skip navigation links