Package com.uc4.api.objects

Class SloSelection

java.lang.Object

com.uc4.api.objects.SloSelection

public class SloSelection
extends java.lang.Object

Selection criteria of SLO objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SloSelection.Beneficiary	Beneficiary of a service.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SloSelection(com.uc4.util.XMLDocument doc)

Method Summary

Modifier and Type	Method	Description
boolean	addBeneficiary(SloSelection.Beneficiary beneficiary)	Adds a Beneficiary to the object.
java.util.Iterator<SloSelection.Beneficiary>	beneficiariesIterator()	Returns an java.util.Iterator of beneficiaries.
java.lang.String	getQuery()	Returns the query definition as XML.
boolean	isQueryDefined()	Returns true if the there is a query
void	removeAllBeneficiaries()	Removes all beneficiaries.
boolean	removeBeneficiary(SloSelection.Beneficiary beneficiary)	Removes a specific Beneficiary.
void	setQuery(java.lang.String query)	Sets the query definition.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request)

Methods inherited from class java.lang.Object

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

Constructor Detail

SloSelection

protected SloSelection(com.uc4.util.XMLDocument doc)

Method Detail

getQuery

public java.lang.String getQuery()

Returns the query definition as XML.

Returns:

XML, never null

isQueryDefined

public boolean isQueryDefined()

Returns true if the there is a query

Returns:

true if a query has been defined, false if the query is empty

setQuery

public void setQuery(java.lang.String query)

Sets the query definition.

Parameters:

query - String containing a valid XML

beneficiariesIterator

public java.util.Iterator<SloSelection.Beneficiary> beneficiariesIterator()

Returns an java.util.Iterator of beneficiaries.

Returns:

Iterator

removeAllBeneficiaries

public void removeAllBeneficiaries()

Removes all beneficiaries.

removeBeneficiary

public boolean removeBeneficiary(SloSelection.Beneficiary beneficiary)

Removes a specific Beneficiary.

Parameters:

beneficiary - Beneficiary

Returns:

true if the Beneficiary was removed, false if not found

addBeneficiary

public boolean addBeneficiary(SloSelection.Beneficiary beneficiary)

Adds a Beneficiary to the object.

Parameters:

beneficiary - Beneficiary

Returns:

true when the beneficiary has been added to the list. false if the list already contained the attribute. The list remains unchanged in this case.

store

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)