|
Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.5) E20742-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataServiceMXBeanProxy
Remote management interface for the Metadata Service.
Field Summary | |
---|---|
static java.lang.String |
s_mbeanObjectNameString
|
static oracle.as.scheduler.management.ProtocolVersion |
s_protocolVersion
The local version information for this interface |
static java.lang.String |
s_shortName
|
Method Summary | |
---|---|
MetadataObjectId |
addExclusionDefinition(ExclusionsDefinition exclusion,
java.lang.String application,
java.lang.String packageName)
Creates an Exclusion definition in to the scheduler metadata repository. |
MetadataObjectId |
addIncompatibility(Incompatibility incompatibility,
java.lang.String application,
java.lang.String packageName)
Method to persist a Incompatibility definition in to the scheduler metadata repository. |
MetadataObjectId |
addJobDefinition(JobDefinition jobDefn,
java.lang.String application,
java.lang.String packageName)
Creates a JobDefinition in to the scheduler metadata repository. |
MetadataObjectId |
addJobSet(JobSet jobset,
java.lang.String application,
java.lang.String packageName)
Method to persist a JobSet definition in to the scheduler metadata repository. |
MetadataObjectId |
addJobType(JobType jobType,
java.lang.String application,
java.lang.String packageName)
Creates a JobType definition in to the scheduler metadata repository. |
MetadataObjectId |
addScheduleDefinition(Schedule schedule,
java.lang.String application,
java.lang.String packageName)
Creates a Schedule definition in to the scheduler metadata repository. |
MetadataObjectId |
addTrigger(Trigger trigger,
java.lang.String application,
java.lang.String packageName)
Creates a Trigger definition in to the scheduler metadata repository. |
MetadataObjectId |
addWorkAssignment(WorkAssignment workAssignment,
java.lang.String packageName)
Creates a WorkAssignment definition in to the scheduler metadata repository. |
MetadataObjectId |
addWorkshift(Workshift workshift,
java.lang.String packageName)
Creates a Workshift definition in to the scheduler metadata repository. |
MetadataObjectId |
copyExclusionDefinition(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName,
java.lang.String application)
Copies an ExclusionsDefinition to another with the given name. |
MetadataObjectId |
copyIncompatibility(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName,
java.lang.String application)
Copies a Incompatibility definition to another with the given name. |
MetadataObjectId |
copyJobDefinition(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName,
java.lang.String application)
Copies a JobDefinition to another with the given name. |
MetadataObjectId |
copyJobSet(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName,
java.lang.String application)
Copies a JobSet definition to another with the given name. |
MetadataObjectId |
copyJobType(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName,
java.lang.String application)
Copies a JobType definition to another with the given name. |
MetadataObjectId |
copyScheduleDefinition(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName,
java.lang.String application)
Copies a Schedule definition to another with the given name. |
MetadataObjectId |
copyTrigger(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName,
java.lang.String application)
Copies a Trigger definition to another with the given name. |
MetadataObjectId |
copyWorkAssignment(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName)
Copies a WorkAssignment definition to another with the given name. |
MetadataObjectId |
copyWorkshift(MetadataObjectId objectId,
java.lang.String packageName,
java.lang.String newName)
Copies a Workshift definition to another with the given name. |
void |
customizeJobDefinition(JobDefinition jobDefn,
MetadataService.CustomizableProperty property,
java.io.Serializable newValue,
java.lang.String application)
This method allows administrators to customize a property of a piece of metadata without changing the base metadata. |
void |
customizeJobSet(JobSet jobSet,
MetadataService.CustomizableProperty property,
java.io.Serializable newValue,
java.lang.String application)
This method allows administrators to customize a property of a piece of metadata without changing the base metadata. |
void |
deleteExclusionDefinition(MetadataObjectId objectId,
java.lang.String application)
Deletes an ExclusionsDefinition from the scheduler metadata repository. |
void |
deleteIncompatibility(MetadataObjectId objectId,
java.lang.String application)
Deletes a Incompatibility definition from the scheduler metadata repository. |
void |
deleteJobDefinition(MetadataObjectId objectId,
java.lang.String application)
Deletes a JobDefinition from the scheduler metadata repository. |
void |
deleteJobSet(MetadataObjectId objectId,
java.lang.String application)
Deletes a JobSet definition from the scheduler metadata repository. |
void |
deleteJobType(MetadataObjectId objectId,
java.lang.String application)
Deletes a JobType definition from the scheduler metadata repository. |
void |
deleteScheduleDefinition(MetadataObjectId objectId,
java.lang.String application)
Deletes a Schedule definition from the scheduler metadata repository. |
void |
deleteTrigger(MetadataObjectId objectId,
java.lang.String application)
Deletes a Trigger definition from the scheduler metadata repository. |
void |
deleteWorkAssignment(MetadataObjectId objectId)
Method delete a WorkAssignment definition from the scheduler metadata repository. |
void |
deleteWorkshift(MetadataObjectId objectId)
Deletes a Workshift definition from the scheduler metadata repository. |
java.lang.String[] |
getCustomMDSNamespace()
Method to return the namespace that is configured in ESSAPP connections.xml. |
java.lang.String[] |
getCustomMDSNamespace(java.lang.String domainName)
Method to return the namespace that is configured in ESSAPP connections.xml of this domain. |
ExclusionsDefinition |
getExclusionDefinition(MetadataObjectId objectId,
java.lang.String application)
Retrieves ExclusionsDefinition from the scheduler metadata repository. |
Incompatibility[] |
getIncompatibilities(MetadataObjectId entity,
java.lang.String application)
Method to retrieve all the Incompatibility definitions associated with a given JobDefinition or JobSet definition. |
Incompatibility |
getIncompatibility(MetadataObjectId objectId,
java.lang.String application)
Method to retrieve a Incompatibility definition from the scheduler metadata repository. |
JobDefinition |
getJobDefinition(MetadataObjectId objectId,
java.lang.String application)
Gets a JobDefinition from the scheduler metadata repository. |
JobSet |
getJobSet(MetadataObjectId objectId,
java.lang.String application)
Method to retrieve a JobSet definition from the scheduler metadata repository. |
JobSetSteps |
getJobSetSteps(MetadataObjectId objectId,
java.lang.String application)
Returns all the steps in a given JobSet. |
JobType |
getJobType(MetadataObjectId objectId,
java.lang.String application)
Gets a JobType definition from the scheduler metadata repository. |
oracle.as.scheduler.management.ProtocolVersion |
getProtocolVersion()
Returns remote version information for this interface |
Schedule |
getScheduleDefinition(MetadataObjectId objectId,
java.lang.String application)
Method to retrieve a Schedule definition from the scheduler metadata repository. |
Trigger |
getTrigger(MetadataObjectId objectId,
java.lang.String application)
Gets a Trigger definition from the scheduler metadata repository. |
WorkAssignment |
getWorkAssignment(MetadataObjectId objectId)
Gets a WorkAssignment definition from the scheduler metadata repository. |
WorkAssignment |
getWorkAssignment(java.lang.String objectId)
Returns the WorkAssignment definition identified by the given object identifier. |
Workshift |
getWorkshift(MetadataObjectId objectId)
Gets a Workshift definition from the scheduler metadata repository. |
Workshift[] |
getWorkshifts(MetadataObjectId objectId)
Returns the array of all the workshifts referenced by the WorkAssignment identified by the given object identifier. |
boolean |
isInCustomMDSNamespace(MetadataObjectId objectId)
Method to check whether the namespace of the objectId matches with the custom MDS namespace. |
boolean |
isInCustomMDSNamespace(java.lang.String packageName)
Method to check whether the specified package name matches with the custom MDS namespace. |
ExclusionsDefinition[] |
queryExclusionsDefinitions(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query ExclusionsDefinition objects in scheduler metadata repository. |
Incompatibility[] |
queryIncompatibilities(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query Incompatibility objects. |
JobDefinition[] |
queryJobDefinitions(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query JobDefinition objects. |
JobDefinition[] |
queryJobDefinitions(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending,
java.lang.String[] paramsToExclude)
Query JobDefinition objects. |
JobSet[] |
queryJobSets(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query JobSet objects. |
JobSet[] |
queryJobSets(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending,
java.lang.String[] paramsToExclude)
Query JobSet objects. |
JobType[] |
queryJobTypes(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query JobType objects in the scheduler metadata repository. |
JobType[] |
queryJobTypes(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending,
java.lang.String[] paramsToExclude)
Query JobType objects in the scheduler metadata repository. |
Schedule[] |
querySchedules(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query Schedule objects. |
Trigger[] |
queryTriggers(java.lang.String application,
Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query Trigger objects in scheduler metadata repository. |
WorkAssignment[] |
queryWorkAssignments(Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query WorkAssignment objects in scheduler metadata repository. |
Workshift[] |
queryWorkshifts(Filter filter,
MetadataService.QueryField orderBy,
boolean ascending)
Query Workshift objects in scheduler metadata repository. |
void |
setWorkAssignmentStates(MetadataObjectId[] objectIds,
boolean active)
Activates or deactivates WorkAssignments. |
void |
updateExclusionDefinition(MetadataObjectId objectId,
ExclusionsDefinition exclusion,
java.lang.String application)
Method to update a given Exclusion definition. |
void |
updateIncompatibility(MetadataObjectId objectId,
Incompatibility incompatibility,
java.lang.String application)
Updates a given Incompatibility definition. |
void |
updateJobDefinition(MetadataObjectId objectId,
JobDefinition jobDefn,
java.lang.String application)
Updates a given JobDefinition. |
void |
updateJobSet(MetadataObjectId objectId,
JobSet jobset,
java.lang.String application)
Updates a given JobSet definition. |
void |
updateJobType(MetadataObjectId objectId,
JobType jobType,
java.lang.String application)
Updates a given JobType definition. |
void |
updateScheduleDefinition(MetadataObjectId objectId,
Schedule schedule,
java.lang.String application)
Updates a given JobType definition. |
void |
updateTrigger(MetadataObjectId objectId,
Trigger trigger,
java.lang.String application)
Updates a given Trigger definition. |
void |
updateWorkAssignment(MetadataObjectId objectId,
WorkAssignment workAssignment)
Updates a given WorkAssignment definition. |
void |
updateWorkshift(MetadataObjectId objectId,
Workshift workshift)
Updates a given Workshift definition. |
Field Detail |
---|
static final oracle.as.scheduler.management.ProtocolVersion s_protocolVersion
static final java.lang.String s_shortName
static final java.lang.String s_mbeanObjectNameString
Method Detail |
---|
oracle.as.scheduler.management.ProtocolVersion getProtocolVersion() throws java.io.IOException
java.io.IOException
- if a protocol error occursvoid customizeJobDefinition(JobDefinition jobDefn, MetadataService.CustomizableProperty property, java.io.Serializable newValue, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.OperationsException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
This method allows administrators to customize a property
of 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
enumeration, otherwise an exception will be thrown.
Non customizing methods such as updateJobDefinition, updateJobType, etc, all 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.
jobDefn
- - the instance of the JobDefinition to be customized.newValue
- - the new value to use to customize the propertyapplication
- - the name of the application whose
metadata repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.
javax.management.InstanceNotFoundException
javax.management.OperationsException
void customizeJobSet(JobSet jobSet, MetadataService.CustomizableProperty property, java.io.Serializable newValue, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.OperationsException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
This method allows administrators to customize a property
of 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
enumeration, otherwise an exception will be thrown.
Non customizing methods such as updateJobDefinition, updateJobType, etc, all 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.
jobSet
- - the instance of the JobSet to be customized.newValue
- - the new value to use to customize the property
propertyapplication
- - the name of the application whose
metadata repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.
javax.management.InstanceNotFoundException
javax.management.OperationsException
MetadataObjectId addJobType(JobType jobType, java.lang.String application, java.lang.String packageName) throws java.io.IOException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
jobType
- - the instance of the JobType definition to be
persisted.application
- - the name of the application whose metadata
repository is to be used.packageName
- - the name of the package under the
application in which to create the object. Can be null. If
specified, allows partitioning of metadata in the application.
java.io.IOException
- - if a protocol error occurred.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a JobType definition with
the same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.JobType getJobType(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the JobType
definition to be retrieved.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if a JobType definition
with the given name does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.JobType[] queryJobTypes(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.JobType[] queryJobTypes(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending, java.lang.String[] paramsToExclude) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise 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.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.void updateJobType(MetadataObjectId objectId, JobType jobType, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.jobType
- - the modified JobType definition that will be
persisted.application
- - the name of the application whose metadata
repository is to be used.
javax.management.InstanceNotFoundException
- - thrown when the given
JobType definition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if given the JobType definition
is not valid.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.
java.io.IOException
MetadataObjectId copyJobType(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created JobType definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the JobType
definition to be copied.packageName
- - the name of the package under the application
in which to copy the object. Can be null. If specified, allows
partitioning of metadata in the application.newName
- - the name to be assigned to the new JobType
definition.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to
be copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a JobType definition with
the newName already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.void deleteJobType(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the JobType
definition to be deleted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.MetadataObjectId addJobDefinition(JobDefinition jobDefn, java.lang.String application, java.lang.String packageName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
jobDefn
- - the instance of the JobDefinition to be persisted.application
- - the name of the application whose metadata
repository is to be used.packageName
- - the name of the package under the
application in which to create the object. Can be null. If
specified, allows partitioning of metadata in the application.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the JobType for the given
JobDefinition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
JobDefinition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a JobDefinition with the
same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.JobDefinition getJobDefinition(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the JobDefinition to
be retrieved.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if a JobDefinition
with the given name does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.JobDefinition[] queryJobDefinitions(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.JobDefinition[] queryJobDefinitions(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending, java.lang.String[] paramsToExclude) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise 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.
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.void updateJobDefinition(MetadataObjectId objectId, JobDefinition jobDefn, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.jobDefn
- - the modified JobDefinition that will be persisted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown when the given JobDefinition
does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the given JobDefinition is
not valid.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.MetadataObjectId copyJobDefinition(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created JobDefinition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the JobDefinition to
be copied.packageName
- - the name of the package under the application
in which to copy the object. Can be null. If specified, allows
partitioning of metadata in the application.newName
- - the name to be assigned to the new
JobDefinition.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to
be copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a JobDefinition with the
newName already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.void deleteJobDefinition(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the JobDefinition to
be deleted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.MetadataObjectId addJobSet(JobSet jobset, java.lang.String application, java.lang.String packageName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
jobset
- - the instance of the JobSet definition to be
persisted.application
- - the name of the application whose metadata
repository is to be used.packageName
- - the name of the package under the
application in which to create the object. Can be null. If
specified, allows partitioning of metadata in the application.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the given
JobDefinition or the JobSet definition referenced in the
supplied JobSet definition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the JobSet
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a JobSet definition with
the same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata sub-system
encounters failures.JobSet getJobSet(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the JobSet to be retrieved.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if a JobSet definition with
the given name does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.JobSet[] queryJobSets(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.JobSet[] queryJobSets(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending, java.lang.String[] paramsToExclude) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise 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.
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.JobSetSteps getJobSetSteps(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
Only the first level steps are returned for the given JobSet. If a JobSet has nested JobSets, then this method should be called recursively with each JobSet identifier to get its step.
objectId
- - the unique identifier for the JobSet whose steps
will be returned.application
- - the name of the application whose metadata
repository is to be used.
JobSetSteps
which is a collection
of all the steps (either a JobDefinition or JobSet object).
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown when the given JobSet
definition does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void updateJobSet(MetadataObjectId objectId, JobSet jobset, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.jobset
- - the modified JobSet definition that will be
persisted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown when the given JobSet
definition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the given JobSet
definition is not valid.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId copyJobSet(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created JobSet definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the JobSet to be
copied.packageName
- - the name of the package under the application
in which to copy the object. Can be null. If specified, allows
partitioning of metadata in the application.newName
- - the name to be assigned to the new JobSet
definition.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a JobSet definition
with the newName already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void deleteJobSet(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the JobSet to be deleted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId addIncompatibility(Incompatibility incompatibility, java.lang.String application, java.lang.String packageName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
incompatibility
- - the instance of the Incompatibility
definition to be persisted.application
- - the name of the application whose metadata
repository is to be used.packageName
- - the name of the package under the
application in which to create the object. Can be null. If
specified, allows partitioning of metadata in the application.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if any JobDefinition or the
JobSet definition referenced in the incompatibility definition
does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if an Incompatibility
definition with the same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Incompatibility getIncompatibility(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Incompatibility
to be retrieved.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if Incompatibility
definition with the given name does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Incompatibility[] getIncompatibilities(MetadataObjectId entity, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
entity
- - the unique identifier of the JobDefinition or
JobSet definition for which all the incompatibilities will be
returned.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Incompatibility[] queryIncompatibilities(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void updateIncompatibility(MetadataObjectId objectId, Incompatibility incompatibility, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.incompatibility
- - the modified Incompatibility
definition that will be persisted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId copyIncompatibility(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created Incompatibility definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the Incompatibility to be
copied.packageName
- - the name of the package under the application
in which to copy the object. Can be null. If specified, allows
partitioning of metadata in the application.newName
- - the name to be assigned to the new Incompatibility
definition.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Exclusion
definition with the newName already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void deleteIncompatibility(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Incompatibility
to be deleted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId addScheduleDefinition(Schedule schedule, java.lang.String application, java.lang.String packageName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
schedule
- - the instance of the Schedule definition to be
persisted.application
- - the name of the application whose metadata
repository is to be used.packageName
- - the name of the package under the application
in which to create the object. Can be null. If specified,
allows partitioning of metadata in the application.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if any Exclusion
definition(s) referenced by the given Schedule does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Schedule
definition with the same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Schedule getScheduleDefinition(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Schedule
definition to be retrieved.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if a Schedule definition
with the given name does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Schedule[] querySchedules(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used. If null, default (ESS) repository is
used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void updateScheduleDefinition(MetadataObjectId objectId, Schedule schedule, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.schedule
- - the modified Schedule definition that will be
persisted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown when the given Schedule
definition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the given Schedule
definition is invalid.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId copyScheduleDefinition(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created Schedule definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the Schedule
definition to be copied.packageName
- - the name of the package under the application
in which to copy the object. Can be null. If specified, allows
partitioning of metadata in the application.newName
- - the name to be assigned to the new Schedule
Definition.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Schedule
definition with the newName already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void deleteScheduleDefinition(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Schedule
definition to be deleted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId addExclusionDefinition(ExclusionsDefinition exclusion, java.lang.String application, java.lang.String packageName) throws java.io.IOException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
exclusion
- - the instance of the Exclusions definition to
be persisted.application
- - the name of the application whose metadata
repository is to be used.packageName
- - the name of the package under the
application in which to create the object. Can be null. If
specified, allows partitioning of metadata in the application.
java.io.IOException
- - if a protocol error occurred.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Exclusion
definition with the same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.ExclusionsDefinition getExclusionDefinition(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the
ExclusionsDefinition to be retrieved.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if a Exclusion definition
with the given name does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.ExclusionsDefinition[] queryExclusionsDefinitions(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void updateExclusionDefinition(MetadataObjectId objectId, ExclusionsDefinition exclusion, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.exclusion
- - the modified Exclusion definition that will
be persisted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown when the given Exclusion
definition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the given Exclusion
definition is invalid.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId copyExclusionDefinition(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created Exclusion definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the
ExclusionsDefinition to be copied.packageName
- - the name of the package under the application
in which to copy the object. Can be null. If specified, allows
partitioning of metadata in the application.newName
- - the name to be assigned to the new Exclusion
definition.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Exclusion
definition with the newName already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void deleteExclusionDefinition(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the
ExclusionsDefinition to be deleted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId addTrigger(Trigger trigger, java.lang.String application, java.lang.String packageName) throws java.io.IOException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
trigger
- - the instance of the Trigger definition to be persisted.application
- - the name of the application whose metadata
repository is to be used.packageName
- - the name of the package under the
application in which to create the object. Can be null. If
specified, allows partitioning of metadata in the application.
java.io.IOException
- - if a protocol error occurred.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Trigger definition
with the same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Trigger getTrigger(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Trigger to be retrieved.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if a Trigger definition with
the given name does not exist.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Trigger[] queryTriggers(java.lang.String application, Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
application
- - the name of the application whose metadata
repository is to be used.filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void updateTrigger(MetadataObjectId objectId, Trigger trigger, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.trigger
- - the modified Trigger definition that will be
persisted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown when the given Trigger
definition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the given Trigger
definition is invalid.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId copyTrigger(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName, java.lang.String application) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created Trigger definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the Trigger to be
copied.packageName
- - the name of the package under the application
in which to copy the object. Can be null. If specified, allows
partitioning of metadata in the application.newName
- - the name to be assigned to the new Trigger
definition.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Trigger definition
with the newName already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void deleteTrigger(MetadataObjectId objectId, java.lang.String application) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Trigger to be deleted.application
- - the name of the application whose metadata
repository is to be used.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId addWorkshift(Workshift workshift, java.lang.String packageName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
workshift
- - the instance of the Workshift definition to
be persisted.packageName
- - the name of the package that allows
partitioning of metadata. It can be null.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.Workshift getWorkshift(MetadataObjectId objectId) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Workshift
definition to be retrieved.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
javax.management.RuntimeOperationsException
- - thrown if a Workshift
definition with the given name does not exist.Workshift[] queryWorkshifts(Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - if the definition is invalid.void updateWorkshift(MetadataObjectId objectId, Workshift workshift) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.workshift
- - the modified Workshift definition that will
be persisted.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId copyWorkshift(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created Workshift definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the Workshift
definition to be copied.packageName
- - the name of the package that allows
partitioning of metadata. It can be null.newName
- - the name to be assigned to the new Workshift
definition.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown if the definition to be
copied does not exist.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void deleteWorkshift(MetadataObjectId objectId) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the Workshift
definition to be deleted.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- -thrown if the metadata
sub-system encounters failures.MetadataObjectId addWorkAssignment(WorkAssignment workAssignment, java.lang.String packageName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
workAssignment
- - the instance of the WorkAssignment
definition to be persisted.packageName
- - the name of the package that allows
partitioning of metadata. It can be null.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceAlreadyExistsException
- - thrown if a Trigger definition
with the same name already exists.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.WorkAssignment getWorkAssignment(MetadataObjectId objectId) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the WorkAssignment
to be retrieved.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
javax.management.RuntimeOperationsException
- - thrown if a WorkAssignment
definition with the given name does not exist.WorkAssignment getWorkAssignment(java.lang.String objectId) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier as a String.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
javax.management.RuntimeOperationsException
- - thrown if a WorkAssignment
definition with the given name does not exist.Workshift[] getWorkshifts(MetadataObjectId objectId) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the WorkAssignment
for which the corresponding workshifts will be returned.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
javax.management.RuntimeOperationsException
- - thrown if a Workshift
definition with the given name does not exist.WorkAssignment[] queryWorkAssignments(Filter filter, MetadataService.QueryField orderBy, boolean ascending) throws java.io.IOException, javax.management.RuntimeOperationsException
filter
- criteria for which definitions are selected.orderBy
- - the field name to be used to sort the
resultSet. If null, the no specific ordering will be
applied. Only supported fields must be used.ascending
- - controls whether the orderBy argument should
be used for ascending or descending order. If true, ascending
otherwise descending.
java.io.IOException
- - if a protocol error occurred.
javax.management.RuntimeOperationsException
- - if the filter is invalid.void updateWorkAssignment(MetadataObjectId objectId, WorkAssignment workAssignment) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
objectId
- - the unique identifier of the metadata object
to be modified.workAssignment
- - the modified WorkAssignment definition
that will be persisted.
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.void setWorkAssignmentStates(MetadataObjectId[] objectIds, boolean active) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.RuntimeOperationsException
The method provides convenient way of activating or deactivating WorkAssignment definitions in bulk. The method performs the operations on multiple definitions in atomic fashion. Either all definitions will be activated/deactivated or none of them. The WorkAssignment definitions supplied must already exist in the scheduler metadata repository.
objectIds
- - tarray of unique identifiers of the metadata
objects to be activated or deactivated.active
- - flag to indicate whether to active (true) or
deactivate (false).
java.io.IOException
- - if a protocol error occurred.
javax.management.InstanceNotFoundException
- - thrown when a given
WorkAssignment definition does not exist.
javax.management.InvalidAttributeValueException
- - thrown if a
WorkAssignment definition is concurrently updated by another
user.
javax.management.RuntimeOperationsException
- - thrown if the metadata
sub-system encounters failures.MetadataObjectId copyWorkAssignment(MetadataObjectId objectId, java.lang.String packageName, java.lang.String newName) throws java.io.IOException, javax.management.InstanceNotFoundException, javax.management.InvalidAttributeValueException, javax.management.InstanceAlreadyExistsException, javax.management.RuntimeOperationsException
The newly created WorkAssignment definition is automatically persisted in the scheduler metadata repository.
objectId
- - the unique identifier of the WorkAssignment
definition to be copied.packageName
- - the name of the package in which the object
will be copied.newName
- - the name to be assigned to the new
WorkAssignment definition.
java.io.IOException
- - if a protocol error occurred.
javax.management.InvalidAttributeValueException
- - thrown if the validation of the
definition fails.
javax.management.InstanceNotFoundException
javax.management.InstanceAlreadyExistsException
javax.management.RuntimeOperationsException
void deleteWorkAssignment(MetadataObjectId objectId) throws java.io.IOException, javax.management.OperationsException, javax.management.RuntimeOperationsException
objectId
- unique identifier of the WorkAssignment
definition to be deleted.
java.io.IOException
- if a protocol error occurred.
javax.management.OperationsException
- if the work assignment
is bound and cannot be deleted.
javax.management.RuntimeOperationsException
java.lang.String[] getCustomMDSNamespace() throws java.io.IOException, javax.management.RuntimeOperationsException
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
java.lang.String[] getCustomMDSNamespace(java.lang.String domainName) throws java.io.IOException, javax.management.RuntimeOperationsException
domainName
- the name of the domain
java.io.IOException
- if a protocol error occurred.
javax.management.RuntimeOperationsException
boolean isInCustomMDSNamespace(MetadataObjectId objectId) throws java.io.IOException, javax.management.RuntimeOperationsException
objectId
- unique identifier of the Ess metadata.
java.io.IOException
javax.management.RuntimeOperationsException
boolean isInCustomMDSNamespace(java.lang.String packageName) throws java.io.IOException, javax.management.RuntimeOperationsException
packageName
- package name of the Ess Metadata
java.io.IOException
javax.management.RuntimeOperationsException
|
Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.5) E20742-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |