Package oracle.as.scheduler

Interface MetadataService

All Known Subinterfaces:
MetadataServiceRemote
public interface MetadataService
Metadata Service API.

The MetadataService interface is the main contract for accessing and manipulating the application metadata stored in the metadata repository. Access to the metadata objects is exposed only via the MetadataService interface.

The MetadataService is exposed as a stateless session EJB. External clients must access the service only through the corresponding EJB. Clients should not interact with the internal API layer directly.

Since clients access the metadata services through the stateless session EJB, all the methods in this interface accepts a reference to a MetadataServiceHandle argument that is used to store state across multiple calls, for example when multiple methods are to be called within a user transaction.

Clients do not need to access or manipulate the MetadataServiceHandle. They just need to hold on to the reference created by the open method and pass it in to methods being called. Finally the handle must explicitly be closed by calling close method. Only upon calling the close method, any changes made using a given handle are committed (or aborted).

The MetadataService APIs allow partitioning of metadata into packages by providing the desired package while adding metadata. These packages follow the standard syntax of the form "/pkg1/pkg2" and so on. The leading "/" is optional.

For example, while creating a JobType, providing the package as "/test" will create the object under "/test" whereas a value of "demo/basic" will create the object under "/demo/basic". If a null package is provided, the object gets created under "/".

Please note that the uniqueness of metadata objects are automatically within the scope of a given package (namespace). Therefore within a given package two metadata objects with the same name (obviously of the same type) cannot be created.

Customization Support

This class supports limited customization for certain ESS metadata. The customizeJobDefinition method can be used to customize certain properties for a JobDefintion. The customizeJobSet method can be used to customize certain properties for a JobSet.

This allows customization of a property for a piece of metadata without changing the base metadata. This works by using MDS metadata customization. The property must be a member of the one of the MetadataService.CustomizableProperty enums, otherwise an exception will be thrown.

Non customizing methods such as updateJobDefinition, updateJobSet, and so on, modify the base metadata definition. When this metadata is upgraded, all of these changes are lost. However, if these changes are made using MDS customizations, then they can survive across upgrades to the base metadata.

In order for this feature to fully work, the application must define a customization class in its adf-config.xml. Refer to MDS documentation on how to do this.

  • Method Details

    • open

      MetadataServiceHandle open() throws MetadataServiceException
      Opens a session with the MetadataService. Relevant translatable fields will be retrieved with default locale.

      This method returns an instance of MetadataServiceHandle that represents a session (connection) to application's metadata repository. This handle must be used in subsequent method calls.

      Eventually, this handle must be closed by calling one of the close methods to commit or rollback any changes made on this handle and to release any resources held by this handle. That instance of the handle must not be used after close is called.

      Returns:
      an MetadataServiceHandle representing a session to application's metadata repository.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • open

      MetadataServiceHandle open(Locale locale) throws MetadataServiceException
      Opens a session with the MetadataService. Relevant translatable fields will be retrieved in the given locale.

      This method returns an instance of MetadataServiceHandle that represents a session (connection) to application's metadata repository. This handle must be used in subsequent method calls.

      Eventually, this handle must be closed by calling one of the close methods to commit or rollback any changes made on this handle and to release any resources held by this handle. That instance of the handle must not be used after close is called.

      Parameters:
      locale - the desired Locale to use.
      Returns:
      an instance of the MetadataServiceHandle representing a session to application's metadata repository.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • close

      void close(MetadataServiceHandle handle) throws ConcurrentUpdateException, ValidationException, MetadataServiceException
      Closes the session identified by an instance of MetadataServiceHandle.

      Calling this method commits any changes made on the handle being passed. However, if a UserTransaction is active while this method is invoked, the actual commit will happen as per the UserTranaction being active.

      MetadataService handles concurrent modifications of metadata via multiple sessions in an optimistic way. During commit, if concurrent changes are detected (implying that the updates are not attempted on the latest version of an object in this session), an exception is thrown.

      Parameters:
      handle - the MetadataServiceHandle to be closed. This handle instance must not be used after close is called.
      Throws:
      ConcurrentUpdateException - if any metadata objects modified/created in this session are also modified/created by another session concurrently.
      ValidationException - if validation fails for any changes done via the given handle.
      MetadataServiceException - if the handle is null, or metadata sub-system error.

    • close

      void close(MetadataServiceHandle handle, boolean abort) throws ConcurrentUpdateException, ValidationException, MetadataServiceException
      Closes the session identified by an instance of MetadataServiceHandle.

      Calling this method commits or rolls back any changes made on the handle being passed. However if a UserTransaction is active while this method is invoked, the actual commit or rollback will happen as per the UserTranaction being active.

      MetadataService handles concurrent modifications of metadata via multiple sessions in an optimistic way. During commit, if concurrent changes are detected (implying that the updates are not attempted on the * latest version of an object in this session), an exception is thrown.

      Parameters:
      handle - the MetadataServiceHandle to be closed. This handle instance must not be used after close is called.
      abort - true to roll back any changes made using this handle, or false to commit any changes.
      Throws:
      ConcurrentUpdateException - if any metadata objects modified/created in this session are also modified/created by another session concurrently.
      ValidationException - if validation fails for any changes done via the given handle.
      MetadataServiceException - if the handle is null, or metadata sub-system error.

    • getMetadata

      <METADATA_TYPE extends BaseMetadata<METADATA_TYPE>> METADATA_TYPE getMetadata(MetadataServiceHandle handle, BaseMetadataType<METADATA_TYPE> metadataType, MetadataObjectId metadataObjectId, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      A generic getter for any type of metadata. Added after JDK 1.5 uptake which included support for generics.
      Parameters:
      handle - the MetadataServiceHandle to use.
      metadataType - the type of metadata to get; for example, Schedule, JobDefinition, JobType, and so on.
      metadataObjectId - the id of the object to get.
      forUpdate - the value of this parameter should be false. A false value will mark the underlying MDS object as read-only.
      Note: This parameter is essentially meaningless and deprecated since access to the underlying MDS object is not provided. A value of false should be used for performance reasons.
      Returns:
      the metadata object as defined by metadataObjectId casted as defined by the generic type of metadataType.
      Throws:
      MetadataNotFoundException - if metadata for the specified object was not found.
      MetadataServiceException - if metadata sub-system error.

    • queryMetadata

      <METADATA_TYPE extends BaseMetadata<METADATA_TYPE>> List<MetadataObjectId> queryMetadata(MetadataServiceHandle handle, BaseMetadataType<METADATA_TYPE> metadataType, MetadataQueryFilter<METADATA_TYPE> queryFilter, oracle.as.scheduler.metadata.query.MetadataQueryField orderBy, boolean ascending) throws MetadataServiceException
      A generic query mechanism for any type of metadata. Added after JDK 1.5 uptake which included support for generics.
      Parameters:
      handle - the MetadataServiceHandle to use.
      metadataType - the type of metadata to get; for example, Schedule, JobDefinition, JobType, and so on.
      queryFilter - used to filter the query results.
      orderBy - the field used to order the query results.
      ascending - true to list the results in ascending order (a-z), or false in descending order (z-a).
      Returns:
      a list of MetadataObjectIds matching the filter criteria.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryMetadataObjects

      <METADATA_TYPE extends BaseMetadata<METADATA_TYPE>> List<METADATA_TYPE> queryMetadataObjects(MetadataServiceHandle handle, BaseMetadataType<METADATA_TYPE> metadataType, MetadataQueryFilter<METADATA_TYPE> queryFilter, oracle.as.scheduler.metadata.query.MetadataQueryField orderBy, boolean ascending) throws MetadataServiceException
      A generic query mechanism for any type of metadata. Added after JDK 1.5 uptake which included support for generics.
      Parameters:
      handle - the MetadataServiceHandle to use.
      metadataType - the type of metadata to get; for example, Schedule, JobDefinition, JobType, and so on.
      queryFilter - used to filter the query results.
      orderBy - an optional field used to order the query results.
      ascending - true to list the results in ascending order (a-z), or false in descending order (z-a).
      Returns:
      a list of metadata objects as defined by metadataType that match the filter criteria.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • customizeJobDefinition

      void customizeJobDefinition(MetadataServiceHandle handle, JobDefinition jobDefinition, MetadataService.CustomizableProperty property, Serializable newValue) throws ValidationException, MetadataNotFoundException, MetadataServiceException
      Customize a property for JobDefinition metadata.

      See class comments for addtional information.

      Parameters:
      handle - the MetadataServiceHandle to use.
      jobDefinition - the instance of the JobDefinition to be customized.
      property - the property to be customized.
      newValue - the new value to use to customize the property.
      Throws:
      ValidationException - if validation fails for any changes done via the given handle.
      MetadataNotFoundException - if metadata for the specified object was not found.
      MetadataServiceException - if metadata sub-system error.

    • customizeJobSet

      void customizeJobSet(MetadataServiceHandle handle, JobSet jobSet, MetadataService.CustomizableProperty property, Serializable newValue) throws ValidationException, MetadataNotFoundException, MetadataServiceException
      Customize a property for JobSet metadata.

      See class comments for addtional information.

      Parameters:
      handle - the MetadataServiceHandle to use.
      jobSet - the instance of the JobSet to be customized.
      property - the property to be customized.
      newValue - the new value to use to customize the property.
      Throws:
      ValidationException - if validation fails for any changes done via the given handle.
      MetadataNotFoundException - if metadata for the specified object was not found.
      MetadataServiceException - if metadata sub-system error.

    • addJobType

      MetadataObjectId addJobType(MetadataServiceHandle handle, JobType jobType, String packageName) throws ValidationException, AlreadyExistsException, MetadataServiceException
      Adds a JobType in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      jobType - the instance of the JobType to persist.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      Returns:
      the unique identifier for accessing the newly created metadata object.
      Throws:
      ValidationException - if validation of theJobType fails.
      AlreadyExistsException - if a JobType with the same name already exists.
      MetadataServiceException - if metadata sub-system error.

    • getJobType

      JobType getJobType(MetadataServiceHandle handle, MetadataObjectId objectId, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves a JobType from the metadata repository.

      This method returns either a mutable or immutable instance of the given object as desired. When changes are required to be made, a mutable instance must always be fetched.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobType to be retrieved.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      an instance of the JobType for the given name.
      Throws:
      MetadataNotFoundException - if a JobType for objectId does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getJobTypes

      JobType[] getJobTypes(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieve an array of JobTypes from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the order of the returned metadata objects is the same as the order of the IDs in the objectIds parameter.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the JobTypes to be retrieved.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      the JobTypes for the given object ids.
      Throws:
      MetadataNotFoundException - if a JobType with a given metadata id does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getJobTypesMap

      Map<MetadataObjectId,JobType> getJobTypesMap(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataServiceException
      Retrieves a map of JobTypes for MetadataObjectIds from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the returned metadata objects is mapped to corresponding IDs in the objectIds parameter. For a missing metadata, MetadataNotFoundException will not be thrown and null is set at the value part of corresponding entry in the returned map.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the JobTypes to be retrieved.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      Map with appropriate JobTypes for the given object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobTypes

      Enumeration<MetadataObjectId> queryJobTypes(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query JobTypes that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the metadata object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobTypeObjects

      Enumeration<JobType> queryJobTypeObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query JobTypes that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the job types matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobTypeObjects

      Enumeration<JobType> queryJobTypeObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending, String[] paramsToExclude) throws MetadataServiceException
      Query JobTypes that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      paramsToExclude - a list of parameter names to exclude from the query results. For example, given ["param1", "param2"] as the value, any metadata containing a parameter in the ParameterList with the name "param1" or the name "param2" will be excluded from the query results.
      Returns:
      an enumeration of the job types matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • updateJobType

      void updateJobType(MetadataServiceHandle handle, MetadataObjectId objectId, JobType jobType) throws MetadataNotFoundException, ValidationException, MetadataServiceException
      Updates an existing JobType definition in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the metadata object to update.
      jobType - the modified JobType to persist.
      Throws:
      MetadataNotFoundException - if a JobType for objectId does not exist.
      ValidationException - if validation of the given JobType fails.
      MetadataServiceException - if metadata sub-system error.

    • copyJobType

      MetadataObjectId copyJobType(MetadataServiceHandle handle, MetadataObjectId objectId, String packageName, String newName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Copies a JobType to create another with the given name. The newly created JobType is automatically persisted in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobType to be copied.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      newName - the name to be assigned to the new JobType.
      Returns:
      the unique identifier for the newly created (copied) JobType.
      Throws:
      MetadataNotFoundException - if a JobType for objectId does not exist.
      ValidationException - if validation of the JobType fails.
      AlreadyExistsException - if a JobType for newName already exists.
      MetadataServiceException - if metadata sub-system error.

    • deleteJobType

      void deleteJobType(MetadataServiceHandle handle, MetadataObjectId objectId) throws MetadataServiceException
      Deletes a JobType from the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobType to delete.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • addJobDefinition

      MetadataObjectId addJobDefinition(MetadataServiceHandle handle, JobDefinition jobDefn, String packageName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Adds a JobDefinition to the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      jobDefn - the instance of the JobDefinition to persist.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      Returns:
      the unique identifier for accessing the newly created metadata object.
      Throws:
      MetadataNotFoundException - if the JobType for the given JobDefinition does not exist.
      ValidationException - if validation of the JobDefinition fails.
      AlreadyExistsException - if a JobDefinition with the same name already exists.
      MetadataServiceException - if metadata sub-system error.

    • getJobDefinition

      JobDefinition getJobDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves a JobDefinition from the metadata repository.

      This method returns either a mutable or immutable instance of the given object as desired. When changes are required to be made, a mutable instance must always be fetched.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobDefinition to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      an instance of the JobDefinition for the given name.
      Throws:
      MetadataNotFoundException - if a JobDefinition for objectId does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getJobDefinitions

      JobDefinition[] getJobDefinitions(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves an array of JobDefinitions from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the order of the returned metadata objects is the same as the order of the IDs in the objectIds parameter.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the JobDefinitions to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      JobDefinitions for the given object ids.
      Throws:
      MetadataNotFoundException - if a JobDefinition for a given metadata id does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getJobDefinitionsMap

      Map<MetadataObjectId,JobDefinition> getJobDefinitionsMap(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataServiceException
      Retrieves map of JobDefinitions for MetadataObjectIds from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the returned metadata objects is mapped to corresponding IDs in the objectIds parameter. For a missing metadata, MetadataNotFoundException will not be thrown and null is set at the value part of corresponding entry in the returned map.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the JobDefinitions to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      a Map with JobDefinitions for the given object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobDefinitions

      Enumeration<MetadataObjectId> queryJobDefinitions(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query JobDefinitions that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the metadata object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobDefinitionObjects

      Enumeration<JobDefinition> queryJobDefinitionObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query JobDefinitions that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the JobDefinitions matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobDefinitionObjects

      Enumeration<JobDefinition> queryJobDefinitionObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending, String[] paramsToExclude) throws MetadataServiceException
      Query JobDefinitions that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      paramsToExclude - list of parameter names to exclude from the query results. For example, given ["param1", "param2"] as the value, any metadata containing a parameter in the ParameterList with the name "param1" or the name "param2" will be excluded from the query results.
      Returns:
      an enumeration of the JobDefinitions matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • updateJobDefinition

      void updateJobDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, JobDefinition jobDefn) throws MetadataNotFoundException, ValidationException, MetadataServiceException
      Updates an existing JobDefinition definition in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the metadata object to update.
      jobDefn - the modified JobDefinition to persist.
      Throws:
      MetadataNotFoundException - if a JobDefinition for objectId does not exist.
      ValidationException - if validation of the given JobDefinition fails.
      MetadataServiceException - if metadata sub-system error.

    • copyJobDefinition

      MetadataObjectId copyJobDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, String packageName, String newName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Copies a JobDefinition to create another with the given name. The newly created JobDefinition is automatically persisted in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobDefinition to be copied.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      newName - the name to be assigned to the new JobDefinition.
      Returns:
      the unique identifier for the newly created (copied) JobDefinition.
      Throws:
      MetadataNotFoundException - if a JobDefinition for objectId does not exist.
      ValidationException - if validation of the JobDefinition fails.
      AlreadyExistsException - if a JobDefinition for newName already exists.
      MetadataServiceException - if metadata sub-system error.

    • deleteJobDefinition

      void deleteJobDefinition(MetadataServiceHandle handle, MetadataObjectId objectId) throws MetadataServiceException
      Deletes a JobDefinition from the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobDefinition to delete.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • addJobSet

      MetadataObjectId addJobSet(MetadataServiceHandle handle, JobSet jobset, String packageName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Adds a JobSet to the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      jobset - the instance of the JobSet to persist.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      Returns:
      the unique identifier for accessing the newly created metadata object.
      Throws:
      MetadataNotFoundException - if a JobDefinition or JobSet referenced in the supplied JobSet does not exist.
      ValidationException - if validation of the JobSet fails.
      AlreadyExistsException - if a JobSet with the same name already exists.
      MetadataServiceException - if metadata sub-system error.

    • getJobSet

      JobSet getJobSet(MetadataServiceHandle handle, MetadataObjectId objectId, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves a JobSet from the metadata repository.

      This method returns either a mutable or immutable instance of the given object as desired. When changes are required to be made, a mutable instance must always be fetched.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobSet to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      an instance of the JobSet for the given name.
      Throws:
      MetadataNotFoundException - if a JobSet for objectId does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getJobSets

      JobSet[] getJobSets(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves an array of JobSets from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the order of the returned metadata objects is the same as the order of the IDs in the objectIds parameter.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the JobSets to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      JobSets for the given object ids.
      Throws:
      MetadataNotFoundException - if a JobSet with a given metadata id does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getJobSetsMap

      Map<MetadataObjectId,JobSet> getJobSetsMap(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataServiceException
      Retrieves a map of JobSets for MetadataObjectIds from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the returned metadata objects is mapped to corresponding IDs in the objectIds parameter. For a missing metadata, MetadataNotFoundException will not be thrown and null is set at the value part of corresponding entry in the returned map.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the JobSets to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      Map of corresponding JobSets for the given object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobSets

      Enumeration<MetadataObjectId> queryJobSets(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query JobSets that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the metadata object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobSetObjects

      Enumeration<JobSet> queryJobSetObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query JobSets that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the JobSets matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryJobSetObjects

      Enumeration<JobSet> queryJobSetObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending, String[] paramsToExclude) throws MetadataServiceException
      Query JobSets that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      paramsToExclude - list of parameter names to exclude from the query results. For example, given ["param1", "param2"] as the value, any metadata containing a parameter in the ParameterList with the name "param1" or the name "param2" will be excluded from the query results.
      Returns:
      an enumeration of the JobSets matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • updateJobSet

      void updateJobSet(MetadataServiceHandle handle, MetadataObjectId objectId, JobSet jobset) throws MetadataNotFoundException, ValidationException, MetadataServiceException
      Updates an existing JobSet definition in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the metadata object to update.
      jobset - the modified JobSet to persist.
      Throws:
      MetadataNotFoundException - if a JobSet for objectId does not exist.
      ValidationException - if validation the given JobSet fails.
      MetadataServiceException - if metadata sub-system error.

    • copyJobSet

      MetadataObjectId copyJobSet(MetadataServiceHandle handle, MetadataObjectId objectId, String packageName, String newName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Copies a JobSet to create another with the given name. The newly created JobSet is automatically persisted in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobSet to be copied.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      newName - the name to be assigned to the new JobSet.
      Returns:
      the unique identifier for the newly created (copied) JobSet.
      Throws:
      MetadataNotFoundException - if a JobSet for objectId does not exist.
      ValidationException - if validation of the JobSet fails.
      AlreadyExistsException - if a JobSet for newName already exists.
      MetadataServiceException - if metadata sub-system error.

    • deleteJobSet

      void deleteJobSet(MetadataServiceHandle handle, MetadataObjectId objectId) throws MetadataServiceException
      Deletes a JobSet from the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the JobSet to delete.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • addIncompatibility

      MetadataObjectId addIncompatibility(MetadataServiceHandle handle, Incompatibility incompatibility, String packageName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Adds an Incompatibility in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      incompatibility - the instance of the Incompatibility to persist.
      packageName - the optional the package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      Returns:
      the unique identifier for accessing the newly created metadata object.
      Throws:
      MetadataNotFoundException - if any JobDefinition or JobSet referenced in the Incompatibility do not exist.
      ValidationException - if validation of the Incompatibility fails.
      AlreadyExistsException - if an Incompatibility with the same name already exists.
      MetadataServiceException - if metadata sub-system error.

    • getIncompatibility

      Incompatibility getIncompatibility(MetadataServiceHandle handle, MetadataObjectId objectId, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves an Incompatibility from the metadata repository.

      This method returns either a mutable or immutable instance of the given object as desired. When changes are required to be made, a mutable instance must always be fetched.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the Incompatibility to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      instance of the Incompatibility for the given identifier.
      Throws:
      MetadataNotFoundException - if an Incompatibility for objectId does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getIncompatibilities

      Incompatibility[] getIncompatibilities(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieve an array of Incompatibilities from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the order of the returned metadata objects is the same as the order of the IDs in the objectIds parameter.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the Incompatibilities to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      Incompatibilities for the given object ids.
      Throws:
      MetadataNotFoundException - if an Incompatibility for a given metadata id does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getIncompatibilitiesMap

      Map<MetadataObjectId,Incompatibility> getIncompatibilitiesMap(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataServiceException
      Retrieves map of Incompatibilities for MetadataObjectIds from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the returned metadata objects is mapped to corresponding IDs in the objectIds parameter. For a missing metadata, MetadataNotFoundException will not be thrown and null is set at the value part of corresponding entry in the returned map.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the Incompatibilities to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      Map of corresponding Incompatibilities for the given object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • getIncompatibilities

      @Deprecated Collection<Incompatibility> getIncompatibilities(MetadataServiceHandle handle, MetadataObjectId entity) throws MetadataServiceException
      Deprecated.
      Retrieves all the Incompatibilities associated with a given JobDefinition or JobSet. The method should be used to directly retrieve all the JobDefinition or JobSets that are incompatible with a given Job or JobSet. Each Incompatibility returned will always contain the given JobDefinition or JobSet as one of the entity.
      Parameters:
      handle - the MetadataServiceHandle to use.
      entity - the unique identifier of the JobDefinition or JobSet for which all the Incompatibilities will be returned.
      Returns:
      instances of the Incompatibilities for the given identifier.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryIncompatibilities

      Enumeration<MetadataObjectId> queryIncompatibilities(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query Incompatibilities that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the metadata object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryIncompatibilityObjects

      Enumeration<Incompatibility> queryIncompatibilityObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query Incompatibilities that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the Incompatibilities matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • updateIncompatibility

      void updateIncompatibility(MetadataServiceHandle handle, MetadataObjectId objectId, Incompatibility incompatibility) throws MetadataNotFoundException, ValidationException, MetadataServiceException
      Updates an existing Incompatibility definition in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the metadata object to modify.
      incompatibility - the modified Incompatibility to persist.
      Throws:
      MetadataNotFoundException - if an Incompatibility for objectId does not exist.
      ValidationException - if validation of the Incompatibility fails.
      MetadataServiceException - if metadata sub-system error.

    • copyIncompatibility

      MetadataObjectId copyIncompatibility(MetadataServiceHandle handle, MetadataObjectId objectId, String packageName, String newName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Copies an Incompatibility to create another with the given name. The newly created Incompatibility is automatically persisted in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the Incompatibility to be copied.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      newName - the name to be assigned to the new Incompatibility.
      Returns:
      the unique identifier for the newly created (copied) Incompatibility.
      Throws:
      MetadataNotFoundException - if an Incompatibility for objectId does not exist.
      ValidationException - if validation of the Incompatibility fails.
      AlreadyExistsException - if an Incompatibility for newName lready exists.
      MetadataServiceException - if metadata sub-system error.

    • deleteIncompatibility

      void deleteIncompatibility(MetadataServiceHandle handle, MetadataObjectId objectId) throws MetadataServiceException
      Deletes an Incompatibility from the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the Incompatibility to delete.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • addScheduleDefinition

      MetadataObjectId addScheduleDefinition(MetadataServiceHandle handle, Schedule schedule, String packageName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Adds a Schedule to the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      schedule - the instance of the Schedule to persist.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      Returns:
      the unique identifier for accessing the newly created metadata object.
      Throws:
      MetadataNotFoundException - if any ExclusionsDefinition referenced by the given Schedule does not exist.
      ValidationException - if validation of the Schedule fails.
      AlreadyExistsException - if a Schedule with the same name already exists.
      MetadataServiceException - if metadata sub-system error.

    • getScheduleDefinition

      Schedule getScheduleDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves a Schedule from the metadata repository.

      This method returns either a mutable or immutable instance of the given object as desired. When changes are required to be made, a mutable instance must always be fetched.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the Schedule to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      an instance of the Schedule for the given name.
      Throws:
      MetadataNotFoundException - if a Schedule for objectId does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getScheduleDefinitions

      Schedule[] getScheduleDefinitions(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves an array of Schedules from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the order of the returned metadata objects is the same as the order of the IDs in the objectIds parameter.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the Schedules to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      Schedules for the given object ids.
      Throws:
      MetadataNotFoundException - if a Schedule for a given metadata id does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getScheduleDefinitionsMap

      Map<MetadataObjectId,Schedule> getScheduleDefinitionsMap(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataServiceException
      Retrieves map of Schedules for MetadataObjectIds from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the returned metadata objects is mapped to corresponding IDs in the objectIds parameter. For a missing metadata, MetadataNotFoundException will not be thrown and null is set at the value part of corresponding entry in the returned map.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the Schedules to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      a Map of corresponding Schedules for the given object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • querySchedules

      Enumeration<MetadataObjectId> querySchedules(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query Schedules that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the metadata object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryScheduleObjects

      Enumeration<Schedule> queryScheduleObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query Schedules that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the Schedules matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • updateScheduleDefinition

      void updateScheduleDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, Schedule schedule) throws MetadataNotFoundException, ValidationException, MetadataServiceException
      Updates an existing Schedule definition in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the metadata object to modify.
      schedule - the modified Schedule to persist.
      Throws:
      MetadataNotFoundException - if a Schedule for objectId does not exist.
      ValidationException - if validation of the given Schedule fails.
      MetadataServiceException - if metadata sub-system error.

    • copyScheduleDefinition

      MetadataObjectId copyScheduleDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, String packageName, String newName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Copies a Schedule to create another with the given name. The newly created Schedule is automatically persisted in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the Schedule to be copied.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      newName - the name to be assigned to the new Schedule.
      Returns:
      the unique identifier for the newly created (copied) Schedule.
      Throws:
      MetadataNotFoundException - if a Schedule for objectId does not exist.
      ValidationException - if validation of the Schedule fails.
      AlreadyExistsException - if a Schedule for newName already exists.
      MetadataServiceException - if metadata sub-system error.

    • deleteScheduleDefinition

      void deleteScheduleDefinition(MetadataServiceHandle handle, MetadataObjectId objectId) throws MetadataServiceException
      Deletes a Schedule from the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the Schedule to delete.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • addExclusionDefinition

      MetadataObjectId addExclusionDefinition(MetadataServiceHandle handle, ExclusionsDefinition exclusion, String packageName) throws ValidationException, AlreadyExistsException, MetadataServiceException
      Adds a ExclusionsDefinition to the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      exclusion - the instance of the ExclusionsDefinition to persist.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      Returns:
      the unique identifier for accessing the newly created metadata object.
      Throws:
      ValidationException - if validation of the ExclusionsDefinition fails.
      AlreadyExistsException - if an ExclusionsDefinition with the same name already exists.
      MetadataServiceException - if metadata sub-system error.

    • getExclusionDefinition

      ExclusionsDefinition getExclusionDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieves a ExclusionsDefinition from the metadata repository.

      This method returns either a mutable or immutable instance of the given object as desired. When changes are required to be made, a mutable instance must always be fetched.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the ExclusionsDefinition to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      an instance of the ExclusionsDefinition for the given name.
      Throws:
      MetadataNotFoundException - if a ExclusionsDefinition for for objectId does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getExclusionDefinitions

      ExclusionsDefinition[] getExclusionDefinitions(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataNotFoundException, MetadataServiceException
      Retrieve an array of ExclusionsDefinition from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the order of the returned metadata objects is the same as the order of the IDs in the objectIds parameter.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the ExclusionsDefinition to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      ExclusionsDefinitions for the given object ids.
      Throws:
      MetadataNotFoundException - if a ExclusionsDefinition for a given metadata id does not exist.
      MetadataServiceException - if metadata sub-system error.

    • getExclusionDefinitionsMap

      Map<MetadataObjectId,ExclusionsDefinition> getExclusionDefinitionsMap(MetadataServiceHandle handle, MetadataObjectId[] objectIds, boolean forUpdate) throws MetadataServiceException
      Retrieves a Map of ExclusionsDefinition for MetadataObjectIds from the metadata repository.

      This method returns either mutable or immutable instances of the given metadata ids as desired. When changes are required to be made, a mutable instance must always be fetched. It is to be noted that the returned metadata objects is mapped to corresponding IDs in the objectIds parameter. For a missing metadata, MetadataNotFoundException will not be thrown and null is set at the value part of corresponding entry in the returned map.

      Parameters:
      handle - the MetadataServiceHandle to use.
      objectIds - the unique identifiers of the ExclusionDefinitions to retrieve.
      forUpdate - indicates whether a mutable or immutable instances should be fetched. If updates will be performed on the retrieved objects, then mutable instances must be fetched by specifying a value of true. Otherwise false should be specified for read-only instances.
      Returns:
      a Map of corresponding ExclusionsDefinitions for the given object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryExclusionDefinitions

      Enumeration<MetadataObjectId> queryExclusionDefinitions(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query ExclusionsDefinitions that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the metadata object ids.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • queryExclusionDefinitionObjects

      Enumeration<ExclusionsDefinition> queryExclusionDefinitionObjects(MetadataServiceHandle handle, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws MetadataServiceException
      Query ExclusionsDefinition that exist in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      filter - specifies the fields, comparators, and values to use for the search.
      orderBy - the field name to be used to sort the query results. If null, then no specific ordering will be applied. Only supported fields must be used.
      ascending - controls whether the orderBy argument should be sorted in ascending or descending order. true for ascending, or false for descending.
      Returns:
      an enumeration of the ExclusionsDefinitions matching the query.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • updateExclusionDefinition

      void updateExclusionDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, ExclusionsDefinition exclusion) throws MetadataNotFoundException, ValidationException, MetadataServiceException
      Updates an existing ExclusionsDefinition in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the metadata object to modify.
      exclusion - the modified ExclusionDefinition to persist.
      Throws:
      MetadataNotFoundException - if an ExclusionsDefinition for objectId does not exist.
      ValidationException - if validation of the ExclusionsDefinition fails.
      MetadataServiceException - if metadata sub-system error.

    • copyExclusionDefinition

      MetadataObjectId copyExclusionDefinition(MetadataServiceHandle handle, MetadataObjectId objectId, String packageName, String newName) throws MetadataNotFoundException, ValidationException, AlreadyExistsException, MetadataServiceException
      Copies a ExclusionDefinition to create another with the given name. The newly created ExclusionDefinition is automatically persisted in the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the ExclusionsDefinition to be copied.
      packageName - the optional package (namespace) in which to create the object. It can be null, or a string in the format "/pkg1/pkg2/...", with or without leading "/". If specified, it allows further partitioning of the metadata objects.
      newName - the name to be assigned to the new ExclusionsDefinition.
      Returns:
      the unique identifier for the newly created (copied) ExclusionsDefinition.
      Throws:
      MetadataNotFoundException - if an ExclusionsDefinition for for objectId does not exist.
      ValidationException - if validation of the ExclusionsDefinition fails.
      AlreadyExistsException - thrown if a ExclusionsDefinition for newName exists.
      MetadataServiceException - if metadata sub-system error.

    • deleteExclusionDefinition

      void deleteExclusionDefinition(MetadataServiceHandle handle, MetadataObjectId objectId) throws MetadataServiceException
      Deletes a ExclusionDefinition from the metadata repository.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique identifier of the ExclusionsDefinition to delete.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • hasPermission

      boolean hasPermission(MetadataServiceHandle handle, MetadataObjectId objectId, MetadataPermission.Action... actions) throws MetadataServiceException
      Checks if the current user has permission to perform an action on a given metadata object.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - the unique metadata denitifer whose permissions are being checked.
      actions - the permission actions to check.
      Returns:
      true if the current user has permissions to perform all the actions listed on objectId, or false otherwise.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • checkDetailedPermissions

      Map<String,Map<String,Boolean>> checkDetailedPermissions(MetadataServiceHandle handle, String[] metadataPermissionStrings, MetadataPermission.Action... actions) throws MetadataServiceException
      Checks if the current user has permissions to perform actions on the set of given metadata objects.

      This method returns a Map with key as the permission string and value as another map with key as the MetadataPermission.Action and value as the boolean result of its permission check.

      Parameters:
      handle - the MetadataServiceHandle to use.
      metadataPermissionStrings - the unique permission identifiers of MetadataObjectId that are the target of the permission check.
      actions - te permission actions to check.
      Returns:
      a Map of {code Map}s if the current user has permissions to perform the actions listed on the objectIds.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • filterByPermission

      Enumeration filterByPermission(MetadataServiceHandle handle, Enumeration objectIds, MetadataPermission.Action... actions) throws MetadataServiceException
      Filters or reduces a list of unique idenifiers to only the ones for which the current user has to perform the given action.

      In other words, each identitfier in the objectIds list is checked as in hasPermission. Only the items which do have permission for the listed actions will appear returned list.

      Parameters:
      handle - the MetadataServiceHandle to se.
      objectIds - a enumeration of unique identifiers (MetadataObjectIds) to be filtered.
      actions - the permission action to check.
      Returns:
      an enumeration of unque identifiers for which the current user has permission.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • getCustomMDSNamespace

      String[] getCustomMDSNamespace(MetadataServiceHandle handle) throws MetadataServiceException
      Gets the MDS namespaces that are known to ESS in which metadata can be customized or updated in a runtime environment.
      Parameters:
      handle - the MetadataServiceHandle to use.
      Returns:
      an array of customizable MDS namespaces.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • getCustomMDSNamespace

      String[] getCustomMDSNamespace(MetadataServiceHandle handle, String domainName) throws MetadataServiceException
      Gets the MDS namespaces that are known to ESS in which metadata can be customized or updated in a runtime environment.
      Parameters:
      handle - the MetadataServiceHandle to use.
      domainName - domain name. This parameter is currently ignored.
      Returns:
      an array of customizable MDS namespaces.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • isInCustomMDSNamespace

      boolean isInCustomMDSNamespace(MetadataServiceHandle handle, MetadataObjectId objectId) throws MetadataServiceException
      Checks whether the namespace of the objectId matches with the custom MDS namespace.
      Parameters:
      handle - the MetadataServiceHandle to use.
      objectId - unique identifier of the Ess metadata.
      Returns:
      true if the objectId namespace is a custom MDS namespace, or false otherwise.
      Throws:
      MetadataServiceException - if metadata sub-system error.

    • isInCustomMDSNamespace

      boolean isInCustomMDSNamespace(MetadataServiceHandle handle, String packageName) throws MetadataServiceException
      Checks whether the specified package name matches with the custom MDS namespace.
      Parameters:
      handle - the MetadataServiceHandle to use.
      packageName - package name of the Ess Metadata.
      Returns:
      true if packageName matches a custom MDS namespace, or false otherwise.
      Throws:
      MetadataServiceException - if metadata sub-system error.