BlackoutService
Session Bean implementation class BlackoutWebService
Endpoint Metadata
- Namespace: http://videoscape.cisco.com/epg/webservices/blackout
- Endpoint Name: BlackoutWebService
- Endpoint Address: http(s)://{VMS URL}/LinearManager/webservices/blackout-service
The following methods are available on this endpoint:
Create and persist a new blackout. The following related data collections are linked to blackout: blackout schedules and channel maps.
Following validation is performed on blackout data:
- Start date of blackout must precede the end date of blackout.
Creation is terminated if an EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
blackout |
Blackout
|
The blackout to be created. |
Return Value
type |
description |
Blackout
|
Return persisted blackout. |
Faults
name |
description |
BlackoutWebServiceFault |
Thrown if any exception is encountered. |
Mark specified blackout and related schedules as deleted. Link relevant blackout schedules and channel maps to deleted blackout.
Delete is terminated if an EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
blackoutPk |
integer |
(no documentation provided) |
Faults
name |
description |
BlackoutWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a paged list of blackouts that contains searchTerm.
Input Parameters
name |
type |
description |
searchTerm |
string |
Text searched for in blackout's name, station's name, station's external identifier or station's call sign. If null or empty, all blackouts are returned. |
pageInfoAdapter |
PageInfoAdapter
|
Page settings for result list. Settings include start, count and sort order. If null, pagination is ignored and all records are retrieved. |
Return Value
type |
description |
list<Blackout>
|
Return list of blackouts that contain searchTerm. List is filtered and ordered based on page settings. |
Faults
name |
description |
BlackoutWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a list of blackouts for station with given stationExternalId that start on or after specified date.
Input Parameters
name |
type |
description |
stationExternalId |
string |
External identifier of station |
startDate |
date |
Minimal date for blackout schedules. |
blackoutRegion |
string |
Scope of blackout. - national Nationwide blackout coverage only
- region Regional coverage only
- null Any blackout type
|
Return Value
type |
description |
list<Blackout>
|
Return list of blackouts that match given data. |
Faults
name |
description |
BlackoutWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a list of blackouts for station with given stationPk that start on or after specified date.
Input Parameters
name |
type |
description |
stationPk |
integer |
Primary key of station. |
startDate |
date |
Minimal date for blackout schedules. |
blackoutRegion |
string |
Scope of blackout. - national Nationwide blackout coverage only
- region Regional coverage only
- null Any blackout type
|
Return Value
type |
description |
list<Blackout>
|
Return list of blackouts that match given data. |
Faults
name |
description |
BlackoutWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a blackout by its primary key.
Input Parameters
name |
type |
description |
blackoutPk |
integer |
Primary key of blackout. |
Return Value
type |
description |
Blackout
|
Return blackout mapped to specified primary key. |
Faults
name |
description |
BlackoutWebServiceFault |
Thrown if any exception is encountered. |
Update an existing blackout and related schedules. Blackout schedules are updated by creating new schedules and marking old schedules asdeleted. Link relevant blackout schedules and channel maps to updated blackout.
Following validation is performed on blackout data:
- Start date of blackout must precede the end date of blackout.
Update is terminated if an EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
blackout |
Blackout
|
The blackout to be updated. |
Return Value
type |
description |
Blackout
|
Return updated blackout. |
Faults
name |
description |
BlackoutWebServiceFault |
Thrown if any exception is encountered. |