|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="4.1", sinceVersion="4.0") public interface IClockManager
Method Summary | |
---|---|
String |
add(SessionConfig sessionConfig,
ClockConfig clockConfig,
ITransaction transaction)
Add a clock. |
void |
addOrUpdate(SessionConfig sessionConfig,
ClockConfig clockConfig,
ITransaction transaction)
Update the configuration of a clock. |
void |
checkSchedule(SessionConfig sessionConfig,
ITransaction transaction)
This method is called at regular intervals by the PortalClock . |
void |
delete(SessionConfig sessionConfig,
String clockId,
ITransaction transaction)
Delete a clock. |
void |
disable(SessionConfig sessionConfig,
String clockId,
ITransaction transaction)
Set the "False" value to the enable property of a clock. |
void |
enable(SessionConfig sessionConfig,
String clockId,
ITransaction transaction)
Set the "True" value to the enable property of a clock. |
void |
executeSchedule(SessionConfig sessionConfig,
ClockConfig clockConfig,
ITransaction transaction)
Execute a registered clock. |
ClockConfig |
get(SessionConfig sessionConfig,
String clockId,
ITransaction transaction)
Get the configuration of the clock. |
Collection<String> |
getClockIdsByServiceId(SessionConfig sessionConfig,
String serviceId,
ITransaction transaction)
Return the Ids of all clocks registered for the specified service. |
boolean |
isPortalClockRunning(SessionConfig sessionConfig,
ITransaction transaction)
Verify if the portal clock is running. |
boolean |
setRunning(SessionConfig sessionConfig,
String clockId,
boolean running,
ITransaction transaction)
Sets the running status of a clock in the database. |
void |
update(SessionConfig sessionConfig,
ClockConfig clockConfig,
ITransaction transaction)
Update the configuration of a clock. |
Method Detail |
---|
void checkSchedule(SessionConfig sessionConfig, ITransaction transaction) throws ManagerException, PortalException
PortalClock
. The
interval period can be configured in the portal config file.
sessionConfig
- transaction
-
ManagerException
PortalException
void executeSchedule(SessionConfig sessionConfig, ClockConfig clockConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockConfig
- transaction
-
ManagerException
PortalException
ClockConfig get(SessionConfig sessionConfig, String clockId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockId
- transaction
-
ManagerException
PortalException
String add(SessionConfig sessionConfig, ClockConfig clockConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockConfig
- transaction
-
ManagerException
PortalException
void addOrUpdate(SessionConfig sessionConfig, ClockConfig clockConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockConfig
- transaction
-
ManagerException
PortalException
void update(SessionConfig sessionConfig, ClockConfig clockConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockConfig
- transaction
-
ManagerException
PortalException
void delete(SessionConfig sessionConfig, String clockId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockId
- transaction
-
ManagerException
PortalException
void enable(SessionConfig sessionConfig, String clockId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockId
- transaction
-
ManagerException
PortalException
void disable(SessionConfig sessionConfig, String clockId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockId
- transaction
-
ManagerException
PortalException
boolean setRunning(SessionConfig sessionConfig, String clockId, boolean running, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- clockId
- running
-
ManagerException
PortalException
boolean isPortalClockRunning(SessionConfig sessionConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- transaction
-
ManagerException
PortalException
Collection<String> getClockIdsByServiceId(SessionConfig sessionConfig, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceId
- The Id of the service whose clocks you want to return.transaction
-
ManagerException
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |