Package com.uc4.communication.requests

Class ServiceFulfillmentList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ServiceFulfillmentList

All Implemented Interfaces:

Iterable<ServiceFulfillmentItem>

public class ServiceFulfillmentList
extends XMLRequest
implements Iterable<ServiceFulfillmentItem>

Reads the list of service fulfillments.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceFulfillmentList.Filter	Filter in the service fulfillments list.

Constructor Summary

Constructors

Constructor	Description
ServiceFulfillmentList()	Requests the full service fulfillments list (all columns and all entries).
ServiceFulfillmentList(ServiceFulfillmentList.Filter filter, String... selectedColumns)	Requests the service fulfillments list with a filter.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
Iterator<ServiceFulfillmentItem>	iterator()	Returns an Iterator which can be used to step through the ServiceFulfillmentItem.
int	size()	Returns the total number of items in the service fulfillments list.

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, isAllowedInClientZero, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ServiceFulfillmentList

public ServiceFulfillmentList()

Requests the full service fulfillments list (all columns and all entries).

ServiceFulfillmentList

public ServiceFulfillmentList(ServiceFulfillmentList.Filter filter,
 String... selectedColumns)

Requests the service fulfillments list with a filter.

Parameters:

filter - Filter to restrict the result

selectedColumns - Name of optional columns, possible values are:

• SERVICE_NAME
• SERVICE_TYPE
• SERVICE_RUN_ID
• SERVICE_FULFILLMENT_STATUS
• VIOLATION_REASON

If this parameter is not set all optional fields are returned. All other columns that are not in this list are always returned. This method can be used to improve the performance if only a few of these optional fields are required.

Method Details

getSrc

protected String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
 Element request,
 ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
 ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

iterator

public Iterator<ServiceFulfillmentItem> iterator()

Returns an Iterator which can be used to step through the ServiceFulfillmentItem. If this class does not contain a service fulfillments list this method returns null

Specified by:

iterator in interface Iterable<ServiceFulfillmentItem>

Returns:

Iterator containing ServiceFulfillmentItem or null in case of an error

size

public int size()

Returns the total number of items in the service fulfillments list.

Returns:

number of ServiceFulfillmentItem