|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Metadata
Metadata interface. Provides programmatic access to the contents of DSP metadata artifacts, namely DS, XSD, WS and WS policy files. Access is read-only.
Method Summary | |
---|---|
java.util.Collection |
findFunctionCollectionRefs(java.lang.String scope,
SearchCriteria criteria)
|
java.lang.String |
generateReport(ReportSpec spec)
|
java.util.Collection |
getDependencyRefs(NodeRef reference)
This call supports deferred resolution of metadata artifact dependencies. |
java.util.Collection |
getDependencyRefs(NodeRef reference,
ImpactAnalysisOptions options)
This call supports deferred resolution of metadata artifact dependencies. |
java.util.Collection |
getDependentRefs(NodeRef reference)
This call supports deferred resolution of metadata artifact dependents. |
java.util.Collection |
getDependentRefs(NodeRef reference,
ImpactAnalysisOptions options)
This call supports deferred resolution of metadata artifact dependents. |
Function |
getFunction(FunctionRef reference)
This is a convenience singleton method, provided in addition to the collection method
for the case when the collection parameter is a singleton. |
FunctionCollection |
getFunctionCollection(FunctionCollectionRef reference)
This is a convenience singleton method, provided in addition to the collection method
for the case when the collection parameter is a singleton. |
java.util.Collection |
getFunctionCollections(java.util.Collection references)
|
java.util.Collection |
getFunctions(java.util.Collection references)
|
RepositoryNode |
getRepositoryRoot()
The root of the repository tree. |
Schema |
getSchema(SchemaRef reference)
This is a convenience singleton method, provided in addition to the collection method
for the case when the collection parameter is a singleton. |
java.util.Collection |
getSchemas(java.util.Collection references)
|
WebService |
getWebService(WebServiceRef reference)
This is a convenience singleton method, provided in addition to the collection method
for the case when the collection parameter is a singleton. |
java.util.Collection |
getWebServicePolicies(java.util.Collection references)
|
WebServicePolicy |
getWebServicePolicy(WebServicePolicyRef reference)
This is a convenience singleton method, provided in addition to the collection method
for the case when the collection parameter is a singleton. |
java.util.Collection |
getWebServices(java.util.Collection references)
|
Method Detail |
---|
RepositoryNode getRepositoryRoot()
java.util.Collection findFunctionCollectionRefs(java.lang.String scope, SearchCriteria criteria)
scope
- The prefix that all the LD locators in the result should match.
It can be used to limit the scope under particular subfolders
(e.g. by setting the scope to "ld:d1/"). It may be null
.criteria
- Used to specify name-based and/or content-based filters that
should be used during the search. It may be null
.
java.lang.String generateReport(ReportSpec spec)
spec
- A user-defined specification determining the contents
of the metadata report.
java.util.Collection getDependencyRefs(NodeRef reference) throws com.bea.ld.MetadataException
Depending on the kind of metadata artifact specified by reference, the results of this call are as follows:
FunctionCollection
instances, the resulting
collection includes the references to all function collections
and all schemas upon which this function collection depends.
Schema
instances, the resulting collection
includes the references to all schemas upon which this
schema depends.
Function
instances, the resulting collection
includes the references to all functions upon which this function
depends and all schemas upon which the signature of this function
depends.
WebService
instances, the resulting
collection includes the references to all function collections
and all web service policies upon which this function collection depends.
WebServicePolicy
instances, this method returns
an empty collection.
reference
- The reference to a metadata artifact. May not be null.
com.bea.ld.MetadataException
- If the introspection of the specified node failed.
java.lang.IllegalArgumentException
- If reference is null.com.bea.ld.metadata.EntityNode#getDependencyRefs() EntityNode}
java.util.Collection getDependencyRefs(NodeRef reference, ImpactAnalysisOptions options) throws com.bea.ld.MetadataException
Depending on the kind of metadata artifact specified by reference, the results of this call are as follows:
FunctionCollection
instances, the resulting
collection includes the references to all function collections
and all schemas upon which this function collection depends.
Schema
instances, the resulting collection
includes the references to all schemas upon which this
schema depends.
Function
instances, the resulting collection
includes the references to all functions upon which this function
depends and all schemas upon which the signature of this function
depends.
WebService
instances, the resulting
collection includes the references to all function collections
and all web service policies upon which this function collection depends.
WebServicePolicy
instances, this method returns
an empty collection.
reference
- The reference to a metadata artifact. May not be null.options
- A set of flags providing settings used by dependency analysis.
May not be null.
com.bea.ld.MetadataException
- If the introspection of the specified node failed.
java.lang.IllegalArgumentException
- If reference or options is null.com.bea.ld.metadata.EntityNode#getDependencyRefs() EntityNode}
,
com.bea.ld.metadata.ImpactAnalysisOptions ImpactAnalysisOptions}
java.util.Collection getDependentRefs(NodeRef reference) throws com.bea.ld.MetadataException
Depending on the kind of metadata artifact specified by reference, the results of this call are as follows:
FunctionCollection
instances, the resulting
collection includes the references to all function collections
and web services that depend on the specified function collection.
Schema
instances, this method is not supported.
Function
instances, the resulting collection
includes the references to all functions that depend on the specified
function.
WebService
instances, this method return an empty
collection.
WebServicePolicy
instances, the resulting collection
includes the references to all the web services that depend on the
specified web service policy.
reference
- The reference to a metadata artifact. May not be null.
com.bea.ld.MetadataException
- If the introspection of the specified node failed.
java.lang.IllegalArgumentException
- If reference is null.com.bea.ld.metadata.EntityNode.getDependentRefs() EntityNode}
java.util.Collection getDependentRefs(NodeRef reference, ImpactAnalysisOptions options) throws com.bea.ld.MetadataException
Depending on the kind of metadata artifact specified by reference, the results of this call are as follows:
FunctionCollection
instances, the resulting
collection includes the references to all function collections
and web services that depend on the specified function collection.
Schema
instances, this method is not supported.
Function
instances, the resulting collection
includes the references to all functions that depend on the specified
function.
WebService
instances, this method return an empty
collection.
WebServicePolicy
instances, the resulting collection
includes the references to all the web services that depend on the
specified web service policy.
reference
- The reference to a metadata artifact. May not be null.options
- A set of flags providing settings used by dependent analysis.
com.bea.ld.MetadataException
- If the introspection of the specified node failed.
java.lang.IllegalArgumentException
- If reference or options is null.com.bea.ld.metadata.EntityNode.getDependentRefs() EntityNode}
,
com.bea.ld.metadata.ImpactAnalysisOptions ImpactAnalysisOptions}
java.util.Collection getFunctionCollections(java.util.Collection references) throws com.bea.ld.MetadataException
references
- A collection of function collection references.
If null this method returns an empty collection.
com.bea.ld.MetadataException
- If the introspection of at least one of the specified nodes failed,
or if one of the specified references is not a function collection
reference.java.util.Collection getSchemas(java.util.Collection references) throws com.bea.ld.MetadataException
references
- A collection of schema references.
If null this method returns an empty collection.
com.bea.ld.MetadataException
- If the introspection of at least one of the specified nodes failed,
or if one of the specified references is not a schema reference.java.util.Collection getWebServices(java.util.Collection references) throws com.bea.ld.MetadataException
references
- A collection of webservice references.
If null this method returns an empty collection.
com.bea.ld.MetadataException
- If the introspection of at least one of the specified nodes failed,
or if one of the specified references is not a webservice reference.java.util.Collection getWebServicePolicies(java.util.Collection references) throws com.bea.ld.MetadataException
references
- A collection of webservice policy references.
If null this method returns an empty collection.
com.bea.ld.MetadataException
- If the introspection of at least one of the specified nodes failed,
or if one of the specified references is not a webservice policy reference.java.util.Collection getFunctions(java.util.Collection references) throws com.bea.ld.MetadataException
references
- A collection of function references.
If null this method returns an empty collection.
com.bea.ld.MetadataException
- If the introspection of at least one of the specified nodes failed,
or if one of the specified references is not a function reference.FunctionCollection getFunctionCollection(FunctionCollectionRef reference) throws com.bea.ld.MetadataException
the collection method
for the case when the collection parameter is a singleton.
reference
- A function collection reference.
com.bea.ld.MetadataException
- If the introspection of the specified node failed, or if the
specified reference is not a function collection reference.Schema getSchema(SchemaRef reference) throws com.bea.ld.MetadataException
the collection method
for the case when the collection parameter is a singleton.
reference
- A schema reference.
com.bea.ld.MetadataException
- If the introspection of the specified node failed, or if the
specified reference is not a schema reference.Function getFunction(FunctionRef reference) throws com.bea.ld.MetadataException
the collection method
for the case when the collection parameter is a singleton.
reference
- A function reference.
com.bea.ld.MetadataException
- If the introspection of the specified node failed, or if the
specified reference is not a function reference.WebService getWebService(WebServiceRef reference) throws com.bea.ld.MetadataException
the collection method
for the case when the collection parameter is a singleton.
reference
- A webservice reference.
com.bea.ld.MetadataException
- If the introspection of the specified node failed, or if the
specified reference is not a webservice reference.WebServicePolicy getWebServicePolicy(WebServicePolicyRef reference) throws com.bea.ld.MetadataException
the collection method
for the case when the collection parameter is a singleton.
reference
- A webservice policy reference.
com.bea.ld.MetadataException
- If the introspection of the specified node failed, or if the
specified reference is not a webservice policy reference.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |