Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.5)
E20742-01


oracle.as.scheduler
Class MetadataObjectId

java.lang.Object
  extended by oracle.as.scheduler.MetadataObjectId
All Implemented Interfaces:
java.io.Serializable, oracle.as.scheduler.security.MetadataPermissionId

public abstract class MetadataObjectId
extends java.lang.Object
implements java.io.Serializable, oracle.as.scheduler.security.MetadataPermissionId

Identifier for metadata objects. Instances of the class uniquely identify metadata objects in the metadata repository.

This unique identifier contains the fully qualified name for the a given metadata object. Methods declared in this class allow access to individual parts within the fully qualified name.

See Also:
Serialized Form

Nested Class Summary
static class MetadataObjectId.MetadataObjectType
          Enumeration for all the supported metadata object types.
 
Field Summary
protected static java.lang.String[] s_itemNames
           
 
Constructor Summary
MetadataObjectId()
           
 
Method Summary
static MetadataObjectId createMetadataObjectId(MetadataObjectId.MetadataObjectType type, java.lang.String packageName, java.lang.String name)
          Creates an instance of a MetadataObjectId from the given individual parts.
static MetadataObjectId from(javax.management.openmbean.CompositeData cd)
          Create an instance of the model specific class out of an associated CompositeData instance
protected  javax.management.openmbean.CompositeType getCompositeType()
           
abstract  java.lang.String getNamePart()
          Returns the name of this metadata object identifier.
abstract  java.lang.String getPackagePart()
          Returns the package (namespace) for this metadata object identifier.
abstract  MetadataObjectId.MetadataObjectType getType()
          Returns the type of this metadata object identifier.
abstract  javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)
          Convert an instance of this model specific type to a CompositeData.
static javax.management.openmbean.CompositeType toCompositeType()
          Returns the CompositeType that describes this model specific class
abstract  java.lang.String toPermissionString()
          Returns a string representation of this suitable for use in permission grants.
abstract  java.lang.String toString()
          Returns a string representation of this instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

s_itemNames

protected static final java.lang.String[] s_itemNames
Constructor Detail

MetadataObjectId

public MetadataObjectId()
Method Detail

getCompositeType

protected javax.management.openmbean.CompositeType getCompositeType()

getPackagePart

public abstract java.lang.String getPackagePart()
Returns the package (namespace) for this metadata object identifier.

A metadata object is created and resides in the given package or namespace within the metadata repository.

Returns:
the package (namespace) of this metadata object. This will be null is a package was not specified.

getNamePart

public abstract java.lang.String getNamePart()
Returns the name of this metadata object identifier.

This is the name with which the metadata object was created and persisted in the repository using the metadata service.

Returns:
the name portion of the id. This will never be null.

getType

public abstract MetadataObjectId.MetadataObjectType getType()
Returns the type of this metadata object identifier.

Returns:
the type of this instance.

toString

public abstract java.lang.String toString()
Returns a string representation of this instance.

Overrides:
toString in class java.lang.Object
Returns:
the string representation of this instance.

toPermissionString

public abstract java.lang.String toPermissionString()
Returns a string representation of this suitable for use in permission grants.

Specified by:
toPermissionString in interface oracle.as.scheduler.security.MetadataPermissionId
Returns:
the permission string representation of this instance.

createMetadataObjectId

public static MetadataObjectId createMetadataObjectId(MetadataObjectId.MetadataObjectType type,
                                                      java.lang.String packageName,
                                                      java.lang.String name)
Creates an instance of a MetadataObjectId from the given individual parts. This method can be useful in submitting a request for specific known metadata objects, where querying such objects via MetadataService is not required.

This method simply assembles an identifier from individual parts. It does not guarantee that the MetadataObjectId created represents a real metadata object in the repository.

Parameters:
type - the type of MetadataObjectId to be created.
packageName - the package of the metadata object for which the id is being created. The package should follow the "/pkg1/pkg2/..." format.
name - the name of metadata object for this id is being created.
Returns:
a MetadataObjectId created from given individual parts.

toCompositeData

public abstract javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)
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

Parameters:
ct - This parameter is there only for future compatibility reasons with JDK 6.0. It can be ignored at this point.

toCompositeType

public static javax.management.openmbean.CompositeType toCompositeType()
Returns the CompositeType that describes this model specific class


from

public static MetadataObjectId from(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

Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.5)
E20742-01


Copyright © 2008, 2011 Oracle. All rights reserved.