public interface WFMCalendarService761Soap
extends java.rmi.Remote
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeNotification(int siteID,
int itemType,
long timestamp)
Acknowledges to the server that notification was received and processed.
|
java.lang.String |
asyncDeleteSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Request to delete existing Calendar items.
|
java.lang.String |
asyncEditSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items,
boolean ignoreLimits)
Request to update Calendar items.
|
java.lang.String |
asyncGetTimeOffLimits(int siteID,
int target,
int targetID,
int[] types,
double start,
double end,
int granularity)
Requests retrieval of Time Off limit values for specified target and date range.
|
CalLimitInformation[] |
asyncGetTimeOffLimitsRequestInformation(java.lang.String asyncRequestID)
Gets result of previous Time Off limit request.
|
java.lang.String |
asyncInsertSnapshotCalendarItem(java.lang.String snapshotID,
int accessLevel,
CfgAgentFilter agentFilter,
double[] dates,
CalItemShortInformation newItem,
boolean ignoreLimits)
Request insert of the same Calendar item for specified agents and dates to Calendar snapshot.
|
java.lang.String |
asyncInsertSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items,
boolean ignoreLimits)
Request insert of the same Calendar item for specified agents and dates to Calendar snapshot.
|
java.lang.String |
asyncSetTimeOffLimits(CalLimitInformation[] information)
Requests update of Time Off limits.
|
CalDateTimeOffBalanceInformation[] |
calculateTimeOffBalanceToDate(int accessLevel,
int siteID,
int[] teams,
int[] agents,
double date,
int[] timeOffTypes)
Calculates Time Off balance hours for the selected target for given date.
|
CalDateTimeOffBalanceInformation[] |
calculateTimeOffCarryOverInformation(int accessLevel,
int siteID,
int[] teams,
int[] agents,
double date,
int[] timeOffs)
Calculates Time Off carry-over date and carry-over hours for the specified target for given date (current date).
|
void |
deleteAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
int[] patternIds)
Deletes specified Agent Availability Patterns.
|
CalValidationHolder |
deleteCalendarItems(int accessLevel,
int siteID,
CalItemShortInformation[] items)
Deletes existing calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
deleteSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Delete specified Calendar items from snapshot.
|
CalValidationHolder |
editCalendarItems(int accessLevel,
int siteID,
CalItemShortInformation[] items,
boolean ignoreLimits)
Edits existing Calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
editSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items,
boolean ignoreLimits)
Updates specified Calendar items in snapshot.
|
int |
findAgentInSnapshot(java.lang.String snapshotID,
int field,
java.lang.String value,
int startIndex)
Find first index of matching agent in Calendar snapshot.
|
void |
generateAgentAvailabilityItems(int accessLevel,
int siteId,
int agentId,
int patternId,
double start,
int numberOfDays,
int status)
Generates Availability items from specified pattern starting from requested date.
|
CalAgentPatterns[] |
getAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId)
Gets Availability Patterns configured for specified Agent.
|
AgentTimeOffIndicators[] |
getAgentTimeOffIndicators(CfgAgentFilter agentFilter,
double[] dates)
Returns Agent Time Off indicators/openings for requested dates.
|
CalDateShift[] |
getAllShiftByAgentAndDateEx(int siteID,
int[] teamIDArray,
int[] agentIDArray,
double[] dateArray,
int sortMode,
boolean sortAscending)
Returns all configured shifts for specified agents.
|
CalData |
getAsyncCalendarItemsData(java.lang.String asyncRequestID,
CfgAgentDetails agentDetails)
Gets result of previous asynchronous request for Calendar data.
|
CalUpdatedSnapshot |
getAsyncCalendarSnapshotUpdate(java.lang.String asyncRequestID)
Gets result of previous asynchronous request for Calendar snapshot update.
|
CalData |
getCalendarItemsFromSnapshot(java.lang.String snapshotID,
int startItem,
int endItem,
int request,
CfgAgentDetails agentDetails)
Retrieve Calendar items from snapshot from index startItem to index endItem.
|
CalSnapshot |
getCalendarSnapshotResult(java.lang.String requestID)
Gets result of previous asynchronous request for Calendar snapshot.
|
ShiftHolder |
getShiftByAgentAndDateEx(int siteID,
int[] teamIDArray,
int[] agentIDArray,
double[] dateArray,
int sortMode,
boolean sortAscending)
Returns only shifts available for all specified agents.
|
CalTimeOffConfiguration[] |
getTimeOffConfiguration(int accessLevel,
int siteID,
int[] teams,
int[] agents,
int[] timeOffIDs)
Returns Time Off rule configuration for specified Time Off types and agents.
|
CalTimeOffInformation[] |
getTimeOffInformation(int accessLevel,
int siteID,
int[] teams,
int[] agents,
double date,
int[] timeOffTypes)
Calculates and returns values of Agent Time Off balance information.
|
CalValidationHolder |
insertCalendarItems(int accessLevel,
int siteID,
CalItemShortInformation[] items,
boolean ignoreLimits)
Inserts new Calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
insertSnapshotCalendarItem(java.lang.String snapshotID,
int accessLevel,
CfgAgentFilter agentFilter,
double[] dates,
CalItemShortInformation newItem,
boolean ignoreLimits)
Insert the same Calendar item for specified agents and dates to Calendar snapshot.
|
CalUpdatedSnapshot |
insertSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items,
boolean ignoreLimits)
Insert new Calendar items for specified agents and dates to Calendar snapshot.
|
CalSnapshot |
openCalendarSnapshotForDates(int accessLevel,
CfgAgentFilter agentFilter,
CfgAgentDetails agentDetails,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort)
Opens sorted and filtered snapshot of Calendar items for the specified agents and dates
|
java.lang.String |
openCalendarSnapshotForDatesAsync(int accessLevel,
CfgAgentFilter agentFilter,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort)
Request to open sorted and filtered snapshot of Calendar items for the specified agents and dates
|
CalNotification |
pollNotification(long timestamp,
int siteID,
int itemType,
int[] teamIDArray,
int[] agentIDArray,
double calStartDate,
double calEndDate,
int detailsLevel,
boolean provideAgentInfo)
Polls calendar data change notifications
|
CalData |
queryCalendarItemsForDates(int accessLevel,
CfgAgentFilter agentFilter,
CfgAgentDetails agentDetails,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort,
int request)
Returns sorted and filtered array of Calendar items for the specified agents and dates.
|
java.lang.String |
queryCalendarItemsForDatesAsync(int accessLevel,
CfgAgentFilter agentFilter,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort,
int request)
Requests sorted and filtered array of Calendar items for the specified agents and dates.
|
void |
setAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
CalAgentPatterns[] patterns)
Modifies (creates new, updates existing) Agent Availability Patterns.
|
void |
updateCalendarSnapshot(java.lang.String snapshotID,
CalSort sort)
Updates existing Calendar snapshot (used to change sort order)
|
ShiftHolder getShiftByAgentAndDateEx(int siteID, int[] teamIDArray, int[] agentIDArray, double[] dateArray, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID
- Site IDteamIDArray
- Team ID arrayagentIDArray
- Agent ID arraydateArray
- Requested datessortMode
- Sort criteriasortAscending
- Ascending/Descendingjava.rmi.RemoteException
CalDateShift[] getAllShiftByAgentAndDateEx(int siteID, int[] teamIDArray, int[] agentIDArray, double[] dateArray, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID
- Site IDteamIDArray
- Team ID arrayagentIDArray
- Agent ID arraydateArray
- Requested datessortMode
- Sort criteriasortAscending
- Ascending/Descendingjava.rmi.RemoteException
java.lang.String queryCalendarItemsForDatesAsync(int accessLevel, CfgAgentFilter agentFilter, double[] dates, int schScenarioID, CalFilter filter, CalSort sort, int request) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
dates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersrequest
- Request flag to indicate required information.java.rmi.RemoteException
ECalAccessLevels
CalSnapshot getCalendarSnapshotResult(java.lang.String requestID) throws java.rmi.RemoteException
requestID
- Async request IDjava.rmi.RemoteException
CalData getAsyncCalendarItemsData(java.lang.String asyncRequestID, CfgAgentDetails agentDetails) throws java.rmi.RemoteException
asyncRequestID
- Async request IDagentDetails
- Configuration information detail level CfgAgentDetails
java.rmi.RemoteException
CalUpdatedSnapshot getAsyncCalendarSnapshotUpdate(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Async request IDjava.rmi.RemoteException
java.lang.String asyncInsertSnapshotCalendarItem(java.lang.String snapshotID, int accessLevel, CfgAgentFilter agentFilter, double[] dates, CalItemShortInformation newItem, boolean ignoreLimits) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisoragentFilter
- Agent Filter CfgAgentFilter
dates
- Requested datesnewItem
- New Calendar item (agent and date information ignored and taken from agents and dates parameters)ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalUpdatedSnapshot insertSnapshotCalendarItem(java.lang.String snapshotID, int accessLevel, CfgAgentFilter agentFilter, double[] dates, CalItemShortInformation newItem, boolean ignoreLimits) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisoragentFilter
- Agent Filter CfgAgentFilter
dates
- Requested datesnewItem
- New Calendar item (agent and date information ignored and taken from agents and dates parameters)ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalValidationHolder insertCalendarItems(int accessLevel, int siteID, CalItemShortInformation[] items, boolean ignoreLimits) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDitems
- Array of item information. Agent and date information is provided here.ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
java.lang.String asyncInsertSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items, boolean ignoreLimits) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here.ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalUpdatedSnapshot insertSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items, boolean ignoreLimits) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here.ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalValidationHolder editCalendarItems(int accessLevel, int siteID, CalItemShortInformation[] items, boolean ignoreLimits) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time Off items, you need to set the itemID.ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
java.lang.String asyncEditSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items, boolean ignoreLimits) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time Off items, you need to set the itemID.ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
CalUpdatedSnapshot editSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items, boolean ignoreLimits) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time Off items, you need to set the itemID.ignoreLimits
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
CalValidationHolder deleteCalendarItems(int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time Off items, you need to set the itemID.java.rmi.RemoteException
ECalAccessLevels
java.lang.String asyncDeleteSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time Off items, you need to set the itemID.java.rmi.RemoteException
CalUpdatedSnapshot deleteSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time Off items, you need to set the itemID.java.rmi.RemoteException
CalData queryCalendarItemsForDates(int accessLevel, CfgAgentFilter agentFilter, CfgAgentDetails agentDetails, double[] dates, int schScenarioID, CalFilter filter, CalSort sort, int request) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
agentDetails
- Configuration information detail level CfgAgentDetails
dates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersrequest
- Request flag to indicate required information.java.rmi.RemoteException
ECalAccessLevels
CalSnapshot openCalendarSnapshotForDates(int accessLevel, CfgAgentFilter agentFilter, CfgAgentDetails agentDetails, double[] dates, int schScenarioID, CalFilter filter, CalSort sort) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
agentDetails
- Configuration information detail level CfgAgentDetails
dates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersjava.rmi.RemoteException
ECalAccessLevels
java.lang.String openCalendarSnapshotForDatesAsync(int accessLevel, CfgAgentFilter agentFilter, double[] dates, int schScenarioID, CalFilter filter, CalSort sort) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
dates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersjava.rmi.RemoteException
ECalAccessLevels
void updateCalendarSnapshot(java.lang.String snapshotID, CalSort sort) throws java.rmi.RemoteException
snapshotID
- Snapshot IDsort
- Sort criteriajava.rmi.RemoteException
int findAgentInSnapshot(java.lang.String snapshotID, int field, java.lang.String value, int startIndex) throws java.rmi.RemoteException
snapshotID
- Snapshot IDfield
- Agent properties indicator (ECfgAgentField)value
- Property valuestartIndex
- Search start indexjava.rmi.RemoteException
ECfgAgentField
CalData getCalendarItemsFromSnapshot(java.lang.String snapshotID, int startItem, int endItem, int request, CfgAgentDetails agentDetails) throws java.rmi.RemoteException
snapshotID
- Snapshot IDstartItem
- Start indexendItem
- End indexrequest
- Request flag to indicate required information.agentDetails
- Configuration information detail level CfgAgentDetails
java.rmi.RemoteException
CalTimeOffConfiguration[] getTimeOffConfiguration(int accessLevel, int siteID, int[] teams, int[] agents, int[] timeOffIDs) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)timeOffIDs
- Time Off type ID(s)java.rmi.RemoteException
CalDateTimeOffBalanceInformation[] calculateTimeOffBalanceToDate(int accessLevel, int siteID, int[] teams, int[] agents, double date, int[] timeOffTypes) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)date
- Requested datetimeOffTypes
- Time Off types array - filter, empty = all typesjava.rmi.RemoteException
ECalAccessLevels
CalTimeOffInformation[] getTimeOffInformation(int accessLevel, int siteID, int[] teams, int[] agents, double date, int[] timeOffTypes) throws java.rmi.RemoteException
accessLevel
- - User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)timeOffTypes
- Time Off types array - filter, empty = all typesjava.rmi.RemoteException
ECalAccessLevels
CalDateTimeOffBalanceInformation[] calculateTimeOffCarryOverInformation(int accessLevel, int siteID, int[] teams, int[] agents, double date, int[] timeOffs) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)timeOffs
- Time Off types array - filter, empty = all typesjava.rmi.RemoteException
ECalAccessLevels
CalAgentPatterns[] getAgentAvailabilityPatterns(int accessLevel, int siteId, int agentId) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDjava.rmi.RemoteException
void setAgentAvailabilityPatterns(int accessLevel, int siteId, int agentId, CalAgentPatterns[] patterns) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDpatterns
- New/Updated Agent Availability Paternsjava.rmi.RemoteException
void deleteAgentAvailabilityPatterns(int accessLevel, int siteId, int agentId, int[] patternIds) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDpatternIds
- Pattern ID(s)java.rmi.RemoteException
void generateAgentAvailabilityItems(int accessLevel, int siteId, int agentId, int patternId, double start, int numberOfDays, int status) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDpatternId
- Pattern IDstart
- Start DatenumberOfDays
- Number of daysstatus
- Initial generated Availability statusjava.rmi.RemoteException
java.lang.String asyncGetTimeOffLimits(int siteID, int target, int targetID, int[] types, double start, double end, int granularity) throws java.rmi.RemoteException
siteID
- Site IDtarget
- Target level (ECalLimitTarget)targetID
- Target IDtypes
- Limit types (ECalLimitType)start
- Start Dateend
- Start Dategranularity
- Daily/Timestepjava.rmi.RemoteException
ECalLimitTarget
,
ECalLimitType
java.lang.String asyncSetTimeOffLimits(CalLimitInformation[] information) throws java.rmi.RemoteException
information
- Limit informationjava.rmi.RemoteException
CalLimitInformation[] asyncGetTimeOffLimitsRequestInformation(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Async request IDjava.rmi.RemoteException
CalNotification pollNotification(long timestamp, int siteID, int itemType, int[] teamIDArray, int[] agentIDArray, double calStartDate, double calEndDate, int detailsLevel, boolean provideAgentInfo) throws java.rmi.RemoteException
timestamp
- A timestamp value to use as a baseline for notifications. A timestamp value to use as a baseline for notifications. A zero value implies current moment and negative value tells server to use last acknowledged timestamp as a baseline.siteID
- Site ID. A negative ID can be used to track changes for all sites.itemType
- A calendar item type ECalItems
to track changes for. Use CAL_ITEM_UNKNOWN type value to request notification for all item types.teamIDArray
- Team ID filter. Can be "null" meaning "any team"agentIDArray
- Agent ID filter. Can be null meaning "all agents for specified teams". If teams were not specified - means "all agents".calStartDate
- Start date of calendar data range that needs to be tracked for changes. OleDateTime
calEndDate
- End date of calendar data range that needs to be tracked for changes. OleDateTime
detailsLevel
- Notification details level ECalAuditLevel
provideAgentInfo
- Tells whether to provide short agent information about every unique agent in response.CalNotification
java.rmi.RemoteException
void acknowledgeNotification(int siteID, int itemType, long timestamp) throws java.rmi.RemoteException
pollNotification(long, int, int, int[], int[], double, double, int, boolean)
.siteID
- Site IDitemType
- An item type from CalNotification
returned by pollNotification(long, int, int, int[], int[], double, double, int, boolean)
timestamp
- A timestamp value from CalNotification
returned by pollNotification(long, int, int, int[], int[], double, double, int, boolean)
java.rmi.RemoteException
AgentTimeOffIndicators[] getAgentTimeOffIndicators(CfgAgentFilter agentFilter, double[] dates) throws java.rmi.RemoteException
agentFilter
- Agent Filter CfgAgentFilter
dates
- Date arrayjava.rmi.RemoteException
Copyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.