uk.ac.cam.ucs.ibis.dto

Class IbisResult

java.lang.Object

uk.ac.cam.ucs.ibis.dto.IbisResult

public class IbisResult
extends Object

Class representing the top-level container for all XML and JSON results. This may be just a simple textual value or it may contain more complex entities such as people, institutions, groups, attributes, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IbisResult.Entities Nested class to hold the full details of all the entities returned in a result.

Field Summary

Fields

Modifier and Type	Field and Description
IbisAttribute	attribute The person or institution attribute returned by methods that return a single attribute.
List<IbisAttribute>	attributes The list of attributes returned by methods that return lists of person/institution attributes.
List<IbisAttributeScheme>	attributeSchemes The list of attribute schemes returned by methods that return lists of person/institution attribute schemes.
IbisResult.Entities	entities In the flattened XML/JSON representation, all the unique entities returned by the method.
IbisError	error If the method failed, details of the error.
IbisGroup	group The group returned by methods that return a single group.
List<IbisGroup>	groups The list of groups returned by methods that may return multiple groups.
IbisIdentifier	identifier The identifier returned by methods that return a single identifier.
IbisInstitution	institution The institution returned by methods that return a single institution.
List<IbisInstitution>	institutions The list of institutions returned by methods that may return multiple institutions.
List<IbisPerson>	people The list of people returned by methods that may return multiple people.
IbisPerson	person The person returned by methods that return a single person.
String	value The value returned by methods that return a simple textual value.
String	version The web service API version number.

Constructor Summary

Constructors

Constructor and Description
IbisResult() No-arg constructor required by JAXB
IbisResult(String value) More useful constructor, for purely textual results

Method Summary

Modifier and Type	Method and Description
String	toString()
IbisResult	unflatten() Unflatten this IbisResult object, resolving any internal ID refs to build a fully fledged object tree.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public String version

The web service API version number.

value

public String value

The value returned by methods that return a simple textual value.

person

public IbisPerson person

The person returned by methods that return a single person.

Note that methods that may return multiple people will always use the people field, even if only one person was returned.

institution

public IbisInstitution institution

The institution returned by methods that return a single institution.

Note that methods that may return multiple institutions will always use the institutions field, even if only one institution was returned.

group

public IbisGroup group

The group returned by methods that return a single group.

Note that methods that may return multiple groups will always use the groups field, even if only one group was returned.

identifier

public IbisIdentifier identifier

The identifier returned by methods that return a single identifier.

attribute

public IbisAttribute attribute

The person or institution attribute returned by methods that return a single attribute.

error

public IbisError error

If the method failed, details of the error.

people

public List<IbisPerson> people

The list of people returned by methods that may return multiple people. This may be empty, or contain one or more people.

institutions

public List<IbisInstitution> institutions

The list of institutions returned by methods that may return multiple institutions. This may be empty, or contain one or more institutions.

groups

public List<IbisGroup> groups

The list of groups returned by methods that may return multiple groups. This may be empty, or contain one or more groups.

attributes

public List<IbisAttribute> attributes

The list of attributes returned by methods that return lists of person/institution attributes.

attributeSchemes

public List<IbisAttributeScheme> attributeSchemes

The list of attribute schemes returned by methods that return lists of person/institution attribute schemes.

entities

public IbisResult.Entities entities

In the flattened XML/JSON representation, all the unique entities returned by the method.

NOTE: This will be null unless the "flatten" parameter is true.

Constructor Detail

IbisResult

public IbisResult()

No-arg constructor required by JAXB

IbisResult

public IbisResult(String value)

More useful constructor, for purely textual results

Method Detail

toString

public String toString()

Overrides:

toString in class Object

unflatten

public IbisResult unflatten()

Unflatten this IbisResult object, resolving any internal ID refs to build a fully fledged object tree.

This is necessary if the IbisResult was constructed from XML/JSON in its flattened representation (with the "flatten" parameter set to true).

On entry, the IbisResult object may have people, institutions or groups in it with "ref" fields referring to objects held in the "entities" lists. After unflattening, all such references will have been replaced by actual object references, giving an object tree that can be traversed normally.

Returns:

This IbisResult object, with its internals unflattened.