|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataObject
Represents an object in the metadata model for the EIS. A MetadataObject
represents an object that may or may not support some form of information
exchange with the client. If the object doesn not support a form of
information exchange, then it cannot be imported into a
ServiceDescription
.
A MetadataObject has a name, and a location within the metadata model for the EIS. This location is represented by a string identifier in an implementation-specific format.
MetadataObjects have a type (enumeration of types is defined by
MetadataObject.MetadataObjectType
), and may support zero or more types of
communication (for example request-response, notification or EIS-initiated
request-response).
MetadataObjects may be mutable (can be changed) or immutable. Mutable objects
allow customizations at design-time. For folders, and other objects that
allow children, this means that children can be added and removed at
design-time. For all objects, mutable means their properties can be changed.
Mutable objects define one or more operations that may be performed on them.
These operations are carried out with one or more steps within an
ObjectWizard
that knows
how to modify the object.
Nested Class Summary | |
---|---|
static interface |
MetadataObject.MetadataObjectType
An interface used to give tool environments a hint as to the nature of the associated MetadataObject. |
Method Summary | |
---|---|
ObjectWizard |
beginObjectWizard(Operation op)
Create an object wizard for the given operation. |
PropertyGroup |
createFilteringProperties()
Creates a new instance of the properties that can be used to filter out the children of this MetadataObject. |
MetadataImportConfiguration |
createImportConfiguration()
Create a MetadataImportConfiguration object for this Metadata object. |
PropertyGroup |
getAppliedFilter()
Returns the set of filtering properties that were applied to this MetadataObject to get its children. |
MetadataObjectResponse |
getChildren(PropertyGroup filterParameters)
Returns the children of this metadata object in the form of a MetadataObjectResponse |
String |
getDescription()
Returns an optional string description of the MetadataObject for tool environments to use when displaying the object to users. |
String |
getDisplayName()
Gets a display name that can be used within the tool environment to represent this MetadataObject. |
String |
getLocation()
Returns a location within the metadata model for the EIS. |
PropertyGroup |
getObjectProperties()
Gets the Read-only display properties of the metadata object. |
Operation[] |
getOperations()
Gets all allowed operations on this object. |
String |
getParentLocation()
Returns the location value of the parent of this MetadataObject. |
MetadataObject.MetadataObjectType |
getType()
Returns the MetadataObjectType that best describes the MetadataObject. |
boolean |
hasChildren()
Returns whether this metadata object has any children. |
boolean |
isMutable()
Indicates if this object is mutable, and therefore supports one or more operations that can be used to modify it. |
boolean |
isSelectableForImport()
Returns whether this metadata object can be imported into a ServiceDescription. |
Method Detail |
---|
MetadataImportConfiguration createImportConfiguration() throws MetadataException
MetadataDiscovery.createServiceDescription(commonj.connector.metadata.discovery.MetadataSelection)
.
null
MetadataImportConfiguration instance
representing and controlling the import of the given object.
MetadataException
- if an error occured during execution. A MetadataException
should only be thrown if it is impossible to create the
MetadataImportConfiguration. If a MetadataImportConfiguration
can be created but errors have occured then it should still
be returned and the errors logged with th
ToolContext
.MetadataService.setToolContext(commonj.connector.tool.ToolContext)
MetadataObjectResponse getChildren(PropertyGroup filterParameters) throws MetadataException
filterParameters
- A configured property group representing the desired filtering
of children nodes. If null
is passed in then no
filtering is performed. The property group that is used is
obtained using the createFilteringProperties()
method.
null
MetadataObjectResponse object.
MetadataException
- if an error occured during execution. A MetadataException
should only be thrown if it is impossible to create a
MetadataObjectResponse. If the request for children failed
this method should still return an empty
MetadataObjectResponse and include an error message to be
returned on the MetadataObjectResponse.getMessage()
method.String getDescription()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
is returned.ResourceBundle
,
MessageFormat
String getDisplayName()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
null
String representing the display name.ResourceBundle
,
MessageFormat
PropertyGroup getObjectProperties()
null
if none exist.PropertyGroup createFilteringProperties()
null
if none exist.PropertyGroup getAppliedFilter()
null
if no filter
was used.String getLocation()
MetadataTree.getMetadataObject(java.lang.String)
method.
null
String representing the
location.String getParentLocation()
getLocation()
on the parent MetadataObject.
null
if no parent exists. Only Metadata objects
that are at the very root of the EIS can have no parent. In
otherwords the first set of MetadataObjects
in the
the MetadataObjectResponse
that is returned from a
MetadataTree.listMetadataObjects(commonj.connector.metadata.discovery.properties.PropertyGroup)
method
call.getLocation()
MetadataObject.MetadataObjectType getType()
getObjectProperties()
. For example, an object
that is strictly used to hold, or group, other objects may be given a
MetadataObjectType.FOLDER. Another object that also allows children but
may also represent a more primary object might just have
MetadataObjectType.OBJECT and set hasChildren()
=
true
.
null
MetadataObjectType that describes the
metadata object.boolean hasChildren()
getChildren(commonj.connector.metadata.discovery.properties.PropertyGroup)
method needs to be
invoked.
boolean isSelectableForImport()
MetadataImportConfiguration
can be created for
this MetadataObject.
ServiceDescription
,
MetadataImportConfiguration
boolean isMutable()
getOperations()
method to
determine which operations are allowed for this object.
Operation[] getOperations() throws MetadataException
beginObjectWizard(commonj.connector.metadata.discovery.mutable.Operation)
method.
null
array of Operation
s
supported by this metadata object. If this metadata object is not
mutable then the returned array must be empty.
MetadataException
- if an error occured during execution.beginObjectWizard(Operation)
ObjectWizard beginObjectWizard(Operation op) throws MetadataException
The operation being passed in must be non- null
and and
the ObjectWizard that is returned must also be non- null
.
An exception is thrown if an object wizard cannot be returned.
op
- a non null
Operation.
null
ObjectWizard used to carry out the
sequence of steps needed to accomplish the indicated operation on
the indicated MetadataObject.
MetadataException
- Thrown if unable to return the ObjectWizard. This includes
conditions where this metadata object is not mutable and
hence cannot support any operation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |