Package com.uc4.communication.requests
Class ServiceFulfillmentList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.ServiceFulfillmentList
-
- All Implemented Interfaces:
java.lang.Iterable<ServiceFulfillmentItem>
public class ServiceFulfillmentList extends XMLRequest implements java.lang.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, java.lang.String... selectedColumns)
Requests the service fulfillments list with a filter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
Creates the XML Document for the request.protected java.lang.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.java.util.Iterator<ServiceFulfillmentItem>
iterator()
Returns an Iterator which can be used to step through theServiceFulfillmentItem
.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
-
-
-
-
Constructor Detail
-
ServiceFulfillmentList
public ServiceFulfillmentList()
Requests the full service fulfillments list (all columns and all entries).
-
ServiceFulfillmentList
public ServiceFulfillmentList(ServiceFulfillmentList.Filter filter, java.lang.String... selectedColumns)
Requests the service fulfillments list with a filter.- Parameters:
filter
- Filter to restrict the resultselectedColumns
- Name of optional columns, possible values are:- SERVICE_NAME
- SERVICE_TYPE
- SERVICE_RUN_ID
- SERVICE_FULFILLMENT_STATUS
- VIOLATION_REASON
-
-
Method Detail
-
getSrc
protected java.lang.String getSrc()
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- Returns:
- Source
-
createRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- 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 classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
iterator
public java.util.Iterator<ServiceFulfillmentItem> iterator()
Returns an Iterator which can be used to step through theServiceFulfillmentItem
. If this class does not contain a service fulfillments list this method returnsnull
- Specified by:
iterator
in interfacejava.lang.Iterable<ServiceFulfillmentItem>
- Returns:
- Iterator containing
ServiceFulfillmentItem
ornull
in case of an error
-
size
public int size()
Returns the total number of items in the service fulfillments list.- Returns:
- number of
ServiceFulfillmentItem
-
-