public interface ScheduleAdmin
Modifier and Type | Method and Description |
---|---|
void |
activateExclusively(java.lang.String scheduleName)
Makes the specified Schedule active (regardless of its intervals, start date or ending condition), and,
makes all the other Schedules inactive (regardless of their intervals, start dates or ending conditions).
|
void |
addSchedule(ScheduleInfo schedule)
Adds the given Schedule to the Schedule repository.
|
void |
assignScheduleToAccount(java.lang.String scheduleName,
java.lang.String account)
Assign a Schedule to an account.
|
void |
cloneScheduleForAccount(java.lang.String scheduleName,
java.lang.String account)
Copy an admin-account Schedule for another account.
|
void |
cloneScheduleForCloud(java.lang.String scheduleName)
Copy a non-cloud-account Schedule for the cloud account.
|
void |
copySchedule(java.lang.String sourceScheduleName,
java.lang.String targetScheduleName)
Makes a copy of an existing Schedule with the new Schedule name specified.
|
void |
deploySchedule(java.lang.String scheduleName)
Deprecated.
replaced by
ScheduleAdmin.publishSchedule(String) |
void |
disableBatchMode()
Takes the Schedule Manager out of Batch Mode.
|
void |
enableBatchMode()
Puts the Schedule Manager into Batch Mode.
|
void |
endExclusivity()
Stops exclusivity of a Schedule which was exclusively activated previously,
meaning that it and all the other Schedules go back to being active or not based on their intervals,
start dates and ending conditions.
|
ScheduleInfo |
getSchedule(java.lang.String scheduleName)
Retrieves information on the given Schedule.
|
java.lang.String[] |
getScheduleNames()
Retrieves the list of Schedule names for all the Schedules available on the Broker.
|
ScheduleInfo[] |
getSchedules()
Retrieves information on all the Schedules available on the Broker.
|
boolean |
isScheduleDeployed(java.lang.String scheduleName)
Deprecated.
replaced by
ScheduleAdmin.isSchedulePublished(String) |
boolean |
isScheduleModified(java.lang.String scheduleName)
Reports whether the Schedule is modified compared to its published version.
|
boolean |
isSchedulePublished(java.lang.String scheduleName)
Reports whether the Schedule is published.
|
boolean |
isUtility(java.lang.String scheduleName)
Reports if the Schedule is flagged as a utility.
|
void |
publishSchedule(java.lang.String scheduleName)
Publishes the given Schedule.
|
void |
removeSchedule(java.lang.String scheduleName)
Removes the given Schedule from the Broker.
|
void |
revertSchedule(java.lang.String scheduleName)
Undoes proposed (non-published) changes to the specified Schedule.
|
void |
setUtility(java.lang.String scheduleName,
boolean newUtilityValue)
Sets the Schedule to be or not to be a utility.
|
void |
undeploySchedule(java.lang.String scheduleName)
Deprecated.
replaced by
ScheduleAdmin.unpublishSchedule(String) |
void |
unpublishSchedule(java.lang.String scheduleName)
Unpublishes the given Schedule.
|
void |
updateSchedule(ScheduleInfo schedule)
Updates and overwrites a Schedule with the information in the specified ScheduleInfo.
|
void enableBatchMode() throws java.lang.Exception
NoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- if enabling Batch Mode failsjava.lang.Exception
void disableBatchMode() throws java.lang.Exception
NoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
java.lang.String[] getScheduleNames() throws java.lang.Exception
NoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
ScheduleInfo[] getSchedules() throws java.lang.Exception
NoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
ScheduleInfo getSchedule(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void addSchedule(ScheduleInfo schedule) throws java.lang.Exception
schedule
- the Schedule to be addedNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void updateSchedule(ScheduleInfo schedule) throws java.lang.Exception
getSchedule()
or getSchedules()
. This method will not rename a Schedule; use copySchedule()
and
removeSchedule()
for this functionality. An updated Schedule needs to be re-published before the changes can
propagate to the Allocation Manager.schedule
- a previously retrieved ScheduleInfo object with desired modificationsNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
boolean isScheduleModified(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
boolean isScheduleDeployed(java.lang.String scheduleName) throws java.lang.Exception
ScheduleAdmin.isSchedulePublished(String)
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
boolean isSchedulePublished(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void deploySchedule(java.lang.String scheduleName) throws java.lang.Exception
ScheduleAdmin.publishSchedule(String)
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
publishSchedule
void publishSchedule(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void undeploySchedule(java.lang.String scheduleName) throws java.lang.Exception
ScheduleAdmin.unpublishSchedule(String)
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
unpublishSchedule
void unpublishSchedule(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void removeSchedule(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void copySchedule(java.lang.String sourceScheduleName, java.lang.String targetScheduleName) throws java.lang.Exception
sourceScheduleName
- the name of the Schedule to copytargetScheduleName
- the name of the new ScheduleNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void revertSchedule(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void activateExclusively(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the Schedule nameNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void endExclusivity() throws java.lang.Exception
NoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void assignScheduleToAccount(java.lang.String scheduleName, java.lang.String account) throws java.lang.Exception
scheduleName
- the name of the Scheduleaccount
- the name of the account that will receive the Schedulejava.lang.Exception
- if failed to perform the assignment or if user is not in admin accountvoid cloneScheduleForAccount(java.lang.String scheduleName, java.lang.String account) throws java.lang.Exception
scheduleName
- the name of the Scheduleaccount
- the name of the account that will receive the Schedulejava.lang.Exception
- if preconditions not met or copy failsvoid cloneScheduleForCloud(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the name of the Schedulejava.lang.Exception
- if preconditions not met or copy failsboolean isUtility(java.lang.String scheduleName) throws java.lang.Exception
scheduleName
- the name of the ScheduleNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
void setUtility(java.lang.String scheduleName, boolean newUtilityValue) throws java.lang.Exception
scheduleName
- the name of the SchedulenewUtilityValue
- true if the Schedule is to be flagged as a utility, false otherwiseNoServiceException
- If the Service is not availableAccessException
- If the user does not have access to the operationAdminException
- on errorjava.lang.Exception
Copyright © 2014 TIBCO Software, Inc. All Rights Reserved.