com.cleo.lexicom.external

Interface ISyncer

public interface ISyncer

Establishes an interface to VersaLex's Synchronizer. Refer to ILexiCom.getSyncer().

Methods provided allow for querying of synchronization status

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMasterActiveVersalex(java.lang.String item) Returns the serial number of the active master VersaLex for the item
java.lang.String	getVersalexAlias(java.lang.String serialNumber) Returns the alias for the VersaLex serial number
boolean	isActiveVersalex(java.lang.String item, boolean master) Indicates whether VersaLex is active overall (Sync.HOSTS) or specifically active in processing the schedule (Sync.SCHEDULE) or routes (Sync.ROUTE)
boolean	isSynced(java.lang.String item) Indicates whether VersaLex is synced overall (Sync.HOSTS) or specifically in processing the schedule (Sync.SCHEDULE) or routes (Sync.ROUTE)

Method Detail

isSynced

boolean isSynced(java.lang.String item)
          throws java.lang.Exception

Indicates whether VersaLex is synced overall (Sync.HOSTS) or specifically in processing the schedule (Sync.SCHEDULE) or routes (Sync.ROUTE)

Parameters:

item - either Sync.HOSTS, Sync.SCHEDULE, or Sync.ROUTE

Returns:

whether synced VersaLex

Throws:

java.lang.Exception

isActiveVersalex

boolean isActiveVersalex(java.lang.String item,
                         boolean master)
                  throws java.lang.Exception

Indicates whether VersaLex is active overall (Sync.HOSTS) or specifically active in processing the schedule (Sync.SCHEDULE) or routes (Sync.ROUTE)

Parameters:

item - either Sync.HOSTS, Sync.SCHEDULE, or Sync.ROUTE

master - if true, checks if VersaLex is the master active VersaLex

Returns:

whether active (master) VersaLex

Throws:

java.lang.Exception

getMasterActiveVersalex

java.lang.String getMasterActiveVersalex(java.lang.String item)
                                  throws java.lang.Exception

Returns the serial number of the active master VersaLex for the item

Parameters:

item - either Sync.HOSTS, Sync.SCHEDULE, or Sync.ROUTE

Returns:

serial number of the active master VersaLex or null if not synced

Throws:

java.lang.Exception

getVersalexAlias

java.lang.String getVersalexAlias(java.lang.String serialNumber)
                           throws java.lang.Exception

Returns the alias for the VersaLex serial number

Parameters:

serialNumber - VersaLex serial number

Returns:

alias of the serial number or null if alias not assigned

Throws:

java.lang.Exception